GNU bug report logs - #71677
[PATCH] doc: Improve description of nginx's configuration

Previous Next

Full log

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Tomas Volf <~@wolfsden.cz>
To: guix-patches <at> gnu.org
Cc: Tomas Volf <~@wolfsden.cz>
Subject: [PATCH] doc: Improve description of nginx's configuration
Date: Thu, 20 Jun 2024 15:31:15 +0200

The description did not fully match the actual observable behavior, so let us
fix that.

* 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
---
 doc/guix.texi | 16 ++++++++++------
 1 file changed, 10 insertions(+), 6 deletions(-)

diff --git a/doc/guix.texi b/doc/guix.texi
index f6f2788ed2..7f10bef58d 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -32073,7 +32073,9 @@ Web Services
 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
@@ -32119,11 +32121,13 @@ Web Services
 
 @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
-- 
2.45.1

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.