diff mbox series

[bug#71263,1/5] doc: Minor changes to the OCI-backed Services documentation.

Message ID 31ff6a93a8c7b50e5152f75b091b28851d5c4cc8.1717018735.git.goodoldpaul@autistici.org
State New
Headers show
Series [bug#71263,1/5] doc: Minor changes to the OCI-backed Services documentation. | expand

Commit Message

Giacomo Leidi May 29, 2024, 9:38 p.m. UTC
* doc/guix.texi: Clarify the example and remove reduntant escapes.

Change-Id: I38f5517ae46b391ba21ae5a94c6dcc272e245036
---
 doc/guix.texi | 14 ++++++--------
 1 file changed, 6 insertions(+), 8 deletions(-)


base-commit: 6f72ad465c1e2df965e8d73b209497b4ef456527
diff mbox series

Patch

diff --git a/doc/guix.texi b/doc/guix.texi
index c1ff049f03..8662586b46 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -40547,6 +40547,7 @@  Miscellaneous Services
 (service oci-container-service-type
          (list
           (oci-container-configuration
+           (network "host")
            (image
             (oci-image
              (repository "guile")
@@ -40559,20 +40560,17 @@  Miscellaneous Services
             '("-c" "(display \"hello!\n\")")))
           (oci-container-configuration
            (image "prom/prometheus")
-           (network "host")
            (ports
              '(("9000" . "9000")
                ("9090" . "9090"))))
           (oci-container-configuration
            (image "grafana/grafana:10.0.1")
            (network "host")
-           (ports
-             '(("3000" . "3000")))
            (volumes
              '("/var/lib/grafana:/var/lib/grafana")))))
 @end lisp
 
-In this example two different Shepherd services are going be added to the
+In this example three different Shepherd services are going be added to the
 system.  Each @code{oci-container-configuration} record translates to a
 @code{docker run} invocation and its fields directly map to options.  You can
 refer to the
@@ -40580,8 +40578,8 @@  Miscellaneous Services
 documentation for the semantics of each value.  If the images are not found they
 will be
 @url{https://docs.docker.com/engine/reference/commandline/pull/,pulled}.  The
-spawned services are going to be attached to the host network and are supposed
-to behave like other processes.
+services with @code{(network "host")} are going to be attached to the host network
+and are supposed to behave like native processes with regard to networking.
 
 @end defvar
 
@@ -40613,8 +40611,8 @@  Miscellaneous Services
 value can be a list of pairs or strings, even mixed:
 
 @lisp
-(list '(\"LANGUAGE\" . \"eo:ca:eu\")
-      \"JAVA_HOME=/opt/java\")
+(list '("LANGUAGE\" . "eo:ca:eu")
+      "JAVA_HOME=/opt/java")
 @end lisp
 
 Pair members can be strings, gexps or file-like objects. Strings are passed