1
0
Fork 0
mirror of https://github.com/NixOS/nix synced 2025-06-24 22:11:15 +02:00

docs: Fix miscellaneous typos and formatting issues

This commit is contained in:
Sergei Zimmerman 2025-05-13 22:20:11 +00:00
parent f0f196cef0
commit 20a724d131
No known key found for this signature in database
GPG key ID: A9B0B557CA632325
8 changed files with 14 additions and 14 deletions

View file

@ -27,7 +27,7 @@ nix store info --store ssh://username@mac
``` ```
To specify an SSH identity file as part of the remote store URI add a To specify an SSH identity file as part of the remote store URI add a
query paramater, e.g. query parameter, e.g.
```console ```console
nix store info --store ssh://username@mac?ssh-key=/home/alice/my-key nix store info --store ssh://username@mac?ssh-key=/home/alice/my-key

View file

@ -22,9 +22,9 @@ The following [concept map] shows its main components (rectangles), the objects
| | | |
+----------|-------------------|--------------------------------+ +----------|-------------------|--------------------------------+
| Nix | V | | Nix | V |
| | +-------------------------+ | | | +------------------------+ |
| | | commmand line interface |------. | | | | command line interface |------. |
| | +-------------------------+ | | | | +------------------------+ | |
| | | | | | | | | |
| evaluated by calls manages | | evaluated by calls manages |
| | | | | | | | | |

View file

@ -280,7 +280,7 @@ All other combinations are invalid.
<!-- <!--
`__contentAddressed` is ignored, becaused fixed-output derivations always content-address their outputs, by definition. `__contentAddressed` is ignored, because fixed-output derivations always content-address their outputs, by definition.
**TODO CHECK** **TODO CHECK**
@ -333,17 +333,17 @@ Here is more information on the `output*` attributes, and what values they may b
- [`outputHashAlgo`]{#adv-attr-outputHashAlgo} - [`outputHashAlgo`]{#adv-attr-outputHashAlgo}
This specifies the hash alorithm used to digest the [file system object] data of a content-addressing derivation output. This specifies the hash algorithm used to digest the [file system object] data of a content-addressing derivation output.
This works in conjunction with [`outputHashMode`](#adv-attr-outputHashAlgo). This works in conjunction with [`outputHashMode`](#adv-attr-outputHashAlgo).
Specifying one without the other is an error (unless [`outputHash` is also specified and includes its own hash algorithm as described below). Specifying one without the other is an error (unless `outputHash` is also specified and includes its own hash algorithm as described below).
The `outputHashAlgo` attribute specifies the hash algorithm used to compute the hash. The `outputHashAlgo` attribute specifies the hash algorithm used to compute the hash.
It can currently be `"blake3"`, "sha1"`, `"sha256"`, `"sha512"`, or `null`. It can currently be `"blake3"`, `"sha1"`, `"sha256"`, `"sha512"`, or `null`.
`outputHashAlgo` can only be `null` when `outputHash` follows the SRI format, because in that case the choice of hash algorithm is determined by `outputHash`. `outputHashAlgo` can only be `null` when `outputHash` follows the SRI format, because in that case the choice of hash algorithm is determined by `outputHash`.
- [`outputHash`]{#adv-attr-outputHashAlgo}; [`outputHash`]{#adv-attr-outputHashMode}\ - [`outputHash`]{#adv-attr-outputHashAlgo}; [`outputHash`]{#adv-attr-outputHashMode}
This will specify the output hash of the single output of a [fixed-output derivation]. This will specify the output hash of the single output of a [fixed-output derivation].

View file

@ -13,7 +13,7 @@
* New command `nix store copy-log` to copy build logs from one store * New command `nix store copy-log` to copy build logs from one store
to another. to another.
* The `commit-lockfile-summary` option can be set to a non-empty * The `commit-lockfile-summary` option can be set to a non-empty
string to override the commit summary used when commiting an updated string to override the commit summary used when committing an updated
lockfile. This may be used in conjunction with the `nixConfig` lockfile. This may be used in conjunction with the `nixConfig`
attribute in `flake.nix` to better conform to repository attribute in `flake.nix` to better conform to repository
conventions. conventions.

View file

@ -87,7 +87,7 @@ The rules for this are fairly concise:
- If it is pure, it must be floating. - If it is pure, it must be floating.
- Pure, fixed content-addressing derivations are not suppported - Pure, fixed content-addressing derivations are not supported
> There is no use for this forth combination. > There is no use for this forth combination.
> The sole purpose of an output's store path being fixed is to support the derivation being impure. > The sole purpose of an output's store path being fixed is to support the derivation being impure.

View file

@ -85,7 +85,7 @@ The parts of a local overlay store are as follows:
> The location of the database instead depends on the [`state`](#store-experimental-local-overlay-store-state) setting. > The location of the database instead depends on the [`state`](#store-experimental-local-overlay-store-state) setting.
> It is always `${state}/db`. > It is always `${state}/db`.
This contains the metadata of all of the upper layer [store objects][store object] (everything beyond their file system objects), and also duplicate copies of some lower layer store object's metadta. This contains the metadata of all of the upper layer [store objects][store object] (everything beyond their file system objects), and also duplicate copies of some lower layer store object's metadata.
The duplication is so the metadata for the [closure](@docroot@/glossary.md#gloss-closure) of upper layer [store objects][store object] can be found entirely within the upper layer. The duplication is so the metadata for the [closure](@docroot@/glossary.md#gloss-closure) of upper layer [store objects][store object] can be found entirely within the upper layer.
(This allows us to use the same SQL Schema as the [local store]'s SQLite database, as foreign keys in that schema enforce closure metadata to be self-contained in this way.) (This allows us to use the same SQL Schema as the [local store]'s SQLite database, as foreign keys in that schema enforce closure metadata to be self-contained in this way.)

View file

@ -32,7 +32,7 @@ R""(
This command updates the lock file of a flake (`flake.lock`) This command updates the lock file of a flake (`flake.lock`)
so that it contains an up-to-date lock for every flake input specified in so that it contains an up-to-date lock for every flake input specified in
`flake.nix`. Lock file entries are aready up-to-date are not modified. `flake.nix`. Lock file entries are already up-to-date are not modified.
If you want to update existing lock entries, use If you want to update existing lock entries, use
[`nix flake update`](@docroot@/command-ref/new-cli/nix3-flake-update.md) [`nix flake update`](@docroot@/command-ref/new-cli/nix3-flake-update.md)

View file

@ -695,7 +695,7 @@ following fields:
The attributes in `locked` are considered "final", meaning that they are the only ones that are passed via the arguments of the `outputs` function of a flake. The attributes in `locked` are considered "final", meaning that they are the only ones that are passed via the arguments of the `outputs` function of a flake.
For instance, if `locked` contains a `lastModified` attribute while the fetcher does not return a `lastModified` attribute, then the `lastModified` attribute will be passed to the `outputs` function. For instance, if `locked` contains a `lastModified` attribute while the fetcher does not return a `lastModified` attribute, then the `lastModified` attribute will be passed to the `outputs` function.
Conversely, if `locked` does *not* contain a `lastModified` attribute while the fetcher *does* return a `lastModified` attribute, then no `lastModified` attribute will be passed. Conversely, if `locked` does *not* contain a `lastModified` attribute while the fetcher *does* return a `lastModified` attribute, then no `lastModified` attribute will be passed.
If `locked` contains a `lastModifed` attribute and the fetcher returns a `lastModified` attribute, then they must have the same value. If `locked` contains a `lastModified` attribute and the fetcher returns a `lastModified` attribute, then they must have the same value.
* `flake`: A Boolean denoting whether this is a flake or non-flake * `flake`: A Boolean denoting whether this is a flake or non-flake
dependency. Corresponds to the `flake` attribute in the `inputs` dependency. Corresponds to the `flake` attribute in the `inputs`