summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorLudovic Courtès <ludo@gnu.org>2018-11-07 11:47:39 +0100
committerLudovic Courtès <ludo@gnu.org>2018-11-07 15:28:05 +0100
commitd4623d50edac4a6e81f5986a91c2818f5fc4965d (patch)
treec5e2bb5ed346a99d80d8f52debad62d89530af18 /doc
parentc5487cafabea43b8f1ed3ea5068a7463c15d813a (diff)
downloadcuirass-d4623d50edac4a6e81f5986a91c2818f5fc4965d.tar
cuirass-d4623d50edac4a6e81f5986a91c2818f5fc4965d.tar.gz
base: Register GC roots for build results.
Fixes <https://bugs.gnu.org/33124>. * src/cuirass/base.scm (%gc-root-directory, %gc-root-ttl): New variables. (gc-root-expiration-time, register-gc-root): New procedures. (handle-build-event)[gc-roots]: New procedure. Upon 'build-succeeded' events, call 'register-gc-root' and 'maybe-remove-expired-cache-entries'. * bin/cuirass.in (show-help, %options): Add '--ttl'. (main): Parameterize %GC-ROOT-TTL. Create %GC-ROOT-DIRECTORY. * doc/cuirass.texi (Invocation): Document '--ttl'.
Diffstat (limited to 'doc')
-rw-r--r--doc/cuirass.texi11
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/cuirass.texi b/doc/cuirass.texi
index 08ca832..ebb1fa5 100644
--- a/doc/cuirass.texi
+++ b/doc/cuirass.texi
@@ -203,6 +203,17 @@ build results. Since @code{cuirass} uses SQLite as a database engine,
@var{database} must be a file name. If the file doesn't exist, it will
be created.
+@item --ttl=@var{duration}
+Cuirass registers build results as garbage collector (GC) roots, thereby
+preventing them from being deleted by the GC. The @option{--ttl} option
+instructs it to keep those GC roots live for at least @var{duration}---e.g.,
+@code{1m} for one month, @code{2w} for two weeks, and so on. The default is
+30 days.
+
+Those GC roots are typically stored in
+@file{/var/guix/gcroots/per-user/@var{user}/cuirass}, where @var{user} is the
+user under which Cuirass is running.
+
@item --port=@var{num}
@itemx -p @var{num}
Make the HTTP interface listen on port @var{num}. Use port 8080 by