diff mbox series

[bug#38091] doc: Mention value /var to localstatedir option.

Message ID 20191106183554.3590-1-zimon.toutoune@gmail.com
State Accepted
Headers show
Series [bug#38091] doc: Mention value /var to localstatedir option. | expand

Commit Message

Simon Tournier Nov. 6, 2019, 6:35 p.m. UTC 
* README (Installing Guix from Guix): Mention value /var to localstatedir option.
* doc/contributing.texi (Building from Git): Likewise.
* doc/guix.texi (Requirements): Likewise.
---
 README                | 3 ++-
 doc/contributing.texi | 3 ++-
 doc/guix.texi         | 5 +++--
 3 files changed, 7 insertions(+), 4 deletions(-)

Comments

Ludovic Courtès Nov. 9, 2019, 9:37 p.m. UTC | #1 
Hello!

zimoun <zimon.toutoune@gmail.com> skribis:

> * README (Installing Guix from Guix): Mention value /var to localstatedir option.
> * doc/contributing.texi (Building from Git): Likewise.
> * doc/guix.texi (Requirements): Likewise.

Applied, thanks!

Ludo’.
diff mbox series

Patch

diff --git a/README b/README
index 02d6f7190a..7121358157 100644
--- a/README
+++ b/README
@@ -63,7 +63,8 @@  To do so:
   - Re-run the 'configure' script passing it the option
     '--localstatedir=/somewhere', where '/somewhere' is the 'localstatedir'
     value of the currently installed Guix (failing to do that would lead the
-    new Guix to consider the store to be empty!).
+    new Guix to consider the store to be empty!).  We recommend to use the
+    value '/var'.
 
   - Run "make", "make check", and "make install".
 
diff --git a/doc/contributing.texi b/doc/contributing.texi
index 655c8283e5..ee72b2f94d 100644
--- a/doc/contributing.texi
+++ b/doc/contributing.texi
@@ -94,7 +94,8 @@  more information.
 Then, run @command{./configure} as usual.  Make sure to pass
 @code{--localstatedir=@var{directory}} where @var{directory} is the
 @code{localstatedir} value used by your current installation (@pxref{The
-Store}, for information about this).
+Store}, for information about this).  We recommend to use the value
+@code{/var}.
 
 Finally, you have to invoke @code{make check} to run tests
 (@pxref{Running the Test Suite}).  If anything
diff --git a/doc/guix.texi b/doc/guix.texi
index 3a9d206b9f..50a2c1506f 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -792,8 +792,9 @@  When configuring Guix on a system that already has a Guix installation,
 be sure to specify the same state directory as the existing installation
 using the @code{--localstatedir} option of the @command{configure}
 script (@pxref{Directory Variables, @code{localstatedir},, standards,
-GNU Coding Standards}).  The @command{configure} script protects against
-unintended misconfiguration of @var{localstatedir} so you do not
+GNU Coding Standards}).  Usually, this @var{localstatedir} option is
+set to the value @file{/var}.  The @command{configure} script protects
+against unintended misconfiguration of @var{localstatedir} so you do not
 inadvertently corrupt your store (@pxref{The Store}).
 
 @node Running the Test Suite