Skip to content

Commit 341628a

Browse files
authored
Merge pull request #12618 from fzakaria/minor-text-fixes
Fix minor documentation typos
2 parents d1b21e8 + 33493b9 commit 341628a

File tree

3 files changed

+8
-7
lines changed

3 files changed

+8
-7
lines changed

doc/manual/source/store/derivation/outputs/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
# Derivation Outputs and Types of Derivations
22

33
As stated on the [main pages on derivations](../index.md#store-derivation),
4-
a derivation produces [store objects], which are known as the *outputs* of the derivation.
4+
a derivation produces [store objects](@docroot@/store/store-object.md), which are known as the *outputs* of the derivation.
55
Indeed, the entire point of derivations is to produce these outputs, and to reliably and reproducably produce these derivations each time the derivation is run.
66

77
One of the parts of a derivation is its *outputs specification*, which specifies certain information about the outputs the derivation produces when run.
88
The outputs specification is a map, from names to specifications for individual outputs.
99

1010
## Output Names {#outputs}
1111

12-
Output names can be any string which is also a valid [store path] name.
12+
Output names can be any string which is also a valid [store path](@docroot@/store/store-path.md) name.
1313
The name mapped to each output specification is not actually the name of the output.
1414
In the general case, the output store object has name `derivationName + "-" + outputSpecName`, not any other metadata about it.
1515
However, an output spec named "out" describes and output store object whose name is just the derivation name.
@@ -24,11 +24,11 @@ However, an output spec named "out" describes and output store object whose name
2424
>
2525
> - The store path of `dev` will be: `/nix/store/<hash>-hello-dev`.
2626
27-
The outputs are the derivations are the [store objects][store object] it is obligated to produce.
27+
The outputs are the derivations are the [store objects](@docroot@/store/store-object.md) it is obligated to produce.
2828

2929
> **Note**
3030
>
31-
> The formal terminology here is somewhat at adds with everyday communication in the Nix community today.
31+
> The formal terminology here is somewhat at odds with everyday communication in the Nix community today.
3232
> "output" in casual usage tends to refer to either to the actual output store object, or the notional output spec, depending on context.
3333
>
3434
> For example "hello's `dev` output" means the store object referred to by the store path `/nix/store/<hash>-hello-dev`.
@@ -64,7 +64,7 @@ The rules for this are fairly concise:
6464

6565
(This is an arbitrary restriction that could be lifted.)
6666

67-
- The output is either *fixed* or *floating*, indicating whether the its store path is known prior to building it.
67+
- The output is either *fixed* or *floating*, indicating whether the store path is known prior to building it.
6868

6969
- With fixed content-addressing it is fixed.
7070

doc/manual/source/store/file-system-object/content-address.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ be many different serialisations.
4646
For these reasons, Nix has its very own archive format—the Nix Archive (NAR) format,
4747
which is carefully designed to avoid the problems described above.
4848

49-
The exact specification of the Nix Archive format is in `protocols/nix-archive.md`
49+
The exact specification of the Nix Archive format is in [specified here](../../protocols/nix-archive.md).
5050

5151
## Content addressing File System Objects beyond a single serialisation pass
5252

@@ -80,6 +80,7 @@ Thus, Git can encode some, but not all of Nix's "File System Objects", and this
8080

8181
In the future, we may support a Git-like hash for such file system objects, or we may adopt another Merkle DAG format which is capable of representing all Nix file system objects.
8282

83+
8384
[file system object]: ../file-system-object.md
8485
[store object]: ../store-object.md
8586
[xp-feature-git-hashing]: @docroot@/development/experimental-features.md#xp-feature-git-hashing

doc/manual/source/store/store-object/content-address.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ The hashes of these modified input streams are used instead.
5050
5151
When validating the content address of a store object after the fact, the above process works as written.
5252
However, when first creating the store object we don't know the store object's store path, as explained just above.
53-
We therefore, strictly speaking, do not know what value we will be replacing with the sentinental value in the inputs to hash functions.
53+
We therefore, strictly speaking, do not know what value we will be replacing with the sentinel value in the inputs to hash functions.
5454
What instead happens is that the provisional store object --- the data from which we wish to create a store object --- is paired with a provisional "scratch" store path (that presumably was chosen when the data was created).
5555
That provisional store path is instead what is replaced with the sentinel value, rather than the final store object which we do not yet know.
5656

0 commit comments

Comments
 (0)