From e5029028d6cf6c7b9d61081d95f09e2d735648ba Mon Sep 17 00:00:00 2001 From: Ekaitz Zarraga Date: Thu, 12 Jan 2023 23:09:46 +0100 Subject: [PATCH 3/3] Add zig-build-system documentation --- doc/guix.texi | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/doc/guix.texi b/doc/guix.texi index aacf748838..c28dbf035a 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -9573,6 +9573,28 @@ Python package is used to run the script can be specified with the @code{#:python} parameter. @end defvr +@defvr {Scheme Variable} zig-build-system This variable is exported by +@code{(guix build-system zig)}. It implements the build procedure used by the +Zig build system (@code{zig build} command). + +This build system adds @code{zig} to the package inputs, as well as the +packages of @code{gnu-build-system}. + +There's no @code{configure} phase because zig packages typically don't need to +be configured. The @code{#:zig-build-flags} parameter is taken as a list of +flags passed to the @code{zig} command during the build. The +@code{#:zig-test-flags} parameter is taken as a list of flags passed to the +@code{zig test} command during the @code{check} phase. The default compiler +package can be overriden using the @code{#:zig} argument. + +The @code{zig-release-type} parameter can be passed to define the type of +release to make. Possible values are: @code{safe}, @code{fast}, @code{small}. +It's default value is @code{#f}, which doesn't include the release flag in the +@code{zig} command, resulting in a @code{debug} build. + +@end defvr + + @defvr {Scheme Variable} scons-build-system This variable is exported by @code{(guix build-system scons)}. It implements the build procedure used by the SCons software construction -- 2.38.0