On Wed, Jun 15, 2011 at 11:16:18AM +0100, Jason McIntyre wrote:
> On Wed, Jun 15, 2011 at 11:09:35AM +0100, Stuart Henderson wrote:
> > On 2011/06/15 10:03, Jason McIntyre wrote:
> > > so i guess we're looking for a text only (i.e. no example) solution.
> > > here is another stab.
> >
> > nicely crafted words, this is good. ok sthen@
> >
> > I'll handle the other copies of this if you like.
> >
>
> i think it makes sense to do this in one commit, so i'd appreciate if
> you could do this one too.
>
> one thing for consideration: in the text below, i swithered whether
> "the comment takes effect" would read better as "the comment will take
> effect". i'm not sure which would be clearer (or read better) for most
> people.
Maybe "the comment remains in effect"?
But I think switching concepts from an "extended line" to
"block" is a bit fuzzy. I would prefer something like:
Take care when commenting out text which is part
of a multi-line block; the comment will in effect
comment out the remainder of the multi-line block,
unless the backslash is removed in the commented
out line as well.
- or -
Take care when commenting out text which is part
of a multi-line block; the comment will in effect
comment out the remainder of the multi-line block,
unless the backslash is also removed from the line
where the comment marker ('#') is introduced.
--patrick
> jmc
>
> > > Index: pf.conf.5
> > > ===================================================================
> > > RCS file: /cvs/src/share/man/man5/pf.conf.5,v
> > > retrieving revision 1.494
> > > diff -u -r1.494 pf.conf.5
> > > --- pf.conf.5 20 May 2011 22:57:20 -0000 1.494
> > > +++ pf.conf.5 15 Jun 2011 09:02:10 -0000
> > > @@ -62,9 +62,14 @@
> > > Some example rulesets.
> > > .El
> > > .Pp
> > > +The current line can be extended over multiple lines using a backslash
> > > +.Pq Sq \e .
> > > Comments can be put anywhere in the file using a hash mark
> > > .Pq Sq # ,
> > > and extend to the end of the current line.
> > > +Take care when commenting out text which is part of a multi-line block:
> > > +the comment takes effect until the end of the entire block.
> > > +.Pp
> > > Additional configuration files can be included with the
> > > .Ic include
> > > keyword, for example:
