On Mon, Mar 22, 2021 at 07:08:32AM GMT, Jason McIntyre wrote:
> On Sun, Mar 21, 2021 at 10:58:02PM +0000, Raf Czlonka wrote:
> >
> > Hi Laurie,
> >
> > I'd simply use the existing wording, without getting into details.
> >
> > While there, "braces" dominate the manual page, with a single
> > occurrence of "brackets" so let's change that too, for consistency.
> >
> > Regards,
> >
> > Raf
> >
Hi Jason,
> hi. i could have sworn i recently discussed this documenting of multiple
> options with someone else, but cannot find the mails. anyway, a couple
> of points:
>
> - "a block of options that is enclosed in curly braces" can be shortened to
> "a block of options enclosed in curly braces". up to you.
Yup.
> - if it is generally true that where multiple options can be given they
> are specified in the same way (curly braces) then it would be better
> just to say up front that this is the case, rather than repeating the
> text endlessly everywhere it's possible.
I did think about it as there's a lot of repetition:
$ grep '^Multiple options' /usr/share/man/man5/httpd.conf.5
Multiple options may be specified within curly braces.
Multiple options may be specified within curly braces.
Multiple options may be specified within curly braces.
Multiple options may be specified within curly braces.
Multiple options may be specified within curly braces.
Multiple options may be specified within curly braces.
but wanted the diff to be as small as possible ;^)
> in other respects i'm fine with the diff.
> jmc
How about this?
Cheers,
Raf
Index: usr.sbin/httpd/httpd.conf.5
===================================================================
RCS file: /cvs/src/usr.sbin/httpd/httpd.conf.5,v
retrieving revision 1.114
diff -u -p -r1.114 httpd.conf.5
--- usr.sbin/httpd/httpd.conf.5 29 Oct 2020 12:30:52 -0000 1.114
+++ usr.sbin/httpd/httpd.conf.5 22 Mar 2021 13:24:58 -0000
@@ -78,6 +78,8 @@ the comment is effective until the end o
Argument names not beginning with a letter, digit, or underscore
must be quoted.
.Pp
+Multiple options may be specified within curly braces.
+.Pp
Additional configuration files can be included with the
.Ic include
keyword, for example:
@@ -155,7 +157,7 @@ see
.Xr patterns 7 .
.El
.Pp
-Followed by a block of options that is enclosed in curly brackets:
+Followed by a block of options enclosed in curly braces:
.Bl -tag -width Ds
.It Ic alias Ar name
Specify an additional alias
@@ -238,7 +240,6 @@ option.
.El
.It Ic connection Ar option
Set the specified options and limits for HTTP connections.
-Multiple options may be specified within curly braces.
Valid options are:
.Bl -tag -width Ds
.It Ic max request body Ar number
@@ -265,7 +266,6 @@ Set the default media type for the speci
overwriting the global setting.
.It Ic directory Ar option
Set the specified options when serving or accessing directories.
-Multiple options may be specified within curly braces.
Valid options are:
.Bl -tag -width Ds
.It Oo Ic no Oc Ic auto index
@@ -451,7 +451,6 @@ but can be changed per server or locatio
Use the
.Ic no log
directive to disable logging of any requests.
-Multiple options may be specified within curly braces.
Valid options are:
.Bl -tag -width Ds
.It Ic access Ar name
@@ -509,7 +508,6 @@ Disable any previous
in a location.
.It Ic request Ar option
Configure the options for the request path.
-Multiple options may be specified within curly braces.
Valid options are:
.Bl -tag -width Ds
.It Oo Ic no Oc Ic rewrite Ar path
@@ -547,7 +545,6 @@ Enable or disable the specified TCP/IP o
and
.Xr ip 4
for more information about the options.
-Multiple options may be specified within curly braces.
Valid options are:
.Bl -tag -width Ds
.It Ic backlog Ar number
@@ -577,7 +574,6 @@ This will affect the TCP window size.
.It Ic tls Ar option
Set the TLS configuration for the server.
These options are only used if TLS has been enabled via the listen directive.
-Multiple options may be specified within curly braces.
Valid options are:
.Bl -tag -width Ds
.It Ic certificate Ar file
