aboutsummaryrefslogtreecommitdiff
path: root/src/nix/add-path.md
diff options
context:
space:
mode:
authorEelco Dolstra <edolstra@gmail.com>2020-12-04 00:58:09 +0100
committerEelco Dolstra <edolstra@gmail.com>2020-12-04 00:59:24 +0100
commitf337aa70998141ccfaa956e9f670152dbb15b385 (patch)
tree7563c50f1cc90ea34ca45bd66d8962d4c9fff6bc /src/nix/add-path.md
parent8df58eae4c6f074b8e33a5bcb0c73b6700e34d5a (diff)
Split 'nix store add-to-store' into 'add-path' and 'add-file'
This makes it consistent with 'nix hash <path|file>'.
Diffstat (limited to 'src/nix/add-path.md')
-rw-r--r--src/nix/add-path.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/src/nix/add-path.md b/src/nix/add-path.md
new file mode 100644
index 000000000..87473611d
--- /dev/null
+++ b/src/nix/add-path.md
@@ -0,0 +1,29 @@
+R""(
+
+# Description
+
+Copy *path* to the Nix store, and print the resulting store path on
+standard output.
+
+> **Warning**
+>
+> The resulting store path is not registered as a garbage
+> collector root, so it could be deleted before you have a
+> chance to register it.
+
+# Examples
+
+Add a directory to the store:
+
+```console
+# mkdir dir
+# echo foo > dir/bar
+
+# nix store add-path ./dir
+/nix/store/6pmjx56pm94n66n4qw1nff0y1crm8nqg-dir
+
+# cat /nix/store/6pmjx56pm94n66n4qw1nff0y1crm8nqg-dir/bar
+foo
+```
+
+)""