nixo
/
guix-devel
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

doc: Update cargo-build-system parameter docs. 

* doc/guix.texi: (Build Systems)[cargo-build-system]: Add references to
the #:rust, #:cargo-inputs, and #:cargo-development-inputs parameters.
Remove reference to installing crate sources.

Signed-off-by: Chris Marusich <cmmarusich@gmail.com>
This commit is contained in:
Ivan Petkov 2019-05-17 09:07:54 -07:00 committed by Chris Marusich
parent d608e231e3
commit 8a290772a4
No known key found for this signature in database
GPG Key ID: DD409A15D822469D
1 changed files with 16 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
doc/guix.texi
View File

@ -64,6 +64,7 @@ Copyright @copyright{} 2018 Laura Lazzati@*
Copyright @copyright{} 2018 Alex Vong@* Copyright @copyright{} 2018 Alex Vong@*
Copyright @copyright{} 2019 Josh Holland@* Copyright @copyright{} 2019 Josh Holland@*
Copyright @copyright{} 2019 Diego Nicola Barbato@* Copyright @copyright{} 2019 Diego Nicola Barbato@*
Copyright @copyright{} 2019 Ivan Petkov@*
Permission is granted to copy, distribute and/or modify this document Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or under the terms of the GNU Free Documentation License, Version 1.3 or
@ -5814,10 +5815,21 @@ This variable is exported by @code{(guix build-system cargo)}. It
supports builds of packages using Cargo, the build tool of the supports builds of packages using Cargo, the build tool of the
@uref{https://www.rust-lang.org, Rust programming language}. @uref{https://www.rust-lang.org, Rust programming language}.
In its @code{configure} phase, this build system replaces dependencies It adds @code{rustc} and @code{cargo} to the set of inputs.
specified in the @file{Cargo.toml} file with inputs to the Guix package. A different Rust package can be specified with the @code{#:rust} parameter.
The @code{install} phase installs the binaries, and it also installs the
source code and @file{Cargo.toml} file. Regular cargo dependencies should be added to the package definition via the
@code{#:cargo-inputs} parameter as a list of name and spec pairs, where the
spec can be a package or a source definition. Note that the spec must
evaluate to a path to a gzipped tarball which includes a @code{Cargo.toml}
file at its root, or it will be ignored. Similarly, cargo dev-dependencies
should be added to the package definition via the
@code{#:cargo-development-inputs} parameter.
In its @code{configure} phase, this build system will make any source inputs
specified in the @code{#:cargo-inputs} and @code{#:cargo-development-inputs}
parameters available to cargo. The @code{install} phase installs any crate
the binaries if they are defined by the crate.
@end defvr @end defvr
@cindex Clojure (programming language) @cindex Clojure (programming language)