nixo
/
guix-devel
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

doc: Clarify some of guix-daemon's GC options. 

Reported by Pierre Neidhardt <ambrevar@gmail.com>.

* doc/guix.texi (Invoking guix-daemon): Fix an incorrect statement
regarding --gc-keep-outputs.  Add a little to the description of this
option and --gc-keep-derivations.
This commit is contained in:
Chris Marusich 2018-07-28 02:50:06 -07:00
parent b15a020dd5
commit 346a632144
No known key found for this signature in database
GPG Key ID: DD409A15D822469D
1 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
doc/guix.texi
View File

@ -1375,8 +1375,8 @@ derivations.
@cindex garbage collector roots @cindex garbage collector roots
When set to ``yes'', the GC will keep the outputs of any live derivation When set to ``yes'', the GC will keep the outputs of any live derivation
available in the store---the @code{.drv} files. The default is ``no'', available in the store---the @code{.drv} files. The default is ``no'',
meaning that derivation outputs are kept only if they are GC roots. meaning that derivation outputs are kept only if they are reachable from a GC
@xref{Invoking guix gc}, for more on GC roots. root. @xref{Invoking guix gc}, for more on GC roots.
@item --gc-keep-derivations[=yes|no] @item --gc-keep-derivations[=yes|no]
Tell whether the garbage collector (GC) must keep derivations Tell whether the garbage collector (GC) must keep derivations
@ -1387,12 +1387,13 @@ derivations---i.e., @code{.drv} files---as long as at least one of their
outputs is live. This allows users to keep track of the origins of outputs is live. This allows users to keep track of the origins of
items in their store. Setting it to ``no'' saves a bit of disk space. items in their store. Setting it to ``no'' saves a bit of disk space.
Note that when both @code{--gc-keep-derivations} and In this way, setting @code{--gc-keep-derivations} to ``yes'' causes liveness
@code{--gc-keep-outputs} are used, the effect is to keep all the build to flow from outputs to derivations, and setting @code{--gc-keep-outputs} to
prerequisites (the sources, compiler, libraries, and other build-time ``yes'' causes liveness to flow from derivations to outputs. When both are
tools) of live objects in the store, regardless of whether these set to ``yes'', the effect is to keep all the build prerequisites (the
prerequisites are live. This is convenient for developers since it sources, compiler, libraries, and other build-time tools) of live objects in
saves rebuilds or downloads. the store, regardless of whether these prerequisites are reachable from a GC
root. This is convenient for developers since it saves rebuilds or downloads.
@item --impersonate-linux-2.6 @item --impersonate-linux-2.6
On Linux-based systems, impersonate Linux 2.6. This means that the On Linux-based systems, impersonate Linux 2.6. This means that the