summary refs log tree commit diff
diff options
context:
space:
mode:
authorBruno Victal <mirai@makinata.eu>2023-01-03 14:07:49 +0000
committerLudovic Courtès <ludo@gnu.org>2023-01-10 11:49:13 +0100
commit22e9b01bdaa8184aa08f03542798750bc587b457 (patch)
tree139a80ab31906e53dfab2cb2c073408bae105604
parent7ebeafff15f052cb69758be4792ca2715c7d573d (diff)
downloadguix-22e9b01bdaa8184aa08f03542798750bc587b457.tar.gz
services: git-daemon: Deprecate 'git-daemon-service' procedure.
* gnu/services/version-control.scm
(git-daemon-service): Define with 'define-deprecated'
* doc/guix.texi (Version Control Services): Replace with
'git-daemon-service-type'

Signed-off-by: Ludovic Courtès <ludo@gnu.org>
-rw-r--r--doc/guix.texi25
-rw-r--r--gnu/services/version-control.scm4
2 files changed, 14 insertions, 15 deletions
diff --git a/doc/guix.texi b/doc/guix.texi
index aef3890298..11a4ca18fb 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -34907,27 +34907,24 @@ How often to run the node cleaning job.  The default is once per day, at
 
 The @code{(gnu services version-control)} module provides a service to
 allow remote access to local Git repositories.  There are three options:
-the @code{git-daemon-service}, which provides access to repositories via
+the @code{git-daemon-service-type}, which provides access to repositories via
 the @code{git://} unsecured TCP-based protocol, extending the
 @code{nginx} web server to proxy some requests to
 @code{git-http-backend}, or providing a web interface with
 @code{cgit-service-type}.
 
-@deffn {Scheme Procedure} git-daemon-service [#:config (git-daemon-configuration)]
-
-Return a service that runs @command{git daemon}, a simple TCP server to
+@defvar git-daemon-service-type
+Type for a service that runs @command{git daemon}, a simple TCP server to
 expose repositories over the Git protocol for anonymous access.
 
-The optional @var{config} argument should be a
-@code{<git-daemon-configuration>} object, by default it allows read-only
-access to exported@footnote{By creating the magic file
-@file{git-daemon-export-ok} in the repository directory.} repositories under
-@file{/srv/git}.
-
-@end deffn
+The value for this service type is a @code{<git-daemon-configuration>}
+record, by default it allows read-only access to exported@footnote{By
+creating the magic file @file{git-daemon-export-ok} in the repository
+directory.} repositories under @file{/srv/git}.
+@end defvar
 
 @deftp {Data Type} git-daemon-configuration
-Data type representing the configuration for @code{git-daemon-service}.
+Data type representing the configuration for @code{git-daemon-service-type}.
 
 @table @asis
 @item @code{package} (default: @code{git})
@@ -34964,8 +34961,8 @@ Whether to listen on an alternative port, which defaults to 9418.
 If not empty, only allow access to this list of directories.
 
 @item @code{extra-options} (default: @code{'()})
-Extra options will be passed to @command{git daemon}, please run
-@command{man git-daemon} for more information.
+Extra options that will be passed to @command{git daemon}.@footnote{Run
+@command{man git-daemon} for more information.}
 
 @end table
 @end deftp
diff --git a/gnu/services/version-control.scm b/gnu/services/version-control.scm
index 86d40bdbe3..14ff0a59a6 100644
--- a/gnu/services/version-control.scm
+++ b/gnu/services/version-control.scm
@@ -29,6 +29,7 @@
   #:use-module (gnu system shadow)
   #:use-module (gnu packages version-control)
   #:use-module (gnu packages admin)
+  #:use-module (guix deprecation)
   #:use-module (guix records)
   #:use-module (guix gexp)
   #:use-module (guix store)
@@ -178,7 +179,8 @@
 protocol.")
    (default-value (git-daemon-configuration))))
 
-(define* (git-daemon-service #:key (config (git-daemon-configuration)))
+(define-deprecated (git-daemon-service #:key (config (git-daemon-configuration)))
+  git-daemon-service-type
   "Return a service that runs @command{git daemon}, a simple TCP server to
 expose repositories over the Git protocol for anonymous access.