Re: OpenSMTPD docs: forward.5

2021-02-13 Thread Larry Hynes
Jason McIntyre  wrote:
> On Fri, Feb 12, 2021 at 03:15:47PM +, Larry Hynes wrote:
> > 
> > Index: forward.5
> > ===
> > RCS file: /cvs/src/usr.sbin/smtpd/forward.5,v
> > retrieving revision 1.9
> > diff -u -p -r1.9 forward.5
> > --- forward.5   13 Mar 2015 22:41:54 -  1.9
> > +++ forward.5   12 Feb 2021 15:14:44 -
> > @@ -49,10 +49,10 @@ group or world-writable;
> >  if the home directory is group writeable;
> >  or if the file is not owned by the user.
> >  .Pp
> > -Users should avoid editing directly the
> > +Users should avoid editing the
> >  .Nm .forward
> > -file to prevent delivery failures from occurring if a message
> > -arrives while the file is not fully written.
> > +file directly, to prevent delivery failures from occurring if
> > +a message arrives while the file is not fully written.
> >  The best option is to use a temporary file and use the
> >  .Xr mv 1
> >  command to atomically overwrite the former
> > 
> 
> fixed, thanks.
> jmc

I meant to note that 'mandoc -Tlint' gives the following gripe about
forward.5:

forward.5:40:13: STYLE: no blank before trailing delimiter:
Pq :include:

It can be "fixed" by escaping the closing ':' at EOL with '\&' but I
don't know if that's correct (or worth it).



Re: OpenSMTPD docs: forward.5

2021-02-13 Thread Jason McIntyre
On Sat, Feb 13, 2021 at 09:47:41PM +, Larry Hynes wrote:
> Jason McIntyre  wrote:
> > On Fri, Feb 12, 2021 at 03:15:47PM +, Larry Hynes wrote:
> > > 
> > > Index: forward.5
> > > ===
> > > RCS file: /cvs/src/usr.sbin/smtpd/forward.5,v
> > > retrieving revision 1.9
> > > diff -u -p -r1.9 forward.5
> > > --- forward.5 13 Mar 2015 22:41:54 -  1.9
> > > +++ forward.5 12 Feb 2021 15:14:44 -
> > > @@ -49,10 +49,10 @@ group or world-writable;
> > >  if the home directory is group writeable;
> > >  or if the file is not owned by the user.
> > >  .Pp
> > > -Users should avoid editing directly the
> > > +Users should avoid editing the
> > >  .Nm .forward
> > > -file to prevent delivery failures from occurring if a message
> > > -arrives while the file is not fully written.
> > > +file directly, to prevent delivery failures from occurring if
> > > +a message arrives while the file is not fully written.
> > >  The best option is to use a temporary file and use the
> > >  .Xr mv 1
> > >  command to atomically overwrite the former
> > > 
> > 
> > fixed, thanks.
> > jmc
> 
> I meant to note that 'mandoc -Tlint' gives the following gripe about
> forward.5:
> 
>   forward.5:40:13: STYLE: no blank before trailing delimiter:
>   Pq :include:
> 
> It can be "fixed" by escaping the closing ':' at EOL with '\&' but I
> don't know if that's correct (or worth it).
> 

the idea is to catch punctuation not separated by whitespace, such as:

Such as
.Ar foo:

but in this case the argument to Pq is correct.

it's better to have it as a false positive (i think) than to mangle the
source to avoid the warning.

jmc



Re: OpenSMTPD docs: forward.5

2021-02-12 Thread Jason McIntyre
On Fri, Feb 12, 2021 at 03:15:47PM +, Larry Hynes wrote:
> 
> Index: forward.5
> ===
> RCS file: /cvs/src/usr.sbin/smtpd/forward.5,v
> retrieving revision 1.9
> diff -u -p -r1.9 forward.5
> --- forward.5 13 Mar 2015 22:41:54 -  1.9
> +++ forward.5 12 Feb 2021 15:14:44 -
> @@ -49,10 +49,10 @@ group or world-writable;
>  if the home directory is group writeable;
>  or if the file is not owned by the user.
>  .Pp
> -Users should avoid editing directly the
> +Users should avoid editing the
>  .Nm .forward
> -file to prevent delivery failures from occurring if a message
> -arrives while the file is not fully written.
> +file directly, to prevent delivery failures from occurring if
> +a message arrives while the file is not fully written.
>  The best option is to use a temporary file and use the
>  .Xr mv 1
>  command to atomically overwrite the former
> 

fixed, thanks.
jmc



OpenSMTPD docs: forward.5

2021-02-12 Thread Larry Hynes


Index: forward.5
===
RCS file: /cvs/src/usr.sbin/smtpd/forward.5,v
retrieving revision 1.9
diff -u -p -r1.9 forward.5
--- forward.5   13 Mar 2015 22:41:54 -  1.9
+++ forward.5   12 Feb 2021 15:14:44 -
@@ -49,10 +49,10 @@ group or world-writable;
 if the home directory is group writeable;
 or if the file is not owned by the user.
 .Pp
-Users should avoid editing directly the
+Users should avoid editing the
 .Nm .forward
-file to prevent delivery failures from occurring if a message
-arrives while the file is not fully written.
+file directly, to prevent delivery failures from occurring if
+a message arrives while the file is not fully written.
 The best option is to use a temporary file and use the
 .Xr mv 1
 command to atomically overwrite the former