max/nix-super
1
0
Fork 0
mirror of https://github.com/privatevoid-net/nix-super.git synced 2024-11-10 08:16:15 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

nix add-to-store: Move markdown docs into a separate file

Browse source
This commit is contained in:
Eelco Dolstra 2020-12-03 14:23:18 +01:00
parent c3c858ac6d
commit 1b0ca3866b
2 changed files with 31 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
src/nix/add-to-store.cc
View file

@ -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
View 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
```
)""