[bug#33385] doc: Modify sentence to clarify that ./pre-inst-env is generated

Message ID 6294c779-ea5e-2998-b955-2eb48c5d095e@riseup.net
State New
Headers show
Series
  • [bug#33385] doc: Modify sentence to clarify that ./pre-inst-env is generated
Related show

Checks

Context Check Description
cbaines/applying patch success Successfully applied

Commit Message

swedebugia Nov. 14, 2018, 7:09 p.m. UTC

Comments

Ludovic Courtès Nov. 16, 2018, 10:17 p.m. UTC | #1
Hello,

swedebugia <swedebugia@riseup.net> skribis:

>>From ce93cbc8ce4c3cba59cf70c8d073af0a796935ec Mon Sep 17 00:00:00 2001
> From: swedebugia <swedebugia@riseup.net>
> Date: Wed, 14 Nov 2018 20:03:57 +0100
> Subject: [PATCH] doc: Modify sentence to clarify that ./pre-inst-env is
>  generated
>
> * doc/contributing.texi (Running Guix Before It Is Installed): Modify

I committed a variant of this, thank you!

In the future, please don’t “fill” paragraphs as it makes it harder to
see in the diff what part of the text has changed.

Ludo’.

Patch

From ce93cbc8ce4c3cba59cf70c8d073af0a796935ec Mon Sep 17 00:00:00 2001
From: swedebugia <swedebugia@riseup.net>
Date: Wed, 14 Nov 2018 20:03:57 +0100
Subject: [PATCH] doc: Modify sentence to clarify that ./pre-inst-env is
 generated

* doc/contributing.texi (Running Guix Before It Is Installed): Modify
---
 doc/contributing.texi | 19 ++++++++++---------
 1 file changed, 10 insertions(+), 9 deletions(-)

diff --git a/doc/contributing.texi b/doc/contributing.texi
index 91a87ef2d..6d66d7eed 100644
--- a/doc/contributing.texi
+++ b/doc/contributing.texi
@@ -107,15 +107,16 @@  test the changes made in your local source tree checkout without
 actually installing them.  So that you can distinguish between your
 ``end-user'' hat and your ``motley'' costume.
 
-To that end, all the command-line tools can be used even if you have not
-run @code{make install}.  To do that, you first need to have an environment
-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), as in@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.}:
+@cindex pre-inst-env
+To that end, all the command-line tools can be used even if you have not run
+@code{make install}.  To do that, you first need to have an environment 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 is generated during the bootstrapping and configuring of Guix and is
+located in the top build tree of Guix), as in@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
-- 
2.18.0