[PATCH] doc: Mention config.scm in reconfigure description

  • Done
  • quality assurance status badge
Details
4 participants
  • Andreas Enge
  • Julien Lepiller
  • Ludovic Courtès
  • zimoun
Owner
unassigned
Submitted by
Julien Lepiller
Severity
normal

Debbugs page

J
J
Julien Lepiller wrote on 12 Sep 2020 12:48
(address . guix-patches@gnu.org)
20200912214852.42e4d123@tachikoma.lepiller.eu
Hi Guix,

this patch is a small change to the manual that should help at least
one confused user from
From dfa9439efbf1de7ffe281dac330a19c1e369e5d8 Mon Sep 17 00:00:00 2001
From: Julien Lepiller <julien@lepiller.eu>
Date: Sat, 12 Sep 2020 21:46:57 +0200
Subject: [PATCH] doc: Mention config.scm in reconfigure description

* doc/guix.texi (Invoking guix system): Mention `/etc/config.scm' in the
description of guix system reconfigure.
---
doc/guix.texi | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)

Toggle diff (21 lines)
diff --git a/doc/guix.texi b/doc/guix.texi
index a6e14ea177..c10387441e 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -28919,10 +28919,10 @@ As for @command{guix package --search}, the result is written in
(@pxref{Top, GNU recutils databases,, recutils, GNU recutils manual}).
@item reconfigure
-Build the operating system described in @var{file}, activate it, and
-switch to it@footnote{This action (and the related actions
-@code{switch-generation} and @code{roll-back}) are usable only on
-systems already running Guix System.}.
+Build the operating system described in @var{file} (typically
+@file{/etc/config.scm}), activate it, and switch to it@footnote{This action
+(and the related actions @code{switch-generation} and @code{roll-back}) are
+usable only on systems already running Guix System.}.
@quotation Note
@c The paragraph below refers to the problem discussed at
--
2.28.0
A
A
Andreas Enge wrote on 13 Sep 2020 05:06
(name . Julien Lepiller)(address . julien@lepiller.eu)(address . 43361@debbugs.gnu.org)
20200913120603.GB2471@jurong
Hello,

On Sat, Sep 12, 2020 at 09:48:52PM +0200, Julien Lepiller wrote:
Toggle quote (10 lines)
> @item reconfigure
> -Build the operating system described in @var{file}, activate it, and
> -switch to it@footnote{This action (and the related actions
> -@code{switch-generation} and @code{roll-back}) are usable only on
> -systems already running Guix System.}.
> +Build the operating system described in @var{file} (typically
> +@file{/etc/config.scm}), activate it, and switch to it@footnote{This action
> +(and the related actions @code{switch-generation} and @code{roll-back}) are
> +usable only on systems already running Guix System.}.

to be honest, I find it less clear than before - it now almost sounds as if
providing the file were optional, and that the command might search it
as /etc/config.scm.

Andreas
L
L
Ludovic Courtès wrote on 13 Sep 2020 14:10
(name . Julien Lepiller)(address . julien@lepiller.eu)(address . 43361@debbugs.gnu.org)
87tuw19yd5.fsf@gnu.org
Hi,

Julien Lepiller <julien@lepiller.eu> skribis:

Toggle quote (32 lines)
> this patch is a small change to the manual that should help at least
> one confused user from
> https://unix.stackexchange.com/questions/550597/what-is-the-file-to-be-specified-in-guix-system-reconfigure
>
>>From dfa9439efbf1de7ffe281dac330a19c1e369e5d8 Mon Sep 17 00:00:00 2001
> From: Julien Lepiller <julien@lepiller.eu>
> Date: Sat, 12 Sep 2020 21:46:57 +0200
> Subject: [PATCH] doc: Mention config.scm in reconfigure description
>
> * doc/guix.texi (Invoking guix system): Mention `/etc/config.scm' in the
> description of guix system reconfigure.
> ---
> doc/guix.texi | 8 ++++----
> 1 file changed, 4 insertions(+), 4 deletions(-)
>
> diff --git a/doc/guix.texi b/doc/guix.texi
> index a6e14ea177..c10387441e 100644
> --- a/doc/guix.texi
> +++ b/doc/guix.texi
> @@ -28919,10 +28919,10 @@ As for @command{guix package --search}, the result is written in
> (@pxref{Top, GNU recutils databases,, recutils, GNU recutils manual}).
>
> @item reconfigure
> -Build the operating system described in @var{file}, activate it, and
> -switch to it@footnote{This action (and the related actions
> -@code{switch-generation} and @code{roll-back}) are usable only on
> -systems already running Guix System.}.
> +Build the operating system described in @var{file} (typically
> +@file{/etc/config.scm}), activate it, and switch to it@footnote{This action
> +(and the related actions @code{switch-generation} and @code{roll-back}) are
> +usable only on systems already running Guix System.}.

Perhaps “(typically @file{/etc/config.scm})” should go next to
“@var{file} must be …”?

But if the person doesn’t read more than a few lines of the page, it
won’t help.

I was thinking we could have “guix system reconfigure” without arguments
pick up /run/current-system/configuration.scm. Perhaps that’d help?

Thanks,
Ludo’.
J
J
Julien Lepiller wrote on 13 Sep 2020 16:51
(name . Ludovic Courtès)(address . ludo@gnu.org)(address . 43361@debbugs.gnu.org)
0406FDEA-9602-4DD6-AF4B-4A259DBD82EA@lepiller.eu
Le 13 septembre 2020 17:10:30 GMT-04:00, "Ludovic Courtès" <ludo@gnu.org> a écrit :
Toggle quote (53 lines)
>Hi,
>
>Julien Lepiller <julien@lepiller.eu> skribis:
>
>> this patch is a small change to the manual that should help at least
>> one confused user from
>>
>https://unix.stackexchange.com/questions/550597/what-is-the-file-to-be-specified-in-guix-system-reconfigure
>>
>>>From dfa9439efbf1de7ffe281dac330a19c1e369e5d8 Mon Sep 17 00:00:00
>2001
>> From: Julien Lepiller <julien@lepiller.eu>
>> Date: Sat, 12 Sep 2020 21:46:57 +0200
>> Subject: [PATCH] doc: Mention config.scm in reconfigure description
>>
>> * doc/guix.texi (Invoking guix system): Mention `/etc/config.scm' in
>the
>> description of guix system reconfigure.
>> ---
>> doc/guix.texi | 8 ++++----
>> 1 file changed, 4 insertions(+), 4 deletions(-)
>>
>> diff --git a/doc/guix.texi b/doc/guix.texi
>> index a6e14ea177..c10387441e 100644
>> --- a/doc/guix.texi
>> +++ b/doc/guix.texi
>> @@ -28919,10 +28919,10 @@ As for @command{guix package --search}, the
>result is written in
>> (@pxref{Top, GNU recutils databases,, recutils, GNU recutils
>manual}).
>>
>> @item reconfigure
>> -Build the operating system described in @var{file}, activate it, and
>> -switch to it@footnote{This action (and the related actions
>> -@code{switch-generation} and @code{roll-back}) are usable only on
>> -systems already running Guix System.}.
>> +Build the operating system described in @var{file} (typically
>> +@file{/etc/config.scm}), activate it, and switch to it@footnote{This
>action
>> +(and the related actions @code{switch-generation} and
>@code{roll-back}) are
>> +usable only on systems already running Guix System.}.
>
>Perhaps “(typically @file{/etc/config.scm})” should go next to
>“@var{file} must be …”?
>
>But if the person doesn’t read more than a few lines of the page, it
>won’t help.
>
>I was thinking we could have “guix system reconfigure” without
>arguments
>pick up /run/current-system/configuration.scm. Perhaps that’d help?

I think it would be even more confusing, because that file isn't even editable. So you'de get users thinking they must re-install the distro to change that file.

Others would eventually find /etc/config.scm and not pass it as argument, then get their system reconfigured to something different than what they specified.

Maybe it should be "e.g. /etc/config, initially generated by the graphical installer" or something?

Toggle quote (3 lines)
>
>Thanks,
>Ludo’.
L
L
Ludovic Courtès wrote on 14 Sep 2020 00:25
(name . Julien Lepiller)(address . julien@lepiller.eu)(address . 43361@debbugs.gnu.org)
87tuw0q0pw.fsf@gnu.org
Hi,

Julien Lepiller <julien@lepiller.eu> skribis:

Toggle quote (56 lines)
> Le 13 septembre 2020 17:10:30 GMT-04:00, "Ludovic Courtès" <ludo@gnu.org> a écrit :
>>Hi,
>>
>>Julien Lepiller <julien@lepiller.eu> skribis:
>>
>>> this patch is a small change to the manual that should help at least
>>> one confused user from
>>>
>>https://unix.stackexchange.com/questions/550597/what-is-the-file-to-be-specified-in-guix-system-reconfigure
>>>
>>>>From dfa9439efbf1de7ffe281dac330a19c1e369e5d8 Mon Sep 17 00:00:00
>>2001
>>> From: Julien Lepiller <julien@lepiller.eu>
>>> Date: Sat, 12 Sep 2020 21:46:57 +0200
>>> Subject: [PATCH] doc: Mention config.scm in reconfigure description
>>>
>>> * doc/guix.texi (Invoking guix system): Mention `/etc/config.scm' in
>>the
>>> description of guix system reconfigure.
>>> ---
>>> doc/guix.texi | 8 ++++----
>>> 1 file changed, 4 insertions(+), 4 deletions(-)
>>>
>>> diff --git a/doc/guix.texi b/doc/guix.texi
>>> index a6e14ea177..c10387441e 100644
>>> --- a/doc/guix.texi
>>> +++ b/doc/guix.texi
>>> @@ -28919,10 +28919,10 @@ As for @command{guix package --search}, the
>>result is written in
>>> (@pxref{Top, GNU recutils databases,, recutils, GNU recutils
>>manual}).
>>>
>>> @item reconfigure
>>> -Build the operating system described in @var{file}, activate it, and
>>> -switch to it@footnote{This action (and the related actions
>>> -@code{switch-generation} and @code{roll-back}) are usable only on
>>> -systems already running Guix System.}.
>>> +Build the operating system described in @var{file} (typically
>>> +@file{/etc/config.scm}), activate it, and switch to it@footnote{This
>>action
>>> +(and the related actions @code{switch-generation} and
>>@code{roll-back}) are
>>> +usable only on systems already running Guix System.}.
>>
>>Perhaps “(typically @file{/etc/config.scm})” should go next to
>>“@var{file} must be …”?
>>
>>But if the person doesn’t read more than a few lines of the page, it
>>won’t help.
>>
>>I was thinking we could have “guix system reconfigure” without
>>arguments
>>pick up /run/current-system/configuration.scm. Perhaps that’d help?
>
> I think it would be even more confusing, because that file isn't even editable. So you'de get users thinking they must re-install the distro to change that file.

I mean you could still pass a file as an argument, but if you don’t,
it’d pick that one.

Toggle quote (4 lines)
> Others would eventually find /etc/config.scm and not pass it as argument, then get their system reconfigured to something different than what they specified.
>
> Maybe it should be "e.g. /etc/config, initially generated by the graphical installer" or something?

I think “typically /etc/config.scm” is enough (and more accurate),
dunno.

Ludo’.
Z
Z
zimoun wrote on 10 Jun 2021 04:38
(name . Julien Lepiller)(address . julien@lepiller.eu)(address . 43361@debbugs.gnu.org)
86v96mhruo.fsf@gmail.com
Hi,

On Sat, 12 Sep 2020 at 21:48, Julien Lepiller <julien@lepiller.eu> wrote:

Toggle quote (4 lines)
> this patch is a small change to the manual that should help at least
> one confused user from
> https://unix.stackexchange.com/questions/550597/what-is-the-file-to-be-specified-in-guix-system-reconfigure

What is the status of this patch?


Thanks,
simon
Z
Z
zimoun wrote on 13 Jul 2021 02:02
(name . Ludovic Courtès)(address . ludo@gnu.org)
86tukyoack.fsf@gmail.com
Hi,

This patch [1] is about a tiny tweak of the doc to add a mention of
/etc/config.scm. I do not know if the consensus is reached.


On Mon, 14 Sep 2020 at 09:25, Ludovic Courtès <ludo@gnu.org> wrote:
Toggle quote (71 lines)
> Julien Lepiller <julien@lepiller.eu> skribis:
>> Le 13 septembre 2020 17:10:30 GMT-04:00, "Ludovic Courtès" <ludo@gnu.org> a
>> écrit :
>>>Julien Lepiller <julien@lepiller.eu> skribis:
>>>
>>>> this patch is a small change to the manual that should help at least
>>>> one confused user from
>>>>
>>>https://unix.stackexchange.com/questions/550597/what-is-the-file-to-be-specified-in-guix-system-reconfigure
>>>>
>>>>>>From dfa9439efbf1de7ffe281dac330a19c1e369e5d8 Mon Sep 17 00:00:00
>>>2001
>>>> From: Julien Lepiller <julien@lepiller.eu>
>>>> Date: Sat, 12 Sep 2020 21:46:57 +0200
>>>> Subject: [PATCH] doc: Mention config.scm in reconfigure description
>>>>
>>>> * doc/guix.texi (Invoking guix system): Mention `/etc/config.scm' in
>>>the
>>>> description of guix system reconfigure.
>>>> ---
>>>> doc/guix.texi | 8 ++++----
>>>> 1 file changed, 4 insertions(+), 4 deletions(-)
>>>>
>>>> diff --git a/doc/guix.texi b/doc/guix.texi
>>>> index a6e14ea177..c10387441e 100644
>>>> --- a/doc/guix.texi
>>>> +++ b/doc/guix.texi
>>>> @@ -28919,10 +28919,10 @@ As for @command{guix package --search}, the
>>>result is written in
>>>> (@pxref{Top, GNU recutils databases,, recutils, GNU recutils
>>>manual}).
>>>>
>>>> @item reconfigure
>>>> -Build the operating system described in @var{file}, activate it, and
>>>> -switch to it@footnote{This action (and the related actions
>>>> -@code{switch-generation} and @code{roll-back}) are usable only on
>>>> -systems already running Guix System.}.
>>>> +Build the operating system described in @var{file} (typically
>>>> +@file{/etc/config.scm}), activate it, and switch to it@footnote{This
>>>action
>>>> +(and the related actions @code{switch-generation} and
>>>@code{roll-back}) are
>>>> +usable only on systems already running Guix System.}.
>>>
>>>Perhaps “(typically @file{/etc/config.scm})” should go next to
>>>“@var{file} must be …”?
>>>
>>>But if the person doesn’t read more than a few lines of the page, it
>>>won’t help.
>>>
>>>I was thinking we could have “guix system reconfigure” without
>>>arguments
>>>pick up /run/current-system/configuration.scm. Perhaps that’d help?
>>
>> I think it would be even more confusing, because that file isn't even
>> editable. So you'de get users thinking they must re-install the distro to
>> change that file.
>
> I mean you could still pass a file as an argument, but if you don’t,
> it’d pick that one.
>
>> Others would eventually find /etc/config.scm and not pass it as argument,
>> then get their system reconfigured to something different than what they
>> specified.
>>
>> Maybe it should be "e.g. /etc/config, initially generated by the graphical
>> installer" or something?
>
> I think “typically /etc/config.scm” is enough (and more accurate),
> dunno.

Personally, I find both equal. Maybe it is worth the apply the patch.
Since it is the doc, if it appears unclear from feedback, let then
improve. WDYT?

Cheers,
simon
Z
Z
zimoun wrote on 14 Sep 2021 04:20
control message for bug #43361
(address . control@debbugs.gnu.org)
86y27ztnd5.fsf@gmail.com
tags 43361 + moreinfo
quit
Z
Z
zimoun wrote on 12 Oct 2021 14:39
Re: [bug#43361] [PATCH] doc: Mention config.scm in reconfigure description
(name . Julien Lepiller)(address . julien@lepiller.eu)(address . 43361@debbugs.gnu.org)
86v921kjmu.fsf@gmail.com
Hi,

On Sat, 12 Sep 2020 at 21:48, Julien Lepiller <julien@lepiller.eu> wrote:

Toggle quote (4 lines)
> this patch is a small change to the manual that should help at least
> one confused user from
> https://unix.stackexchange.com/questions/550597/what-is-the-file-to-be-specified-in-guix-system-reconfigure

This patch#43361 [1] from one year ago does not make consensus, IIRC.
What is its current status? What could be the next actionable step? Do
we close it?

Cheers,
simon

J
J
Julien Lepiller wrote on 19 Nov 2021 06:38
doc: Mention config.scm in reconfigure description
(address . 43361-close@debbugs.gnu.org)
0DF29258-06BA-4C17-AD1E-20283F019F04@lepiller.eu
Closing since we can't come up with a consensus :)
Attachment: file
?
Your comment

This issue is archived.

To comment on this conversation send an email to 43361@patchwise.org

To respond to this issue using the mumi CLI, first switch to it
mumi current 43361
Then, you may apply the latest patchset in this issue (with sign off)
mumi am -- -s
Or, compose a reply to this issue
mumi compose
Or, send patches to this issue
mumi send-email *.patch