doc: Add some information/recommendation regarding --sysconfdir.

* doc/contributing.texi (Building from Git): Mention sysconfdir along
localstatedir.
* doc/guix.texi (Requirements): Likewise.
This commit is contained in:
Maxim Cournoyer 2023-05-07 21:28:59 -04:00
parent d1aba42ad4
commit 26a788ae06
No known key found for this signature in database
GPG key ID: 1260E46482E63562
2 changed files with 15 additions and 6 deletions

View file

@ -135,9 +135,11 @@ Then, run:
@noindent @noindent
... where @file{/var} is the normal @code{localstatedir} value ... where @file{/var} is the normal @code{localstatedir} value
(@pxref{The Store}, for information about this). Note that you will (@pxref{The Store}, for information about this) and @file{/etc} is the
probably not run @command{make install} at the end (you don't have to) normal @code{sysconfdir} value. Note that you will probably not run
but it's still important to pass the right @code{localstatedir}. @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 Finally, you can build Guix and, if you feel so inclined, run the tests
(@pxref{Running the Test Suite}): (@pxref{Running the Test Suite}):

View file

@ -1016,14 +1016,21 @@ C++11 standard.
@end itemize @end itemize
@cindex state directory @cindex state directory
@cindex localstatedir
@cindex system configuration directory
@cindex sysconfdir
When configuring Guix on a system that already has a Guix installation, When configuring Guix on a system that already has a Guix installation,
be sure to specify the same state directory as the existing installation be sure to specify the same state directory as the existing installation
using the @option{--localstatedir} option of the @command{configure} using the @option{--localstatedir} option of the @command{configure}
script (@pxref{Directory Variables, @code{localstatedir},, standards, script (@pxref{Directory Variables, @code{localstatedir},, standards,
GNU Coding Standards}). Usually, this @var{localstatedir} option is GNU Coding Standards}). Usually, this @var{localstatedir} option is set
set to the value @file{/var}. The @command{configure} script protects to the value @file{/var}. The @command{configure} script protects
against unintended misconfiguration of @var{localstatedir} so you do not against unintended misconfiguration of @var{localstatedir} so you do not
inadvertently corrupt your store (@pxref{The Store}). inadvertently corrupt your store (@pxref{The Store}). The configuration
directory should also be configured by setting the @option{--sysconfdir}
option to the @file{/etc} value, which is the location used by Guix to
store for example the access control list of authorized machines and the
definition of offload machines.
@node Running the Test Suite @node Running the Test Suite
@section Running the Test Suite @section Running the Test Suite