Re: [PATCH] Fix markup in sntp.8

classic Classic list List threaded Threaded
3 messages Options
Reply | Threaded
Open this post in threaded view
|

Re: [PATCH] Fix markup in sntp.8

Cy Schubert-3
Let's try this again... I had my cursor in the wrong place in exmh when hit
send, making my reply look a little dumb.

In message <[hidden email]>, Benjamin
Kaduk
 writes:

> On Tue, 23 Aug 2016, Benjamin Kaduk wrote:
>
> > On Tue, 23 Aug 2016, Steve Kargl wrote:
> >
> > > On Wed, Aug 17, 2016 at 01:47:37PM -0700, Steve Kargl wrote:
> > > > Index: sntp.8
> > > > ===================================================================
> > > > --- sntp.8      (revision 303492)
> > > > +++ sntp.8      (working copy)
> > > > @@ -213,7 +213,7 @@
> > > >  more than enough for a unicast response.  If \fBsntp\fP is
> > > >  only waiting for a broadcast response a longer timeout is
> > > >  likely needed.
> > > > -.It  Fl \-wait , " Fl \-no\-wait"
> > > > +.It  Fl \-wait , Fl \-no\-wait
> > > >  Wait for pending replies (if not setting the time).
> > > >  The \fIno\-wait\fP form will disable the option.
> > > >  This option is enabled by default.
> > > >
> > >
> > > Does freebsd-doc handle documentation patches?
> >
> > We do handle them, we are just sometimes slow about it.

Hi Ben,

Either the doc team or src team can handle this.

I added Ollivier Robert, FreeBSD's original src/ NTP mainainer, to the cc
list.

>
> Getting around towards doing so, I note that this file is from a vendor
> tree, and the bug is still present in
> https://github.com/ntp-project/ntp/blob/master/sntp/sntp.mdoc.in .
> Unfortunately, http://bugs.ntp.org/enter_bug.cgi wants me to create a
> login; adding cy and delphij to see if either of them already have one and
> would be able to report the bug upstream.

I have an account. I can submit a bug upstream. As port maintainer (as
well) I've communicated with our upstream (Harlan Stenn) on many an
occasion.

>
> My understanding is that now that we're in subversion intsead of CVS,
> applying a local patch to a file from the vendor tree is not a huge
> burden, but I'm inclined to wait a bit to add a local patch so we can see
> how responsive upstream is.

This gets a little complicated. Even though the man pages, like
sntp.man.in, are in the vendor branch and in contrib, they're actually
installed from usr.sbin/ntp/doc. It's not "right" and it should be. Using
the vendor supplied man pages is preferred and is on my list of things to
do. Having said that, as ntp ports (ntp and ntp-devel) maintainer, I've
seen a fair bit of fluctuation with ntp documentation where sometimes there
are man pages and at other times the man pages are replaced by html
documents. The issue with this is that it will create a bit of churn for
ntp in src/ because sometime man pages will be available and sometimes not.
The solution (I think) is to use vendor supplied man pages when available
and when not, either not use the man pages in usr.sbin/ntp/doc or svn cp
missing man pages back. To summarize, this needs to be thought out a little
more in regard to revering to previous man pages when those in the
distribution are deleted in lieu of html documentation (yet again). But I
digress, this is getting off topic.

I've commited the patch to base and ports, have submitted the patch
upstream,
and have emailed Harlan Stenn (personally) as well.

>
> Sorry about the (further) delay...

No problem, just not enough time in the day any more.

Thanks for email Ben.


--
Cheers,
Cy Schubert <[hidden email]>
FreeBSD UNIX:  <[hidden email]>   Web:  http://www.FreeBSD.org

        The need of the many outweighs the greed of the few.



_______________________________________________
[hidden email] mailing list
https://lists.freebsd.org/mailman/listinfo/freebsd-doc
To unsubscribe, send any mail to "[hidden email]"
Reply | Threaded
Open this post in threaded view
|

Re: [PATCH] Fix markup in sntp.8

Ollivier Robert
According to Cy Schubert on Tue, Aug 23, 2016 at 08:40:59PM -0700:
> This gets a little complicated. Even though the man pages, like
> sntp.man.in, are in the vendor branch and in contrib, they're actually
> installed from usr.sbin/ntp/doc. It's not "right" and it should be. Using
> the vendor supplied man pages is preferred and is on my list of things to
> do. Having said that, as ntp ports (ntp and ntp-devel) maintainer, I've
> seen a fair bit of fluctuation with ntp documentation where sometimes there
> are man pages and at other times the man pages are replaced by html
> documents. The issue with this is that it will create a bit of churn for
> ntp in src/ because sometime man pages will be available and sometimes not.

> The solution (I think) is to use vendor supplied man pages when available
> and when not, either not use the man pages in usr.sbin/ntp/doc or svn cp
> missing man pages back. To summarize, this needs to be thought out a little
> more in regard to revering to previous man pages when those in the
> distribution are deleted in lieu of html documentation (yet again). But I
> digress, this is getting off topic.

Historically speaking, there were never any manpages written by the NTP project, Dave Mills was having big eyesight issues and only ever wrote HTML pages.  At some point a long time ago, some freebsd people did wrote manpage versions of some of the HTML pages but this was tedious work, never upstreamed because Dr. Mills was not interested.

This effort was stopped a long time ago and we did make do with whatever the project released.

Now that Dr. Mills has retired, I don't really know what NTP is now doing in that respect.

Cheers,

--
Ollivier ROBERT -=- FreeBSD: The Power to Serve! -=- [hidden email]
In memoriam to Ondine, our 2nd child: http://ondine.keltia.net/

_______________________________________________
[hidden email] mailing list
https://lists.freebsd.org/mailman/listinfo/freebsd-doc
To unsubscribe, send any mail to "[hidden email]"
Reply | Threaded
Open this post in threaded view
|

Re: [PATCH] Fix markup in sntp.8

Cy Schubert-3
In reply to this post by Cy Schubert-3
In message <[hidden email]>,
Ollivie
r Robert writes:

> According to Cy Schubert on Tue, Aug 23, 2016 at 08:40:59PM -0700:
> > This gets a little complicated. Even though the man pages, like
> > sntp.man.in, are in the vendor branch and in contrib, they're actually
> > installed from usr.sbin/ntp/doc. It's not "right" and it should be. Using
> > the vendor supplied man pages is preferred and is on my list of things to
> > do. Having said that, as ntp ports (ntp and ntp-devel) maintainer, I've
> > seen a fair bit of fluctuation with ntp documentation where sometimes there
>  
> > are man pages and at other times the man pages are replaced by html
> > documents. The issue with this is that it will create a bit of churn for
> > ntp in src/ because sometime man pages will be available and sometimes not.
>  
>
> > The solution (I think) is to use vendor supplied man pages when available
> > and when not, either not use the man pages in usr.sbin/ntp/doc or svn cp
> > missing man pages back. To summarize, this needs to be thought out a little
>  
> > more in regard to revering to previous man pages when those in the
> > distribution are deleted in lieu of html documentation (yet again). But I
> > digress, this is getting off topic.
>
> Historically speaking, there were never any manpages written by the NTP proje
> ct, Dave Mills was having big eyesight issues and only ever wrote HTML pages.
>   At some point a long time ago, some freebsd people did wrote manpage versio
> ns of some of the HTML pages but this was tedious work, never upstreamed beca
> use Dr. Mills was not interested.
>
> This effort was stopped a long time ago and we did make do with whatever the
> project released.
>
> Now that Dr. Mills has retired, I don't really know what NTP is now doing in
> that respect.

Interesting. The current NTP maintainer (Halan Stenn) seems to have taken
the same approach, though sometimes including the code to build man pages
and at other times only HTML doc. The pkg-plist for the port now has a mix
of both. Some of the doc is HTML pages while other is man pages. And, it
varies from release to release, which is why I'm somewhat reluctant to
remove what we have in usr.sbin/ntp/doc, anticipating that it will change
yet again at some future release.


--
Cheers,
Cy Schubert <[hidden email]>
FreeBSD UNIX:  <[hidden email]>   Web:  http://www.FreeBSD.org

        The need of the many outweighs the greed of the few.


_______________________________________________
[hidden email] mailing list
https://lists.freebsd.org/mailman/listinfo/freebsd-doc
To unsubscribe, send any mail to "[hidden email]"