forked from lix-project/lix
docs: guide to installables docs in installable commands' docs
The installables syntax is not documented in any of the man pages or
docbook pages for any of those individual commands. And while these
commands really should at least peripherally individually document how
installables work, in the meantime we can at least direct people to the
right place.
This commit also clarifies the unexpected fact that `nix profile remove`
and `nix profile upgrade` do *not* take installables.
Change-Id: I3b1453cb197a613bbab639c66a466365c3592c6d
This commit is contained in:
parent
e2ab89a74b
commit
194ba8a02f
|
@ -1,5 +1,7 @@
|
||||||
R""(
|
R""(
|
||||||
|
|
||||||
|
**Note:** this command's interface is based heavily around [*installables*](./nix.md#installables), which you may want to read about first (`nix --help`).
|
||||||
|
|
||||||
# Examples
|
# Examples
|
||||||
|
|
||||||
* Build the default package from the flake in the current directory:
|
* Build the default package from the flake in the current directory:
|
||||||
|
|
|
@ -1,5 +1,7 @@
|
||||||
R""(
|
R""(
|
||||||
|
|
||||||
|
**Note:** this command's interface is based heavily around [*installables*](./nix.md#installables), which you may want to read about first (`nix --help`).
|
||||||
|
|
||||||
# Examples
|
# Examples
|
||||||
|
|
||||||
* Bundle Hello:
|
* Bundle Hello:
|
||||||
|
|
|
@ -1,5 +1,7 @@
|
||||||
R""(
|
R""(
|
||||||
|
|
||||||
|
**Note:** this command's interface is based heavily around [*installables*](./nix.md#installables), which you may want to read about first (`nix --help`).
|
||||||
|
|
||||||
# Description
|
# Description
|
||||||
|
|
||||||
This command reads from standard input a JSON representation of a
|
This command reads from standard input a JSON representation of a
|
||||||
|
|
|
@ -1,5 +1,7 @@
|
||||||
R""(
|
R""(
|
||||||
|
|
||||||
|
**Note:** this command's interface is based heavily around [*installables*](./nix.md#installables), which you may want to read about first (`nix --help`).
|
||||||
|
|
||||||
# Examples
|
# Examples
|
||||||
|
|
||||||
* Show the [store derivation] that results from evaluating the Hello
|
* Show the [store derivation] that results from evaluating the Hello
|
||||||
|
|
|
@ -1,5 +1,7 @@
|
||||||
R""(
|
R""(
|
||||||
|
|
||||||
|
**Note:** this command's interface is based heavily around [*installables*](./nix.md#installables), which you may want to read about first (`nix --help`).
|
||||||
|
|
||||||
# Examples
|
# Examples
|
||||||
|
|
||||||
* Start a shell with the build environment of the default package of
|
* Start a shell with the build environment of the default package of
|
||||||
|
|
|
@ -1,5 +1,7 @@
|
||||||
R""(
|
R""(
|
||||||
|
|
||||||
|
**Note:** this command's interface is based heavily around [*installables*](./nix.md#installables), which you may want to read about first (`nix --help`).
|
||||||
|
|
||||||
# Examples
|
# Examples
|
||||||
|
|
||||||
* Show what got added and removed between two versions of the NixOS
|
* Show what got added and removed between two versions of the NixOS
|
||||||
|
|
|
@ -1,5 +1,7 @@
|
||||||
R""(
|
R""(
|
||||||
|
|
||||||
|
**Note:** this command's interface is based heavily around [*installables*](./nix.md#installables), which you may want to read about first (`nix --help`).
|
||||||
|
|
||||||
# Examples
|
# Examples
|
||||||
|
|
||||||
* Open the Nix expression of the GNU Hello package:
|
* Open the Nix expression of the GNU Hello package:
|
||||||
|
|
|
@ -1,5 +1,7 @@
|
||||||
R""(
|
R""(
|
||||||
|
|
||||||
|
**Note:** this command's interface is based heavily around [*installables*](./nix.md#installables), which you may want to read about first (`nix --help`).
|
||||||
|
|
||||||
# Examples
|
# Examples
|
||||||
|
|
||||||
* Evaluate a Nix expression given on the command line:
|
* Evaluate a Nix expression given on the command line:
|
||||||
|
|
|
@ -1,5 +1,7 @@
|
||||||
R""(
|
R""(
|
||||||
|
|
||||||
|
**Note:** this command's interface is based heavily around [*installables*](./nix.md#installables), which you may want to read about first (`nix --help`).
|
||||||
|
|
||||||
# Examples
|
# Examples
|
||||||
|
|
||||||
With [nixpkgs-fmt](https://github.com/nix-community/nixpkgs-fmt):
|
With [nixpkgs-fmt](https://github.com/nix-community/nixpkgs-fmt):
|
||||||
|
|
|
@ -1,5 +1,7 @@
|
||||||
R""(
|
R""(
|
||||||
|
|
||||||
|
**Note:** this command's interface is based heavily around [*installables*](./nix.md#installables), which you may want to read about first (`nix --help`).
|
||||||
|
|
||||||
# Examples
|
# Examples
|
||||||
|
|
||||||
* Get the build log of GNU Hello:
|
* Get the build log of GNU Hello:
|
||||||
|
|
|
@ -162,7 +162,7 @@ The Nix expression in that file, or any selected attribute, must evaluate to a d
|
||||||
|
|
||||||
Example: `--expr 'import <nixpkgs> {}' hello`
|
Example: `--expr 'import <nixpkgs> {}' hello`
|
||||||
|
|
||||||
When the option `--expr` *expression* \[*attrpath*...\] is given, installables are interpreted as the value of the of the Nix expression.
|
When the option `-E` / `--expr` *expression* \[*attrpath*...\] is given, installables are interpreted as the value of the of the Nix expression.
|
||||||
If attribute paths are provided, commands will operate on the corresponding values accessible at these paths.
|
If attribute paths are provided, commands will operate on the corresponding values accessible at these paths.
|
||||||
The Nix expression, or any selected attribute, must evaluate to a derivation.
|
The Nix expression, or any selected attribute, must evaluate to a derivation.
|
||||||
|
|
||||||
|
|
|
@ -1,5 +1,7 @@
|
||||||
R""(
|
R""(
|
||||||
|
|
||||||
|
**Note:** this command's interface is based heavily around [*installables*](./nix.md#installables), which you may want to read about first (`nix --help`).
|
||||||
|
|
||||||
# Examples
|
# Examples
|
||||||
|
|
||||||
* Print the store path produced by `nixpkgs#hello`:
|
* Print the store path produced by `nixpkgs#hello`:
|
||||||
|
|
|
@ -1,5 +1,7 @@
|
||||||
R""(
|
R""(
|
||||||
|
|
||||||
|
**Note:** this command's interface is based heavily around [*installables*](./nix.md#installables), which you may want to read about first (`nix --help`).
|
||||||
|
|
||||||
# Examples
|
# Examples
|
||||||
|
|
||||||
* Apply the build environment of GNU hello to the current shell:
|
* Apply the build environment of GNU hello to the current shell:
|
||||||
|
|
|
@ -1,5 +1,7 @@
|
||||||
R""(
|
R""(
|
||||||
|
|
||||||
|
**Note:** this command's interface is based heavily around [*installables*](./nix.md#installables), which you may want to read about first (`nix --help`).
|
||||||
|
|
||||||
# Examples
|
# Examples
|
||||||
|
|
||||||
* Install a package from Nixpkgs:
|
* Install a package from Nixpkgs:
|
||||||
|
|
|
@ -1,5 +1,7 @@
|
||||||
R""(
|
R""(
|
||||||
|
|
||||||
|
**Note**: unlike [`nix profile install`](./nix3-profile-install.md), this command does *not* take installables.
|
||||||
|
|
||||||
# Examples
|
# Examples
|
||||||
|
|
||||||
* Remove a package by position:
|
* Remove a package by position:
|
||||||
|
|
|
@ -1,5 +1,7 @@
|
||||||
R""(
|
R""(
|
||||||
|
|
||||||
|
**Note**: unlike [`nix profile install`](./nix3-profile-install.md), this command does *not* take installables.
|
||||||
|
|
||||||
# Examples
|
# Examples
|
||||||
|
|
||||||
* Upgrade all packages that were installed using an unlocked flake
|
* Upgrade all packages that were installed using an unlocked flake
|
||||||
|
|
|
@ -1,5 +1,7 @@
|
||||||
R""(
|
R""(
|
||||||
|
|
||||||
|
**Note:** this command's interface is based heavily around [*installables*](./nix.md#installables), which you may want to read about first (`nix --help`).
|
||||||
|
|
||||||
# Examples
|
# Examples
|
||||||
|
|
||||||
* Display all special commands within the REPL:
|
* Display all special commands within the REPL:
|
||||||
|
|
|
@ -1,5 +1,7 @@
|
||||||
R""(
|
R""(
|
||||||
|
|
||||||
|
**Note:** this command's interface is based heavily around [*installables*](./nix.md#installables), which you may want to read about first (`nix --help`).
|
||||||
|
|
||||||
# Examples
|
# Examples
|
||||||
|
|
||||||
* Run the default app from the `blender-bin` flake:
|
* Run the default app from the `blender-bin` flake:
|
||||||
|
|
|
@ -1,5 +1,7 @@
|
||||||
R""(
|
R""(
|
||||||
|
|
||||||
|
**Note:** this command's interface is based heavily around [*installables*](./nix.md#installables), which you may want to read about first (`nix --help`).
|
||||||
|
|
||||||
# Examples
|
# Examples
|
||||||
|
|
||||||
* Show all packages in the `nixpkgs` flake:
|
* Show all packages in the `nixpkgs` flake:
|
||||||
|
|
|
@ -1,5 +1,7 @@
|
||||||
R""(
|
R""(
|
||||||
|
|
||||||
|
**Note:** this command's interface is based heavily around [*installables*](./nix.md#installables), which you may want to read about first (`nix --help`).
|
||||||
|
|
||||||
# Examples
|
# Examples
|
||||||
|
|
||||||
* Start a shell providing `youtube-dl` from the `nixpkgs` flake:
|
* Start a shell providing `youtube-dl` from the `nixpkgs` flake:
|
||||||
|
|
|
@ -1,5 +1,7 @@
|
||||||
R""(
|
R""(
|
||||||
|
|
||||||
|
**Note:** this command's interface is based heavily around [*installables*](./nix.md#installables), which you may want to read about first (`nix --help`).
|
||||||
|
|
||||||
# Examples
|
# Examples
|
||||||
|
|
||||||
* Show one path through the dependency graph leading from Hello to
|
* Show one path through the dependency graph leading from Hello to
|
||||||
|
|
Loading…
Reference in a new issue