svn commit: r367142 - head/usr.bin/fmt

[Fernando Apesteguía]

On Thu, Oct 29, 2020 at 7:47 PM <xtouqh at icloud.com> wrote:

> Fernando Apesteguía wrote:
> > Author: fernape (ports committer)
> > Date: Thu Oct 29 18:37:20 2020
> > New Revision: 367142
> > URL: https://svnweb.freebsd.org/changeset/base/367142
> >
> > Log:
> >    fmt(1): Add EXAMPLES section
> >
> >    Very small EXAMPLES section.
> >
> >    While here, remove reference to nroff(1).
> >
> >    Approved by:       manpages (bcr@)
> >    Differential Revision:             https://reviews.freebsd.org/D26947
> >
> > Modified:
> >    head/usr.bin/fmt/fmt.1
> >
> > Modified: head/usr.bin/fmt/fmt.1
> >
> ==============================================================================
> > --- head/usr.bin/fmt/fmt.1    Thu Oct 29 18:34:47 2020        (r367141)
> > +++ head/usr.bin/fmt/fmt.1    Thu Oct 29 18:37:20 2020        (r367142)
> > @@ -30,7 +30,7 @@
> >   .\"
> >   .\" Modified by Gareth McCaughan to describe the new version of `fmt'
> >   .\" rather than the old one.
> > -.Dd December 1, 2017
> > +.Dd October 29, 2020
> >   .Dt FMT 1
> >   .Os
> >   .Sh NAME
> > @@ -89,10 +89,6 @@ Try to format mail header lines contained in the input
> >   Format lines beginning with a
> >   .Ql \&.
> >   (dot) character.
> > -Normally,
> > -.Nm
> > -does not fill these lines, for compatibility with
> > -.Xr nroff 1 .
>
> Was the behavior of fmt(1) really changed? If not, you could just
> replace ".Xr nroff 1 ." with ".Nm nroff . ".
>

Hi,
Thanks for reviewing the commit!

In another revision I did something similar (
https://reviews.freebsd.org/D26146) (commit r366516) removing a BUGS
section with details about nroff since it is not in base anymore.
I got the impression that we should not refer to things that might (or
might not) be installed from ports (see bcr@ comment in that review).

I am not a docs committer and I don't know the policy here beyond those
comments.
But nevertheless if the paragraph has to be restored without cross
reference, I'll do it :-)


>
> >   .It Fl p
> >   Allow indented paragraphs.
> >   Without the
> > @@ -159,10 +155,23 @@ environment variables affect the execution of
> >   .Nm
> >   as described in
> >   .Xr environ 7 .
> > +.Sh EXAMPLES
> > +Center the text in standard input:
> > +.Bd -literal -offset indent
> > +$ echo -e 'The merit of all things\enlies\enin their difficulty' | fmt
> -c
> > +                     The merit of all things
> > +                               lies
> > +                       in their difficulty
> > +.Ed
> > +.Pp
> > +Format the text in standard input collapsing spaces:
> > +.Bd -literal -offset indent
> > +$ echo -e 'Multiple   spaces    will be collapsed' | fmt -s
> > +Multiple spaces will be collapsed
> > +.Ed
> >   .Sh SEE ALSO
> >   .Xr fold 1 ,
> > -.Xr mail 1 ,
> > -.Xr nroff 1
> > +.Xr mail 1
> >   .Sh HISTORY
> >   The
> >   .Nm
>