[PATCH 0/2] Update Requirements section.

  • Done
  • quality assurance status badge
Details
One participant
  • Florian Pelz
Owner
unassigned
Submitted by
Florian Pelz
Severity
normal
F
F
Florian Pelz wrote on 11 Apr 09:20 +0200
(address . guix-patches@gnu.org)(name . Florian Pelz)(address . pelzflorian@pelzflorian.de)
20240411072114.16195-1-pelzflorian@pelzflorian.de
Florian Pelz (2):
doc: contributing: Suggest building from Git.
doc: contributing: Move localstatedir instructions.

doc/contributing.texi | 42 +++++++++++++++++++++++++-----------------
1 file changed, 25 insertions(+), 17 deletions(-)


base-commit: c1c9d6b3cdf5955f1bf5fded2a0c496ce2e631f1
--
2.41.0
F
F
Florian Pelz wrote on 11 Apr 09:34 +0200
[PATCH 1/2] doc: contributing: Suggest building from Git.
(address . 70333@debbugs.gnu.org)(name . Florian Pelz)(address . pelzflorian@pelzflorian.de)
20240411073450.17958-1-pelzflorian@pelzflorian.de
* doc/contributing.texi (Requirements): Explain the purpose of
this section. Refer regular contributors to Building from Git.

Change-Id: I731af4ac8e78b053b96a3b683528964223ab740b
---
doc/contributing.texi | 8 ++++++++
1 file changed, 8 insertions(+)

Toggle diff (21 lines)
diff --git a/doc/contributing.texi b/doc/contributing.texi
index ad0f5a8ecd..cfe8b1289b 100644
--- a/doc/contributing.texi
+++ b/doc/contributing.texi
@@ -41,6 +41,14 @@ choice.
@node Requirements
@section Requirements
+You can easily hack on Guix itself using Guix and Git, which we use for
+version control (@pxref{Building from Git}).
+
+But when packaging Guix for foreign distros or when bootstrapping on
+systems without Guix, and if you decide to not just trust and install
+our readily made binary (@pxref{Binary Installation}), you can download
+a release version of our reproducible source tarball and read on.
+
This section lists requirements when building Guix from source. The
build procedure for Guix is the same as for other GNU software, and is
not covered here. Please see the files @file{README} and @file{INSTALL}
--
2.41.0
F
F
Florian Pelz wrote on 11 Apr 09:34 +0200
[PATCH 2/2] doc: contributing: Move localstatedir instructions.
(address . 70333@debbugs.gnu.org)(name . Florian Pelz)(address . pelzflorian@pelzflorian.de)
20240411073450.17958-2-pelzflorian@pelzflorian.de
* doc/contributing.texi (Requirements): Move localstatedir ...
(Building from Git): ... here.

Change-Id: I860bb7a9e6aea12881469c667496364248293c31
---
doc/contributing.texi | 34 +++++++++++++++++-----------------
1 file changed, 17 insertions(+), 17 deletions(-)

Toggle diff (61 lines)
diff --git a/doc/contributing.texi b/doc/contributing.texi
index cfe8b1289b..66f4e86d0a 100644
--- a/doc/contributing.texi
+++ b/doc/contributing.texi
@@ -126,23 +126,6 @@ following packages are also needed:
C++11 standard.
@end itemize
-@cindex state directory
-@cindex localstatedir
-@cindex system configuration directory
-@cindex sysconfdir
-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 @option{--localstatedir} option of the @command{configure}
-script (@pxref{Directory Variables, @code{localstatedir},, standards,
-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}). 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 Building from Git
@section Building from Git
@@ -245,6 +228,10 @@ export ACLOCAL_PATH=/usr/share/aclocal
@xref{Macro Search Path,,, automake, The GNU Automake Manual}, for
more information.
+@cindex state directory
+@cindex localstatedir
+@cindex system configuration directory
+@cindex sysconfdir
Then, run:
@example
@@ -259,6 +246,19 @@ normal @code{sysconfdir} value. Note that you will probably not run
important to pass the right @code{localstatedir} and @code{sysconfdir}
values, which get recorded in the @code{(guix config)} Guile module.
+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 @option{--localstatedir} option of the @command{configure}
+script (@pxref{Directory Variables, @code{localstatedir},, standards,
+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}). 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.
+
Finally, you can build Guix and, if you feel so inclined, run the tests
(@pxref{Running the Test Suite}):
--
2.41.0
P
P
pelzflorian (Florian Pelz) wrote 6 days ago
Re: [PATCH 0/2] Update Requirements section.
(address . 70333-done@debbugs.gnu.org)
87mspgmo78.fsf@pelzflorian.de
Pushed as 991f67902fd4be2b63f32274ed35d9f304c1c3f1
and 58646a949aadb4d7058aed9052d419730798d19d.

Regards,
Florian
Closed
?