04/07: doc: Update cargo-build-system parameter docs.

[guix-commits]

marusich pushed a commit to branch master
in repository guix.

commit 8a290772a45fd56cb5e85cb718ce654dddb54ea6
Author: Ivan Petkov <address@hidden>
Date:   Fri May 17 09:07:54 2019 -0700

    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 <address@hidden>
---
 doc/guix.texi | 20 ++++++++++++++++----
 1 file changed, 16 insertions(+), 4 deletions(-)

diff --git a/doc/guix.texi b/doc/guix.texi
index 87dc6ea..1b07327 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -64,6 +64,7 @@ Copyright @copyright{} 2018 Laura Lazzati@*
 Copyright @copyright{} 2018 Alex Vong@*
 Copyright @copyright{} 2019 Josh Holland@*
 Copyright @copyright{} 2019 Diego Nicola Barbato@*
+Copyright @copyright{} 2019 Ivan Petkov@*
 
 Permission is granted to copy, distribute and/or modify this document
 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
 @uref{https://www.rust-lang.org, Rust programming language}.
 
-In its @code{configure} phase, this build system replaces dependencies
-specified in the @file{Cargo.toml} file with inputs to the Guix package.
-The @code{install} phase installs the binaries, and it also installs the
-source code and @file{Cargo.toml} file.
+It adds @code{rustc} and @code{cargo} to the set of inputs.
+A different Rust package can be specified with the @code{#:rust} parameter.
+
+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
 
 @cindex Clojure (programming language)