diff options
| author | Valentin Gagarin <valentin.gagarin@tweag.io> | 2022-12-01 01:57:02 +0100 |
|---|---|---|
| committer | Valentin Gagarin <valentin.gagarin@tweag.io> | 2023-03-05 01:46:17 +0100 |
| commit | 2af9fd20c62a964ae50bd6c31ee30d57e5be15e8 (patch) | |
| tree | 54309aefaaa0e63f50edaa2d4dd532f35a81601b /src/nix/search.md | |
| parent | 1e87d5f1ea43be0daa42e9be17184b15f5fbdf07 (diff) | |
clarify definition of "installable"
the term was hard to discover, as its definition and explanation were in
a very long document lacking an overview section.
search did not help because it occurs so often.
- clarify wording in the definition
- add an overview of installable types
- add "installable" to glossary
- link to definition from occurrences of the term
- be more precise about where store derivation outputs are processed
- installable Nix expressions must evaluate to a derivation
Co-authored-by: Adam Joseph <54836058+amjoseph-nixpkgs@users.noreply.github.com>
Diffstat (limited to 'src/nix/search.md')
| -rw-r--r-- | src/nix/search.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/src/nix/search.md b/src/nix/search.md index 5a5b5ae05..4caa90654 100644 --- a/src/nix/search.md +++ b/src/nix/search.md @@ -62,10 +62,10 @@ R""( # Description -`nix search` searches *installable* (which must be evaluatable, e.g. a -flake) for packages whose name or description matches all of the +`nix search` searches [*installable*](./nix.md#installables) (which can be evaluated, that is, a +flake or Nix expression, but not a store path or store derivation path) for packages whose name or description matches all of the regular expressions *regex*. For each matching package, It prints the -full attribute name (from the root of the installable), the version +full attribute name (from the root of the [installable](./nix.md#installables)), the version and the `meta.description` field, highlighting the substrings that were matched by the regular expressions. If no regular expressions are specified, all packages are shown. |