diff options
author | Ludovic Courtès <ludo@gnu.org> | 2016-01-31 20:44:21 +0100 |
---|---|---|
committer | Ludovic Courtès <ludo@gnu.org> | 2016-02-01 08:59:13 +0100 |
commit | 88ad6deda6dc25ac752074d402879594142a5a9f (patch) | |
tree | 329c2b57e8f8215ca3a2a9827ce6f4ba34f5f52d /doc | |
parent | ccd7158d2ab182713891701e08970dbd6b68f4e5 (diff) | |
download | guix-88ad6deda6dc25ac752074d402879594142a5a9f.tar guix-88ad6deda6dc25ac752074d402879594142a5a9f.tar.gz |
guix build: Separate transformation options.
* guix/scripts/build.scm (%transformation-options): New variable.
(show-transformation-options-help): New procedure.
(show-help): Remove '--with-source' documentation and add
'show-transformation-options-help' call.
(%options): Remove "with-source" and append %TRANSFORMATION-OPTIONS.
* doc/guix.texi (Package Transformation Options): New node. Document
'--with-source', moved from...
(Additional Build Options): ... here.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/guix.texi | 85 |
1 files changed, 51 insertions, 34 deletions
diff --git a/doc/guix.texi b/doc/guix.texi index cae55c1942..10ca9b76ad 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -3810,6 +3810,7 @@ described in the subsections below. @menu * Common Build Options:: Build options for most commands. +* Package Transformation Options:: Creating variants of packages. * Additional Build Options:: Options specific to 'guix build'. @end menu @@ -3939,6 +3940,56 @@ These options are parsed independently, and the result is appended to the parsed command-line options. @end defvr + +@node Package Transformation Options +@subsection Package Transformation Options + +@cindex package variants +Another set of command-line options supported by @command{guix build} +are @dfn{package transformation options}. These are options that allow, +from the command-line, to define @dfn{package variants}---for instance, +packages built from different source code. This is a convenient way to +create customized packages on the fly without having to type in the +definitions of package variants (@pxref{Defining Packages}). + +@table @code + +@item --with-source=@var{source} +Use @var{source} as the source of the corresponding package. +@var{source} must be a file name or a URL, as for @command{guix +download} (@pxref{Invoking guix download}). + +The ``corresponding package'' is taken to be one specified on the +command line whose name matches the base of @var{source}---e.g., if +@var{source} is @code{/src/guile-2.0.10.tar.gz}, the corresponding +package is @code{guile}. Likewise, the version string is inferred from +@var{source}; in the previous example, it's @code{2.0.10}. + +This option allows users to try out versions of packages other than the +one provided by the distribution. The example below downloads +@file{ed-1.7.tar.gz} from a GNU mirror and uses that as the source for +the @code{ed} package: + +@example +guix build ed --with-source=mirror://gnu/ed/ed-1.7.tar.gz +@end example + +As a developer, @code{--with-source} makes it easy to test release +candidates: + +@example +guix build guile --with-source=../guile-2.0.9.219-e1bb7.tar.xz +@end example + +@dots{} or to build from a checkout in a pristine environment: + +@example +$ git clone git://git.sv.gnu.org/guix.git +$ guix build guix --with-source=./guix +@end example + +@end table + @node Additional Build Options @subsection Additional Build Options @@ -4047,40 +4098,6 @@ Cross-build for @var{triplet}, which must be a valid GNU triplet, such as @code{"mips64el-linux-gnu"} (@pxref{Configuration Names, GNU configuration triplets,, configure, GNU Configure and Build System}). -@item --with-source=@var{source} -Use @var{source} as the source of the corresponding package. -@var{source} must be a file name or a URL, as for @command{guix -download} (@pxref{Invoking guix download}). - -The ``corresponding package'' is taken to be one specified on the -command line whose name matches the base of @var{source}---e.g., if -@var{source} is @code{/src/guile-2.0.10.tar.gz}, the corresponding -package is @code{guile}. Likewise, the version string is inferred from -@var{source}; in the previous example, it's @code{2.0.10}. - -This option allows users to try out versions of packages other than the -one provided by the distribution. The example below downloads -@file{ed-1.7.tar.gz} from a GNU mirror and uses that as the source for -the @code{ed} package: - -@example -guix build ed --with-source=mirror://gnu/ed/ed-1.7.tar.gz -@end example - -As a developer, @code{--with-source} makes it easy to test release -candidates: - -@example -guix build guile --with-source=../guile-2.0.9.219-e1bb7.tar.xz -@end example - -@dots{} or to build from a checkout in a pristine environment: - -@example -$ git clone git://git.sv.gnu.org/guix.git -$ guix build guix --with-source=./guix -@end example - @anchor{build-check} @item --check @cindex determinism, checking |