02/03: doc: Document references.

[guix-commits]

civodul pushed a commit to branch master
in repository guix.

commit 910aaa3b8646b6dfea5cab6ed8da3fc549a2dd70
Author: Ludovic Courtès <address@hidden>
Date:   Fri Mar 8 11:47:00 2019 +0100

    doc: Document references.
    
    Suggested by "pelzflorian (Florian Pelz)" <address@hidden>.
    Fixes <https://bugs.gnu.org/34574>.
    
    * doc/guix.texi (Derivations): Document references.
---
 doc/guix.texi | 17 +++++++++++++++--
 1 file changed, 15 insertions(+), 2 deletions(-)

diff --git a/doc/guix.texi b/doc/guix.texi
index 0f325fb..11ce9d6 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -6238,8 +6238,11 @@ The outputs of the derivation---derivations produce at 
least one file or
 directory in the store, but may produce more.
 
 @item
-The inputs of the derivations, which may be other derivations or plain
-files in the store (patches, build scripts, etc.)
address@hidden build-time dependencies
address@hidden dependencies, build-time
+The inputs of the derivations---i.e., its build-time dependencies---which may
+be other derivations or plain files in the store (patches, build scripts,
+etc.)
 
 @item
 The system type targeted by the derivation---e.g., @code{x86_64-linux}.
@@ -6270,6 +6273,16 @@ of a fixed-output derivation are independent of its 
inputs---e.g., a
 source code download produces the same result regardless of the download
 method and tools being used.
 
address@hidden references
address@hidden run-time dependencies
address@hidden dependencies, run-time
+The outputs of derivations---i.e., the build results---have a set of
address@hidden, as reported by the @code{references} RPC or the
address@hidden gc --references} command (@pxref{Invoking guix gc}).  References
+are the set of run-time dependencies of the build results.  References are a
+subset of the inputs of the derivation; this subset is automatically computed
+by the build daemon by scanning all the files in the outputs.
+
 The @code{(guix derivations)} module provides a representation of
 derivations as Scheme objects, along with procedures to create and
 otherwise manipulate derivations.  The lowest-level primitive to create