diff mbox series

[bug#41180] Add cachefilesd service.

Message ID 87o8qvzj2p.fsf@m4x.org
State New
Headers show
Series [bug#41180] Add cachefilesd service. | expand


Context Check Description
cbaines/comparison success View comparision
cbaines/git branch success View Git branch
cbaines/applying patch fail View Laminar job

Commit Message

Jean-Baptiste Note May 10, 2020, 7:27 p.m. UTC
Documentation patch.
diff mbox series


From b169047ad64996860e6eb154bb4d20ad80463b47 Mon Sep 17 00:00:00 2001
From: Jean-Baptiste Note <jean-baptiste.note@m4x.org>
Date: Sun, 10 May 2020 18:43:08 +0000
Subject: [PATCH 2/2] doc: Add documentation for cachefilesd-service.

* doc/guix.texi (Linux Services): Add a new subsection and document the
cachefilesd service and its configuration.
 doc/guix.texi | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)

diff --git a/doc/guix.texi b/doc/guix.texi
index 0cba0ee1ec..4aaec43739 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -25724,6 +25724,41 @@  parameters, can be done as follow:
 @end lisp
 @end deffn
+@cindex cachefilesd
+@cindex cachefiles
+@cindex fscache
+@subsubheading cachefilesd Service
+The cachefilesd service allows one to load start @code{cachefilesd} for
+caching network filesystem data on local disks.  This is especially
+useful for NFS and AFS shares, reducing read latency.
+@deffn {Scheme Variable} cachefilesd-service-type
+The service type for starting cachefilesd.  For example starting the
+cachefiles daemon can be done as follow:
+(use-modules (gnu) (gnu services))
+(use-package-modules linux)
+(use-service-modules linux)
+  ...
+  (services
+    (cons*
+      (service cachefilesd-service-type
+        (cachefilesd-configuration
+          (dir "/var/cache/fscache") ; the default value
+          (syslog? #f)               ; don't require syslogd
+          (secctx "cachefiles_kernel_t")
+          (tag "mycache")
+          (brun 10)
+          (bcull 7)
+          (bstop 3)))
+       %base-services)))
+@end lisp
+@end deffn
 @node Miscellaneous Services
 @subsection Miscellaneous Services