mirror of
https://github.com/NixOS/nix.git
synced 2024-11-25 16:23:02 +00:00
nix add-to-store: Move markdown docs into a separate file
This commit is contained in:
parent
c3c858ac6d
commit
1b0ca3866b
@ -38,30 +38,9 @@ struct CmdAddToStore : MixDryRun, StoreCommand
|
|||||||
|
|
||||||
std::string doc() override
|
std::string doc() override
|
||||||
{
|
{
|
||||||
return R"(
|
return
|
||||||
# Description
|
#include "add-to-store.md"
|
||||||
|
;
|
||||||
Copy the file or directory *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 regular file to the store:
|
|
||||||
|
|
||||||
```console
|
|
||||||
# echo foo > bar
|
|
||||||
# nix add-to-store --flat ./bar
|
|
||||||
/nix/store/cbv2s4bsvzjri77s2gb8g8bpcb6dpa8w-bar
|
|
||||||
# cat /nix/store/cbv2s4bsvzjri77s2gb8g8bpcb6dpa8w-bar
|
|
||||||
foo
|
|
||||||
```
|
|
||||||
)";
|
|
||||||
}
|
}
|
||||||
|
|
||||||
Category category() override { return catUtility; }
|
Category category() override { return catUtility; }
|
||||||
|
28
src/nix/add-to-store.md
Normal file
28
src/nix/add-to-store.md
Normal file
@ -0,0 +1,28 @@
|
|||||||
|
R""(
|
||||||
|
|
||||||
|
# Description
|
||||||
|
|
||||||
|
Copy the file or directory *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 regular file to the store:
|
||||||
|
|
||||||
|
```console
|
||||||
|
# echo foo > bar
|
||||||
|
|
||||||
|
# nix add-to-store --flat ./bar
|
||||||
|
/nix/store/cbv2s4bsvzjri77s2gb8g8bpcb6dpa8w-bar
|
||||||
|
|
||||||
|
# cat /nix/store/cbv2s4bsvzjri77s2gb8g8bpcb6dpa8w-bar
|
||||||
|
foo
|
||||||
|
```
|
||||||
|
|
||||||
|
)""
|
Loading…
Reference in New Issue
Block a user