summary refs log tree commit diff
diff options
context:
space:
mode:
authorTomas Volf <~@wolfsden.cz>2024-06-20 15:31:15 +0200
committerMaxim Cournoyer <maxim.cournoyer@gmail.com>2024-06-24 08:51:45 -0400
commitfc921acbef5a3864d525020afe524ccc8d66b4b5 (patch)
treeff3deb96e68f1354a528cd3b4e745642c875e11e
parent6e33f0d887feb6bb2898b00a8c1b7839f6b27e49 (diff)
downloadguix-fc921acbef5a3864d525020afe524ccc8d66b4b5.tar.gz
doc: Improve description of nginx's configuration.
* doc/guix.texi (Web Services)[nginx-server-configuration]: Document semantics
of raw-content field.
[nginx-location-configuration]: Document semantics of body field.

Change-Id: I1e699d085a27f2615190de1e1973146da4ab193d
Signed-off-by: Maxim Cournoyer <maxim.cournoyer@gmail.com>
-rw-r--r--doc/guix.texi16
1 files changed, 10 insertions, 6 deletions
diff --git a/doc/guix.texi b/doc/guix.texi
index 0ad0a23b6c..fd19245539 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -32127,7 +32127,9 @@ you don't have a key or you don't want to use HTTPS.
 Whether the server should add its configuration to response.
 
 @item @code{raw-content} (default: @code{'()})
-A list of raw lines added to the server block.
+A list of strings or file-like objects to be appended to the server
+block.  Each item is prefixed with indentation and suffixed with a new
+line.  Nested lists are flattened.
 
 @end table
 @end deftp
@@ -32164,11 +32166,13 @@ URI which this location block matches.
 
 @anchor{nginx-location-configuration body}
 @item @code{body}
-Body of the location block, specified as a list of strings.  This can contain
-many
-configuration directives.  For example, to pass requests to a upstream
-server group defined using an @code{nginx-upstream-configuration} block,
-the following directive would be specified in the body @samp{(list "proxy_pass
+Body of the location block, specified as a list of strings or file-like
+objects.  Each item is prefixed with indentation and suffixed with a new
+line.  Nested lists are flattened.
+
+For example, to pass requests to a upstream server group defined using
+an @code{nginx-upstream-configuration} block, the following directive
+would be specified in the body @samp{(list "proxy_pass
 http://upstream-name;")}.
 
 @end table