[bug#74093] [PATCH] doc: Explicitly mention --localstatedir and --sysconfdir configure flags.

[bug#74093] [PATCH] doc: Explicitly mention --localstatedir and --sysconfdir configure flags.

[Arun Isaac]

Prior to this commit, the terms localstatedir and sysconfdir were used without
being defined earlier. This commit clarifies that they are configure flags.

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

Change-Id: I3e6edbbc1f2a342196e732e14257dbdf9a3f4303
---
 doc/contributing.texi | 13 +++++++------
 1 file changed, 7 insertions(+), 6 deletions(-)

diff --git a/doc/contributing.texi b/doc/contributing.texi
index acdc303be6..d397410abe 100644
--- a/doc/contributing.texi
+++ b/doc/contributing.texi
@@ -240,12 +240,13 @@ Building from Git
 @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}):

base-commit: a9c33e9f688fce88aed610ab04c650efb71b4ce6
-- 
2.45.2

[bug#74093] [PATCH] doc: Explicitly mention --localstatedir and --sysconfdir configure flags.

[pelzflorian (Florian Pelz)]

Hello Arun,

Arun Isaac <arunisaac@systemreboot.net> writes:
> Prior to this commit, the terms localstatedir and sysconfdir were used without
> being defined earlier.

The word “earlier” in the commit message is misleading, since
Contributing is chapter 22 and localstatedir was mentioned in other
sections if someone were to read chapter by chapter.

But anyway, your contributing.texi’s new wording is much better!
Please push.

Regards,
Florian

[bug#74093] [PATCH] doc: Explicitly mention --localstatedir and --sysconfdir configure flags.

[Arun Isaac]

Hi Florian,

>> Prior to this commit, the terms localstatedir and sysconfdir were used without
>> being defined earlier.
>
> The word “earlier” in the commit message is misleading, since
> Contributing is chapter 22 and localstatedir was mentioned in other
> sections if someone were to read chapter by chapter.

Good point. How about I say "without being defined earlier in this
section"?

Regards,
Arun

[bug#74093] [PATCH] doc: Explicitly mention --localstatedir and --sysconfdir configure flags.

[pelzflorian (Florian Pelz)]

Arun Isaac <arunisaac@systemreboot.net> writes:
> Good point. How about I say "without being defined earlier in this
> section"?

Yes, that I understand.  The alternative I had thought of was removing
the word “earlier”, but that would actually be not true, because of
sections Invoking guix pack and The Store, which you reference.

Regards,
Florian