diff options
author | Eelco Dolstra <edolstra@gmail.com> | 2020-12-09 23:54:11 +0100 |
---|---|---|
committer | Eelco Dolstra <edolstra@gmail.com> | 2020-12-21 13:32:28 +0100 |
commit | cb25a89f1cb9b3a26d84b3429b309be2cfa513a6 (patch) | |
tree | a1290260478b99e8b6f6fc7a14faef65cfe0cb47 /src | |
parent | 8dd7d7e9db8165c316b1ef168f57ed3632507fe2 (diff) |
Add 'nix store optimise' manpage
Diffstat (limited to 'src')
-rw-r--r-- | src/nix/optimise-store.cc | 11 | ||||
-rw-r--r-- | src/nix/optimise-store.md | 23 |
2 files changed, 27 insertions, 7 deletions
diff --git a/src/nix/optimise-store.cc b/src/nix/optimise-store.cc index bc7f175ac..985006e5a 100644 --- a/src/nix/optimise-store.cc +++ b/src/nix/optimise-store.cc @@ -13,14 +13,11 @@ struct CmdOptimiseStore : StoreCommand return "replace identical files in the store by hard links"; } - Examples examples() override + std::string doc() override { - return { - Example{ - "To optimise the Nix store:", - "nix store optimise" - }, - }; + return + #include "optimise-store.md" + ; } void run(ref<Store> store) override diff --git a/src/nix/optimise-store.md b/src/nix/optimise-store.md new file mode 100644 index 000000000..f6fb66f97 --- /dev/null +++ b/src/nix/optimise-store.md @@ -0,0 +1,23 @@ +R""( + +# Examples + +* Optimise the Nix store: + + ```console + nix store optimise + ``` + +# Description + +This command deduplicates the Nix store: it scans the store for +regular files with identical contents, and replaces them with hard +links to a single instance. + +Note that you can also set `auto-optimise-store` to `true` in +`nix.conf` to perform this optimisation incrementally whenever a new +path is added to the Nix store. To make this efficient, Nix maintains +a content-addressed index of all the files in the Nix store in the +directory `/nix/store/.links/`. + +)"" |