Re: [PATCH v4 2/4] man/man5/tunables.conf: Document system-wide tunables config

DJ Delorie <[email protected]>
Newsgroups org.kernel.vger.linux-man
Message-ID <[email protected]>
Alejandro Colomar <[email protected]> writes:

> Hmmmm, let's see.  I couldn't do it in five words, but how about this
> schematic approach?
>
> 	The file may also contain
> 	.IR filters ,
> 	which limit the tunables following it,
> 	The effects of a filter are terminated by
> 	any of the following:
> 	.IP \[bu] 3
> 	The end of the file.
> 	.IP \[bu]
> 	The end of an included file.
> 	.IP \[bu]
> 	An
> 	.B include
> 	directive.
> 	.IP \[bu]
> 	A new (possibly empty) filter.

I like it as-is, other than "why are there blank lines" but I don't care
about that ;-)

> Since a filter can be empty, we should document that.  If we document
> that 'filter:pattern' is optional, it'd be [[filter:pattern]] (with the
> appropriate formatting differences: the inner '[' wouldn't be bold).
> However, that's likely to be confusing, so let's document that
> separately:
>
> 	A filter can also be empty:
> 	.BR [] .
> 	Such a filter has no effects.

Done.  I put it after the filter list, so the "also" made sense.
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.