aboutsummaryrefslogtreecommitdiff
path: root/src/nix/registry-pin.md
diff options
context:
space:
mode:
authorEelco Dolstra <edolstra@gmail.com>2020-12-08 22:57:14 +0100
committerEelco Dolstra <edolstra@gmail.com>2020-12-21 13:32:27 +0100
commite90e74523238f37748d9f406732919374d7ee561 (patch)
treed7be371a9ab3a1c9ca2c0eb3c45527e0ee95de98 /src/nix/registry-pin.md
parent42cc98f8d66627ff7e396fb809034d3389b3bd0a (diff)
Add 'nix registry' manpages
This also documents the registry format and matching/unification semantics (though not quite correctly).
Diffstat (limited to 'src/nix/registry-pin.md')
-rw-r--r--src/nix/registry-pin.md38
1 files changed, 38 insertions, 0 deletions
diff --git a/src/nix/registry-pin.md b/src/nix/registry-pin.md
new file mode 100644
index 000000000..6e97e003e
--- /dev/null
+++ b/src/nix/registry-pin.md
@@ -0,0 +1,38 @@
+R""(
+
+# Examples
+
+* Pin `nixpkgs` to its most recent Git revision:
+
+ ```console
+ # nix registry pin nixpkgs
+ ```
+
+ Afterwards the user registry will have an entry like this:
+
+ ```console
+ nix registry list | grep '^user '
+ user flake:nixpkgs github:NixOS/nixpkgs/925b70cd964ceaedee26fde9b19cc4c4f081196a
+ ```
+
+ and `nix flake info` will say:
+
+ ```console
+ # nix flake info nixpkgs
+ Resolved URL: github:NixOS/nixpkgs/925b70cd964ceaedee26fde9b19cc4c4f081196a
+ Locked URL: github:NixOS/nixpkgs/925b70cd964ceaedee26fde9b19cc4c4f081196a
+ …
+ ```
+
+# Description
+
+This command adds an entry to the user registry that maps flake
+reference *url* to the corresponding *locked* flake reference, that
+is, a flake reference that specifies an exact revision or content
+hash. This ensures that until this registry entry is removed, all uses
+of *url* will resolve to exactly the same flake.
+
+Entries can be removed using [`nix registry
+remove`](./nix3-registry-remove.md).
+
+)""