From 0a220c1599613b7bee38c0bf8bc1bb3e9cbcaeb8 Mon Sep 17 00:00:00 2001 From: Ludovic Courtès Date: Sat, 22 Jun 2024 15:31:16 +0200 Subject: services: shepherd: Support “free-form” services. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * gnu/services/shepherd.scm ()[free-form]: New field. [start]: Add default value. (shepherd-service-file): Rename to… (shepherd-service-file/regular): … this. (shepherd-service-file/free-form): New procedure. (shepherd-service-file): Dispatch to one of the two procedures above. * doc/guix.texi (Shepherd Services): Document the ‘free-form’ field. Reviewed-by: Maxim Cournoyer Change-Id: I206374e950ef6d1e4a996c0f507fb5fcd9cadde3 --- doc/guix.texi | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/guix.texi b/doc/guix.texi index feecd2aa1c..9fbe890e5c 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -44088,7 +44088,7 @@ Services,,, shepherd, The GNU Shepherd Manual}, for details. When true, this is the delay in seconds before restarting a failed service. -@item @code{start} +@item @code{start} (default: @code{#~(const #t)}) @itemx @code{stop} (default: @code{#~(const #f)}) The @code{start} and @code{stop} fields refer to the Shepherd's facilities to start and stop processes (@pxref{Service De- and @@ -44107,6 +44107,30 @@ This is a list of @code{shepherd-action} objects (see below) defining herd @var{action} @var{service} [@var{arguments}@dots{}] @end example +@item @code{free-form} (default: @code{#f}) +When set, this field replaces the @code{start}, @code{stop}, and +@code{actions} fields. It is meant to be used when the service +definition comes from some other source, typically the service +collection provided by the Shepherd proper (@pxref{Service Collection,,, +shepherd, The GNU Shepherd Manual}). + +@cindex REPL service, for shepherd +For example, the snippet below defines a service for the Shepherd's +built-in @acronym{REPL, read-eval-print loop} service (@pxref{REPL +Service,,, shepherd, The GNU Shepherd Manual}): + +@lisp +(shepherd-service + (provision '(repl)) + (modules '((shepherd service repl))) + (free-form #~(repl-service))) +@end lisp + +In this case, the service object is returned by the @code{repl-service} +procedure of the Shepherd, so all the @code{free-form} G-expression does +is call that procedure. Note that the @code{provision} field must be +consistent with the actual service provision. + @item @code{auto-start?} (default: @code{#t}) Whether this service should be started automatically by the Shepherd. If it is @code{#f} the service has to be started manually with @code{herd start}. -- cgit v1.2.3