diff options
| author | Hugo Osvaldo Barrera <hugo@barrera.io> | 2022-06-03 23:19:12 +0200 |
|---|---|---|
| committer | Hugo Osvaldo Barrera <hugo@barrera.io> | 2022-06-14 18:13:35 +0200 |
| commit | fd7f795750ad97466c0fb9733ac3cc2a0909b84d (patch) | |
| tree | 31fe8dc76edab7d1942971ed286ebce7ab6846c1 /doc | |
| parent | 1dd7253133c4dfd2e7a16ad6fe505442cef38a5b (diff) | |
Add disambiguation to man page
This should help future lost newcomers like myself understand where to
find the docs for both of these commands and how they differ.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/manual/src/command-ref/nix-build.md | 6 | ||||
| -rw-r--r-- | doc/manual/src/command-ref/nix-shell.md | 6 |
2 files changed, 12 insertions, 0 deletions
diff --git a/doc/manual/src/command-ref/nix-build.md b/doc/manual/src/command-ref/nix-build.md index aacb32a25..49c6f3f55 100644 --- a/doc/manual/src/command-ref/nix-build.md +++ b/doc/manual/src/command-ref/nix-build.md @@ -12,6 +12,12 @@ [`--dry-run`] [{`--out-link` | `-o`} *outlink*] +# Disambiguation + +This man page describes the command `nix-build`, which is distinct from `nix +build`. For documentation on the latter, run `nix build --help` or see `man +nix3-build`. + # Description The `nix-build` command builds the derivations described by the Nix diff --git a/doc/manual/src/command-ref/nix-shell.md b/doc/manual/src/command-ref/nix-shell.md index a2b6d8a8e..840bccd25 100644 --- a/doc/manual/src/command-ref/nix-shell.md +++ b/doc/manual/src/command-ref/nix-shell.md @@ -15,6 +15,12 @@ [`--keep` *name*] {{`--packages` | `-p`} {*packages* | *expressions*} … | [*path*]} +# Disambiguation + +This man page describes the command `nix-shell`, which is distinct from `nix +shell`. For documentation on the latter, run `nix shell --help` or see `man +nix3-shell`. + # Description The command `nix-shell` will build the dependencies of the specified |