ryan77627/guix
1
0
Fork 0
mirror of https://git.in.rschanz.org/ryan77627/guix.git synced 2024-12-24 21:38:07 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: Move build commands to @example for clarity.

Browse source 
* doc/contributing.texi (Building from Git): Tweak so that all the
commands appear in @example boxes.  Show --localstatedir=/var instead of
--localstatedir=@var{directory}.
This commit is contained in:
Ludovic Courtès 2022-02-15 10:29:09 +01:00
parent cfa6fdc54c
commit 8d472e9314
No known key found for this signature in database
GPG key ID: 090B11993D9AEBB5
1 changed files with 31 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

43
doc/contributing.texi
View file

@ -98,8 +98,14 @@ shell}:
guix shell -D guix help2man git strace --pure guix shell -D guix help2man git strace --pure
@end example @end example
Run @command{./bootstrap} to generate the build system infrastructure From there you can generate the build system infrastructure
using Autoconf and Automake. If you get an error like this one: using Autoconf and Automake:
@example
./bootstrap
@end example
If you get an error like this one:
@example @example
configure.ac:46: error: possibly undefined macro: PKG_CHECK_MODULES configure.ac:46: error: possibly undefined macro: PKG_CHECK_MODULES
@ -120,17 +126,30 @@ export ACLOCAL_PATH=/usr/share/aclocal
@xref{Macro Search Path,,, automake, The GNU Automake Manual}, for @xref{Macro Search Path,,, automake, The GNU Automake Manual}, for
more information. more information.
Then, run @command{./configure --localstatedir=@var{directory}}, where Then, run:
@var{directory} is the @code{localstatedir} value used by your current
installation (@pxref{The Store}, for information about this), usually
@file{/var}. 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}.
Finally, you have to invoke @code{make && make check} to build Guix and @example
run the tests (@pxref{Running the Test Suite}). If anything fails, take ./configure --localstatedir=/var
a look at installation instructions (@pxref{Installation}) or send a @end example
message to the @email{guix-devel@@gnu.org, mailing list}.
@noindent
... where @file{/var} is the normal @code{localstatedir} value
(@pxref{The Store}, for information about this). 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}.
Finally, you can build Guix and, if you feel so inclined, run the tests
(@pxref{Running the Test Suite}):
@example
make
make check
@end example
@noindent
If anything fails, take a look at installation instructions
(@pxref{Installation}) or send a message to the
@email{guix-devel@@gnu.org, mailing list}.
From there on, you can authenticate all the commits included in your From there on, you can authenticate all the commits included in your
checkout by running: checkout by running: