docs/94312: [PATCH] desctiption and example mismatch

[Remko Lodder]

Yoshihiko Sarumaru wrote:
> The following reply was made to PR docs/94312; it has been noted by GNATS.
> 
> From: mistral at imasy.or.jp (Yoshihiko Sarumaru)
> To: remko at FreeBSD.org
> Cc: FreeBSD-gnats-submit at FreeBSD.org
> Subject: Re: docs/94312: [PATCH] desctiption and example mismatch
> Date: Mon, 13 Mar 2006 00:36:41 +0900
> 
>  > Yoshihiko Sarumaru wrote:
>  > > 	
>  > >> Description:
>  > > 	In nc(1), there are some examples presented, but in one exapmple,
>  > > 	hostname are mismatch in description and command line.
>  > > 
>  > > 	This PR related to docs/94158
>  > >> How-To-Repeat:
>  > > 	man 1 nc
>  > >> Fix:
>  > > --- /usr/src/contrib/netcat/nc.1	Mon Jun 27 16:07:55 2005
>  > > +++ nc.1	Sat Mar 11 03:04:04 2006
>  > > @@ -401,7 +401,7 @@
>  > >  .Pp
>  > >  .Dl $ nc -s 10.1.2.3 example.host 42
>  > >  .Pp
>  > > -Send UDP packets to ports 20-30 of example.host, and report which ones
>  > > +Send UDP packets to ports 20-30 of hostname, and report which ones
>  > >  responded with an ICMP packet after three seconds:
>  > >  .Pp
>  > >  .Dl $ nc -uvz -w 3 hostname 20-30
>  > 
>  > Hi,
>  > 
>  > This is a somewhat difficult change i think.  We have various
>  > instances of "hostname" and various instances of "example.host".
>  > 
>  > I would like to be consistent though and make them all "example.host"
>  > which describes the items best.  What do others think of this?
>  
>  I don't mind whichever, but I also feel something inconsistency
>  to the both "hostname" and "example.host" are used.
>  
>  Regars,
>  
>  --
>  sarumaru

Ok, we can just say that we have an agreement over that it is
inconsistent at this time.  But, after reading the diff a bit
better it seems that it is from contrib/ where we usually do
not change things because a new import of the software will
simply overwrite the changed lines.

So, perhaps you and I can choose the desired road (I think
example.host is the way to go) and sent the patch towards
the netcat maintainers so that it will be fixed upstream.

In the meantime I will grab the PR and make sure we finish this
together :-).

What do you think about that?

-- 
Kind regards,

      Remko Lodder               ** remko at elvandar.org
      FreeBSD                    ** remko at FreeBSD.org

      /* Quis custodiet ipsos custodes */