[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
01/02: doc: Document 'guix-publish-service-type' instead of 'guix-publis
From: |
Ludovic Courtès |
Subject: |
01/02: doc: Document 'guix-publish-service-type' instead of 'guix-publish-service'. |
Date: |
Thu, 23 Mar 2017 19:23:39 -0400 (EDT) |
civodul pushed a commit to branch master
in repository guix.
commit f1e900a3b8267846eb3909fbf86e681cbc56203d
Author: Ludovic Courtès <address@hidden>
Date: Thu Mar 23 14:00:29 2017 +0100
doc: Document 'guix-publish-service-type' instead of 'guix-publish-service'.
* doc/guix.texi (Base Services): Document 'guix-publish-service-type'
and 'guix-configuration'. Remove 'guix-publish-service'.
(Invoking guix publish): Mention 'guix-publish-service-type'.
* gnu/services/base.scm (guix-publish-service): Mark as deprecated.
(<guix-configuration>): Export getters.
---
doc/guix.texi | 33 +++++++++++++++++++++++++--------
gnu/services/base.scm | 4 ++++
2 files changed, 29 insertions(+), 8 deletions(-)
diff --git a/doc/guix.texi b/doc/guix.texi
index b57e219..b452b08 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -6551,9 +6551,9 @@ primarily for debugging a running @command{guix publish}
server.
@end table
Enabling @command{guix publish} on a GuixSD system is a one-liner: just
-add a call to @code{guix-publish-service} in the @code{services} field
-of the @code{operating-system} declaration (@pxref{guix-publish-service,
address@hidden).
+instantiate a @code{guix-publish-service-type} service in the @code{services}
field
+of the @code{operating-system} declaration (@pxref{guix-publish-service-type,
address@hidden).
If you are instead running Guix on a ``foreign distro'', follow these
instructions:â€
@@ -9007,17 +9007,34 @@ uses the @code{ps2} protocol, which works for both USB
and PS/2 mice.
This service is not part of @var{%base-services}.
@end deffn
address@hidden
address@hidden {Scheme Procedure} guix-publish-service [#:guix @var{guix}] @
- [#:port 80] [#:host "localhost"]
-Return a service that runs @command{guix publish} listening on @var{host}
-and @var{port} (@pxref{Invoking guix publish}).
address@hidden
address@hidden {Scheme Variable} guix-publish-service-type @var{config}
+This is the service type for @command{guix publish} (@pxref{Invoking
+guix publish}). @var{config} must be a @code{guix-configuration}
+object, as described below.
This assumes that @file{/etc/guix} already contains a signing key pair as
created by @command{guix archive --generate-key} (@pxref{Invoking guix
archive}). If that is not the case, the service will fail to start.
@end deffn
address@hidden {Data Type} guix-publish-configuration
+Data type representing the configuration of the @code{guix publish}
+service.
+
address@hidden @asis
address@hidden @code{guix} (default: @code{guix})
+The Guix package to use.
+
address@hidden @code{port} (default: @code{80})
+The TCP port to listen for connections.
+
address@hidden @code{host} (default: @code{"localhost"})
+The host (and thus, network interface) to listen to. Use
address@hidden"0.0.0.0"} to listen on all the network interfaces.
address@hidden table
address@hidden deftp
+
@anchor{rngd-service}
@deffn {Scheme Procedure} rngd-service [#:rng-tools @var{rng-tools}] @
[#:device "/dev/hwrng"]
diff --git a/gnu/services/base.scm b/gnu/services/base.scm
index 77efef1..0de83f3 100644
--- a/gnu/services/base.scm
+++ b/gnu/services/base.scm
@@ -124,6 +124,9 @@
guix-service-type
guix-publish-configuration
guix-publish-configuration?
+ guix-publish-configuration-guix
+ guix-publish-configuration-port
+ guix-publish-configuration-host
guix-publish-service
guix-publish-service-type
@@ -1475,6 +1478,7 @@ and @var{port} (@pxref{Invoking guix publish}).
This assumes that @file{/etc/guix} already contains a signing key pair as
created by @command{guix archive --generate-key} (@pxref{Invoking guix
archive}). If that is not the case, the service will fail to start."
+ ;; Deprecated.
(service guix-publish-service-type
(guix-publish-configuration (guix guix) (port port) (host host))))