[PATCH] doc: Improve description of nginx's configuration

  • Done
  • quality assurance status badge
Details
2 participants
  • Maxim Cournoyer
  • Tomas Volf
Owner
unassigned
Submitted by
Tomas Volf
Severity
normal

Debbugs page

Tomas Volf wrote 9 months ago
(address . guix-patches@gnu.org)(name . Tomas Volf)(address . ~@wolfsden.cz)
6c59d93d9b22d0f5b83aa445faec7964d18d1f19.1718890275.git.~@wolfsden.cz
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(-)

Toggle diff (36 lines)
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
Maxim Cournoyer wrote 9 months ago
(name . Tomas Volf)(address . ~@wolfsden.cz)
87wmmf0z65.fsf@gmail.com
Hi,

Tomas Volf <~@wolfsden.cz> writes:

Toggle quote (9 lines)
> 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
Closed
?
Your comment

This issue is archived.

To comment on this conversation send an email to 71677@debbugs.gnu.org

To respond to this issue using the mumi CLI, first switch to it
mumi current 71677
Then, you may apply the latest patchset in this issue (with sign off)
mumi am -- -s
Or, compose a reply to this issue
mumi compose
Or, send patches to this issue
mumi send-email *.patch
You may also tag this issue. See list of standard tags. For example, to set the confirmed and easy tags
mumi command -t +confirmed -t +easy
Or, remove the moreinfo tag and set the help tag
mumi command -t -moreinfo -t +help