Re: [PATCH] nginx.conf(5): Less EXAMPLES, more HISTORY
Hi Donovan, Donovan Watteau wrote on Sat, Jan 11, 2014 at 04:18:59PM +0100: OpenBSD now provides an nginx.conf(5) manual page and I love this, thanks! But it ends with an EXAMPLES section which only deals with some horrible use of whitespace, which is not recommended. I don't get it. This manpage is a relief, but it ends in a really sad and not really useful way... Oh, i forgot to mention what the point is. The DESCRIPTION contains a description of the grammar. The only thing about the grammer that is really tricky is the whitespace rules. The rest doesn't really need examples for clarification, in particular since the documentation of individual directives already provide plenty. Anyway, i didn't remove the example, i consider it helpful for understanding the whitespace rules more easily, even though you are not supposed to use them in that way. I'd rather see a mention that this manpage is an OpenBSD improvement! I just added some text to that effect, thanks for pointing out that HISTORY and AUTHORS were missing. Yours, Ingo
[PATCH] nginx.conf(5): Less EXAMPLES, more HISTORY
OpenBSD now provides an nginx.conf(5) manual page and I love this,
thanks!
But it ends with an EXAMPLES section which only deals with some
horrible use of whitespace, which is not recommended. I don't
get it. This manpage is a relief, but it ends in a really sad
and not really useful way... I'd rather see a mention that this
manpage is an OpenBSD improvement!
Index: nginx.conf.5
===
RCS file: /cvs/src/usr.sbin/nginx/man/nginx.conf.5,v
retrieving revision 1.6
diff -u -p -r1.6 nginx.conf.5
--- nginx.conf.516 Dec 2013 11:19:03 - 1.6
+++ nginx.conf.511 Jan 2014 15:08:32 -
@@ -8722,17 +8722,8 @@ text/html.
.El
.Sh FILES
.Pa /etc/nginx/nginx.conf
-.Sh EXAMPLES
-The following is a valid configuration file, but such creative use
-of whitespace is not recommended:
-.Bd -offset indent -literal
-worker_processes #whitespace is required here
-auto
-#a comment is allowed here
-;events{}user #whitespace is again required here
-www
-#and here, too
-www;# but not here
-.Ed
.Sh SEE ALSO
.Xr nginx 8
+.Sh HISTORY
+This manual page first appeared in
+.Ox 5.5 .
Re: [PATCH] nginx.conf(5): Less EXAMPLES, more HISTORY
Hi Donovan, Donovan Watteau wrote on Sat, Jan 11, 2014 at 04:18:59PM +0100: OpenBSD now provides an nginx.conf(5) manual page and I love this, thanks! Florian, who did all the work on the formatting, will no doubt enjoy that statement. :) But it ends with an EXAMPLES section which only deals with some horrible use of whitespace, which is not recommended. I don't get it. This manpage is a relief, but it ends in a really sad and not really useful way... I'd rather see a mention that this manpage is an OpenBSD improvement! Heh... You propose to remove one of the two parts of the text that was originally written for OpenBSD (by me, actually) and in the same patch, you propose to claim this page as an OpenBSD invention. That's kind of contradictory. ;-) Almost all of the text comes from upstream: http://nginx.org/en/docs/#development For that reason, i object to the wording first appeared in, it is misleading. However, if somebody wants to commit something like the following, that would be fine with me. Yours, Ingo Index: nginx.conf.5 === RCS file: /cvs/src/usr.sbin/nginx/man/nginx.conf.5,v retrieving revision 1.6 diff -u -p -r1.6 nginx.conf.5 --- nginx.conf.516 Dec 2013 11:19:03 - 1.6 +++ nginx.conf.511 Jan 2014 17:53:49 - @@ -8736,3 +8736,17 @@ www;# but not here .Ed .Sh SEE ALSO .Xr nginx 8 +.Sh HISTORY +This manual has been available since +.Ox 5.5 . +.Sh AUTHORS +.An -nosplit +The bulk of the text was semi-automatically converted +from the XML sources of +.Lk http://nginx.org/en/docs/#development +to +.Xr mdoc 7 +by +.An Florian Obser Aq Mt flor...@openbsd.org . +The description of the grammar was written by +.An Ingo Schwarze Aq Mt schwa...@openbsd.org .
