Skip to content

Commit 5230d3e

Browse files
Document --max-freed for nix-collect-garbage (#12155)
* Update nix-collect-garbage.md Referencing issue at: #12132 Copied the description of `--max-freed` option from https://github.com/NixOS/nix/blob/442a2623e48357ff72c77bb11cf2cf06d94d2f90/doc/manual/source/command-ref/nix-store/gc.md?plain=1#L39-L44
1 parent 8bec777 commit 5230d3e

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

doc/manual/source/command-ref/nix-collect-garbage.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,15 @@ These options are for deleting old [profiles] prior to deleting unreachable [sto
6262
This is the equivalent of invoking [`nix-env --delete-generations <period>`](@docroot@/command-ref/nix-env/delete-generations.md#generations-time) on each found profile.
6363
See the documentation of that command for additional information about the *period* argument.
6464

65+
- <span id="opt-max-freed">[`--max-freed`](#opt-max-freed)</span> *bytes*
66+
67+
<!-- duplication from https://github.com/NixOS/nix/blob/442a2623e48357ff72c77bb11cf2cf06d94d2f90/doc/manual/source/command-ref/nix-store/gc.md?plain=1#L39-L44 -->
68+
69+
Keep deleting paths until at least *bytes* bytes have been deleted,
70+
then stop. The argument *bytes* can be followed by the
71+
multiplicative suffix `K`, `M`, `G` or `T`, denoting KiB, MiB, GiB
72+
or TiB units.
73+
6574
{{#include ./opt-common.md}}
6675

6776
{{#include ./env-common.md}}

0 commit comments

Comments
 (0)