Merge pull request #7486 from fricklerhandwerk/doc-reference

reword definition of "reference"
This commit is contained in:
Eelco Dolstra 2023-03-13 14:04:14 +01:00 committed by GitHub
commit 6f22e8b7d8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -135,14 +135,13 @@
then be built. then be built.
- [reference]{#gloss-reference}\ - [reference]{#gloss-reference}\
A store path `P` is said to have a reference to a store path `Q` if A [store object] `O` is said to have a *reference* to a store object `P` if a [store path] to `P` appears in the contents of `O`.
the store object at `P` contains the path `Q` somewhere. The
*references* of a store path are the set of store paths to which it
has a reference.
A derivation can reference other derivations and sources (but not Store objects can refer to both other store objects and themselves.
output paths), whereas an output path only references other output References from a store object to itself are called *self-references*.
paths. References other than a self-reference must not form a cycle.
[reference]: #gloss-reference
- [reachable]{#gloss-reachable}\ - [reachable]{#gloss-reachable}\
A store path `Q` is reachable from another store path `P` if `Q` A store path `Q` is reachable from another store path `P` if `Q`
@ -159,8 +158,8 @@
files could be missing. The command `nix-store -qR` prints out files could be missing. The command `nix-store -qR` prints out
closures of store paths. closures of store paths.
As an example, if the store object at path `P` contains a reference As an example, if the [store object] at path `P` contains a [reference]
to path `Q`, then `Q` is in the closure of `P`. Further, if `Q` to a store object at path `Q`, then `Q` is in the closure of `P`. Further, if `Q`
references `R` then `R` is also in the closure of `P`. references `R` then `R` is also in the closure of `P`.
[closure]: #gloss-closure [closure]: #gloss-closure