| Message ID | 20200529150003.4560-1-marius@gnu.org |
|---|---|
| State | Accepted |
| Headers | show |
| Series | [bug#41601] doc: Make 'sudo -E ./pre-inst-env guix-daemon' example less prominent. | expand |
| Context | Check | Description |
|---|---|---|
| cbaines/comparison | success | View comparision |
| cbaines/git branch | success | View Git branch |
| cbaines/applying patch | success | View Laminar job |
Hello,
Marius Bakke <marius@gnu.org> writes:
> +privileges}. E.g. if you are testing changes to @command{guix-daemon}:
^^^^
Beware the dot above. You could write
E.g.@: if you…
or
E.g., if you…
instead.
Regards,
Le 29 mai 2020 11:00:03 GMT-04:00, Marius Bakke <marius@gnu.org> a écrit : >* doc/contributing.texi (Running Guix Before It Is Installed): Move >'./pre-inst-env guix-daemon' example after the mention of >GUILE_LOAD_PATH & >co, because running the daemon from the checkout frequently trips new >users. >Additionally clarify that sudo must be setuid. >--- > doc/contributing.texi | 15 ++++++++++----- > 1 file changed, 10 insertions(+), 5 deletions(-) > >diff --git a/doc/contributing.texi b/doc/contributing.texi >index 88128e5498..d9e54dd23b 100644 >--- a/doc/contributing.texi >+++ b/doc/contributing.texi >@@ -161,13 +161,8 @@ with all the dependencies available >(@pxref{Building from Git}), and then > simply prefix each command with > @command{./pre-inst-env} (the @file{pre-inst-env} script lives in the > top build tree of Guix; it is generated by @command{./configure}). >-An example@footnote{The @option{-E} flag to >-@command{sudo} guarantees that @code{GUILE_LOAD_PATH} is correctly set >-such that @command{guix-daemon} and the tools it uses can find the >Guile >-modules they need.}: > > @example >-$ sudo -E ./pre-inst-env guix-daemon --build-users-group=guixbuild > $ ./pre-inst-env guix build hello > @end example > >@@ -205,6 +200,16 @@ $1 = 361 >The @command{pre-inst-env} script sets up all the environment variables >necessary to support this, including @env{PATH} and >@env{GUILE_LOAD_PATH}. > >+When root privileges are required, use the @option{-E} argument to >+@command{sudo} to preserve the environment@footnote{Additionally, make >sure >+to use the installed @command{sudo} such as >@file{/run/setuid-programs/sudo} >+instead of the @code{sudo} package, otherwise sudo won't be able to >elevate >+privileges}. E.g. if you are testing changes to >@command{guix-daemon}: >+ >+@example >+$ sudo -E ./pre-inst-env guix-daemon --build-users-group=guixbuild >+@end example >+ >Note that @command{./pre-inst-env guix pull} does @emph{not} upgrade >the > local source tree; it simply updates the @file{~/.config/guix/current} >symlink (@pxref{Invoking guix pull}). Run @command{git pull} instead >if Looks good, but you should mention that, before running the daemon that way, the one running on the system must be stopped (herd stop guix-daemon or whatever init system is installed).
Hi Nicolas, On Fri, 29 May 2020 at 17:36, Nicolas Goaziou <mail@nicolasgoaziou.fr> wrote: > > +privileges}. E.g. if you are testing changes to @command{guix-daemon}: > ^^^^ > Beware the dot above. You could write > > E.g.@: if you… > > or > > E.g., if you… I am not native speaker but last time I have checked the rule for Latin abbreviation, if I remember well, it says: it depends. :-) In general, the style guides says always a comma before, i.e. like that. However, the comma after depends on U.S. vs U.K.: - U.S., i.e., comma after the abbreviation; - U.K., i.e. no command after the abbreviation. Cheers, simon
Hello, zimoun <zimon.toutoune@gmail.com> writes: > I am not native speaker but last time I have checked the rule for > Latin abbreviation, if I remember well, it says: it depends. :-) I was talking about Texinfo syntax, where "E.g. if" is misleading. Sorry if that was not clear. Regards,
Hello Marius, Marius Bakke <marius@gnu.org> writes: > * doc/contributing.texi (Running Guix Before It Is Installed): Move > './pre-inst-env guix-daemon' example after the mention of GUILE_LOAD_PATH & > co, because running the daemon from the checkout frequently trips new users. > Additionally clarify that sudo must be setuid. Ludovic today pushed a changed very similar in commit 9022861dc028e99fab930721fe991a682c497bbb, obsoleting this one. Closing. Thank you, Maxim
diff --git a/doc/contributing.texi b/doc/contributing.texi index 88128e5498..d9e54dd23b 100644 --- a/doc/contributing.texi +++ b/doc/contributing.texi @@ -161,13 +161,8 @@ with all the dependencies available (@pxref{Building from Git}), and then simply prefix each command with @command{./pre-inst-env} (the @file{pre-inst-env} script lives in the top build tree of Guix; it is generated by @command{./configure}). -An example@footnote{The @option{-E} flag to -@command{sudo} guarantees that @code{GUILE_LOAD_PATH} is correctly set -such that @command{guix-daemon} and the tools it uses can find the Guile -modules they need.}: @example -$ sudo -E ./pre-inst-env guix-daemon --build-users-group=guixbuild $ ./pre-inst-env guix build hello @end example @@ -205,6 +200,16 @@ $1 = 361 The @command{pre-inst-env} script sets up all the environment variables necessary to support this, including @env{PATH} and @env{GUILE_LOAD_PATH}. +When root privileges are required, use the @option{-E} argument to +@command{sudo} to preserve the environment@footnote{Additionally, make sure +to use the installed @command{sudo} such as @file{/run/setuid-programs/sudo} +instead of the @code{sudo} package, otherwise sudo won't be able to elevate +privileges}. E.g. if you are testing changes to @command{guix-daemon}: + +@example +$ sudo -E ./pre-inst-env guix-daemon --build-users-group=guixbuild +@end example + Note that @command{./pre-inst-env guix pull} does @emph{not} upgrade the local source tree; it simply updates the @file{~/.config/guix/current} symlink (@pxref{Invoking guix pull}). Run @command{git pull} instead if