summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorArun Isaac <arunisaac@systemreboot.net>2024-10-29 18:39:55 +0000
committerArun Isaac <arunisaac@systemreboot.net>2024-11-05 22:46:20 +0000
commit2fa6f985a3549189cdeeb6d5ad9b069510bbf957 (patch)
tree646775b884c1abdb1edefa87f34ed3383bd7051b /doc
parent78ffa637313f61a4fec06e5f1e41595f0e79b9eb (diff)
downloadguix-2fa6f985a3549189cdeeb6d5ad9b069510bbf957.tar.gz
doc: Explicitly mention --localstatedir and --sysconfdir configure flags.
Prior to this commit, the terms localstatedir and sysconfdir were used without
being defined earlier in this section. This commit clarifies that they are
configure flags.

* doc/contributing.texi (Building from Git): Explicitly mention
--localstatedir and --sysconfdir configure flags.

Change-Id: I3e6edbbc1f2a342196e732e14257dbdf9a3f4303
Diffstat (limited to 'doc')
-rw-r--r--doc/contributing.texi13
1 files changed, 7 insertions, 6 deletions
diff --git a/doc/contributing.texi b/doc/contributing.texi
index 11d020fe84..8b9aa82bc8 100644
--- a/doc/contributing.texi
+++ b/doc/contributing.texi
@@ -242,12 +242,13 @@ Then, run:
 @end example
 
 @noindent
-... where @file{/var} is the normal @code{localstatedir} value
-(@pxref{The Store}, for information about this) and @file{/etc} is the
-normal @code{sysconfdir} value.  Note that you will probably not run
-@command{make install} at the end (you don't have to) but it's still
-important to pass the right @code{localstatedir} and @code{sysconfdir}
-values, which get recorded in the @code{(guix config)} Guile module.
+Optionally, @code{--localstatedir} and @code{--sysconfdir} can also be
+provided as arguments.  By default, @code{localstatedir} is @file{/var}
+(@pxref{The Store}, for information about this) and @code{sysconfdir} is
+@file{/etc}.  Note that you will probably not run @command{make install}
+at the end (you don't have to) but it's still important to pass the
+right @code{localstatedir} and @code{sysconfdir} values, which get
+recorded in the @code{(guix config)} Guile module.
 
 Finally, you can build Guix and, if you feel so inclined, run the tests
 (@pxref{Running the Test Suite}):