Add 'nix store optimise' manpage
This commit is contained in:
parent
8dd7d7e9db
commit
cb25a89f1c
2 changed files with 27 additions and 7 deletions
|
@ -13,14 +13,11 @@ struct CmdOptimiseStore : StoreCommand
|
||||||
return "replace identical files in the store by hard links";
|
return "replace identical files in the store by hard links";
|
||||||
}
|
}
|
||||||
|
|
||||||
Examples examples() override
|
std::string doc() override
|
||||||
{
|
{
|
||||||
return {
|
return
|
||||||
Example{
|
#include "optimise-store.md"
|
||||||
"To optimise the Nix store:",
|
;
|
||||||
"nix store optimise"
|
|
||||||
},
|
|
||||||
};
|
|
||||||
}
|
}
|
||||||
|
|
||||||
void run(ref<Store> store) override
|
void run(ref<Store> store) override
|
||||||
|
|
23
src/nix/optimise-store.md
Normal file
23
src/nix/optimise-store.md
Normal file
|
@ -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/`.
|
||||||
|
|
||||||
|
)""
|
Loading…
Reference in a new issue