Add a new nix store add command

Deprecate `nix store add-file` and `nix store add-path`, and replace them with a single `nix store add` command.
NixOS · Nov 15, 2023 · 8412846 · 8412846
1 parent 2afe2e4
commit 8412846
Show file tree

Hide file tree

Showing 5 changed files with 62 additions and 45 deletions.
diff --git a/doc/manual/src/release-notes/rl-next.md b/doc/manual/src/release-notes/rl-next.md
@@ -73,3 +73,5 @@
   [`XDG_DATA_DIRS`](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html#variables) is now populated with the path to the `/share` subdirectory of the current profile.
   This means that command completion scripts, `.desktop` files, and similar artifacts installed via [`nix-env`](@docroot@/command-ref/nix-env.md) or [`nix profile`](@docroot@/command-ref/new-cli/nix3-profile.md)
   (experimental) can be found by any program that follows the [XDG Base Directory Specification](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html).
+
+- A new command `nix store add` has been added. It replaces `nix store add-file` and `nix store add-path` which are now deprecated.
diff --git a/src/nix/add-file.md b/src/nix/add-file.md
diff --git a/src/nix/add-to-store.cc b/src/nix/add-to-store.cc
@@ -5,11 +5,22 @@
 
 using namespace nix;
 
+static FileIngestionMethod parseIngestionMethod(std::string_view input)
+{
+    if (input == "flat") {
+        return FileIngestionMethod::Flat;
+    } else if (input == "nar") {
+        return FileIngestionMethod::Recursive;
+    } else {
+        throw UsageError("Unknown hash mode '%s', expect `flat` or `nar`");
+    }
+}
+
 struct CmdAddToStore : MixDryRun, StoreCommand
 {
     Path path;
     std::optional<std::string> namePart;
-    FileIngestionMethod ingestionMethod;
+    FileIngestionMethod ingestionMethod = FileIngestionMethod::Recursive;
 
     CmdAddToStore()
     {
@@ -23,6 +34,23 @@ struct CmdAddToStore : MixDryRun, StoreCommand
             .labels = {"name"},
             .handler = {&namePart},
         });
+
+        addFlag({
+            .longName  = "mode",
+            .shortName = 'n',
+            .description = R"(
+    How to compute the hash of the input.
+    One of:
+
+    - `nar` (the default): Serialises the input as an archive (following the [_Nix Archive Format_](https://edolstra.github.io/pubs/phd-thesis.pdf#page=101)) and passes that to the hash function.
+
+    - `flat`: Assumes that the input is a single file and directly passes it to the hash function;
+            )",
+            .labels = {"hash-mode"},
+            .handler = {[this](std::string s) {
+                this->ingestionMethod = parseIngestionMethod(s);
+            }},
+        });
     }
 
     void run(ref<Store> store) override
@@ -62,45 +90,43 @@ struct CmdAddToStore : MixDryRun, StoreCommand
     }
 };
 
-struct CmdAddFile : CmdAddToStore
+struct CmdAdd : CmdAddToStore
 {
-    CmdAddFile()
-    {
-        ingestionMethod = FileIngestionMethod::Flat;
-    }
 
     std::string description() override
     {
-        return "add a regular file to the Nix store";
+        return "Add a file or directory to the Nix store";
     }
 
     std::string doc() override
     {
         return
-          #include "add-file.md"
+          #include "add.md"
           ;
     }
 };
 
-struct CmdAddPath : CmdAddToStore
+struct CmdAddFile : CmdAddToStore
 {
-    CmdAddPath()
+    CmdAddFile()
     {
-        ingestionMethod = FileIngestionMethod::Recursive;
+        ingestionMethod = FileIngestionMethod::Flat;
     }
 
     std::string description() override
     {
-        return "add a path to the Nix store";
+        return "Deprecated. Use [`nix store add --mode flat`](@docroot@/command-ref/new-cli/nix3-store-add.md) instead.";
     }
+};
 
-    std::string doc() override
+struct CmdAddPath : CmdAddToStore
+{
+    std::string description() override
     {
-        return
-          #include "add-path.md"
-          ;
+        return "Deprecated alias to [`nix store add`](@docroot@/command-ref/new-cli/nix3-store-add.md).";
     }
 };
 
 static auto rCmdAddFile = registerCommand2<CmdAddFile>({"store", "add-file"});
 static auto rCmdAddPath = registerCommand2<CmdAddPath>({"store", "add-path"});
+static auto rCmdAdd = registerCommand2<CmdAdd>({"store", "add"});
diff --git a/src/nix/add-path.md → src/nix/add.md b/src/nix/add-path.md → src/nix/add.md
@@ -19,7 +19,7 @@ Add a directory to the store:
 # mkdir dir
 # echo foo > dir/bar
 
-# nix store add-path ./dir
+# nix store add ./dir
 /nix/store/6pmjx56pm94n66n4qw1nff0y1crm8nqg-dir
 
 # cat /nix/store/6pmjx56pm94n66n4qw1nff0y1crm8nqg-dir/bar

diff --git a/tests/functional/add.sh b/tests/functional/add.sh
@@ -26,3 +26,20 @@ hash2=$(nix-hash --type sha256 --base32 ./dummy)
 echo $hash2
 
 test "$hash1" = "sha256:$hash2"
+
+#### New style commands
+
+clearStore
+
+(
+    path1=$(nix store add ./dummy)
+    path2=$(nix store add --mode nar ./dummy)
+    path3=$(nix store add-path ./dummy)
+    [[ "$path1" == "$path2" ]]
+    [[ "$path1" == "$path3" ]]
+)
+(
+    path1=$(nix store add --mode flat ./dummy)
+    path2=$(nix store add-file ./dummy)
+    [[ "$path1" == "$path2" ]]
+)