summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorYarl Baudig <yarl-baudig@mailoo.org>2026-03-14 13:22:58 +0100
committerIan Eure <ian@retrospec.tv>2026-03-21 19:01:26 -0700
commite931cab87fef3159511a6f425e5cddbeb8b06c96 (patch)
treeaa60487c2bc75e94b5baa874f8efb1ccc8b349e2 /doc
parent61849b667726dd30d623b517380f5b12655b115a (diff)
gnu: home: services: Add home-git-annex-assistant-service-type
* gnu/home/services/git-annex-assistant.scm: New file. * gnu/local/mk (GNU_SYSTEM_MODULES): Register it. * doc/guix.texi (Miscellaneous Services): Document it. Change-Id: I9ca75210dfe7f6d2d81b9eb8919d6eb34c7bb002 Signed-off-by: Ian Eure <ian@retrospec.tv>
Diffstat (limited to 'doc')
-rw-r--r--doc/guix.texi40
1 files changed, 40 insertions, 0 deletions
diff --git a/doc/guix.texi b/doc/guix.texi
index d5f782f35c..f4279bfb79 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -150,6 +150,7 @@ Copyright @copyright{} 2025 dan@*
Copyright @copyright{} 2025 Noé Lopez@*
Copyright @copyright{} 2026 David Elsing@*
Copyright @copyright{} 2026 Nguyễn Gia Phong@*
+Copyright @copyright{} 2026 Yarl Baudig@*
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
@@ -55053,6 +55054,45 @@ You may specify a custom configuration by providing a
'(("grafana:/var/lib/grafana"))))))))
@end lisp
+@subsubheading git-annex assistant Service
+
+@cindex git-annex assistant service
+The @code{(gnu home services git-annex-assistant)} module provides a
+service to run the @uref{https://git-annex.branchable.com/assistant/,
+git-annex assistant}.
+
+@defvar home-git-annex-assistant-service-type
+This is the type of the service that runs the assistant. You must
+supply a @code{<home-git-annex-assistant-configuration>}.
+
+The service runs one assistant for each directory provided. For
+example:
+
+@lisp
+(service home-git-annex-assistant-service-type
+ (home-git-annex-assistant-configuration
+ (directories '("/path/to/foo" "/path/to/bar"))))
+@end lisp
+@end defvar
+
+@c %start of fragment
+
+@deftp {Data Type} home-git-annex-assistant-configuration
+Available @code{home-git-annex-assistant-configuration} fields are:
+
+@table @asis
+@item @code{package} (default: @code{git-annex}) (type: package)
+Package that provides @code{git-annex}.
+
+@item @code{directories} (default: @code{()}) (type: list-of-strings)
+List of directories.
+
+@end table
+
+@end deftp
+
+@c %end of fragment
+
@node Invoking guix home
@section Invoking @command{guix home}