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

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 71677 in the body.
You can then email your comments to 71677 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

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

Message #10 received at 71677-done <at> debbugs.gnu.org (full text, mbox):

From: Maxim Cournoyer <maxim.cournoyer <at> gmail.com>
To: Tomas Volf <~@wolfsden.cz>
Cc: Ludovic Courtès <ludo <at> gnu.org>, 71677-done <at> debbugs.gnu.org,
 Matthew Trzcinski <matt <at> excalamus.com>,
 Florian Pelz <pelzflorian <at> pelzflorian.de>
Subject: Re: [bug#71677] [PATCH] doc: Improve description of nginx's
 configuration
Date: Sun, 23 Jun 2024 23:58:42 -0400

Hi,

Tomas Volf <~@wolfsden.cz> writes:

> 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

Applied, thanks.

-- 
Maxim

Previous Next

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