Bug 90851
| Summary: | mdoc(7) manpage needs more FreeBSD versions | ||
|---|---|---|---|
| Product: | Documentation | Reporter: | Poul-Henning Kamp <phk> |
| Component: | Books & Articles | Assignee: | Remko Lodder <remko> |
| Status: | Closed FIXED | ||
| Severity: | Affects Only Me | ||
| Priority: | Normal | ||
| Version: | Latest | ||
| Hardware: | Any | ||
| OS: | Any | ||
On Fri, Dec 23, 2005 at 01:34:42PM +0100, Poul-Henning Kamp wrote: > >Description: > > The mdoc(7) manual enumerates (pointlessly in my opinion) the various releases > of FreeBSD that can be specified to the Os and Fx macros: > > FreeBSD 1.0, 1.1, 1.1.5, 1.1.5.1, 2.0, 2.0.5, 2.1, 2.1.5, > 2.1.6, 2.1.7, 2.2, 2.2.1, 2.2.2, 2.2.5, 2.2.6, > 2.2.7, 2.2.8, 3.0, 3.1, 3.2, 3.3, 3.4, 3.5, 4.0, > 4.1, 4.1.1, 4.2, 4.3, 4.4, 4.5, 4.6, 4.6.2, 4.7, > 4.8, 4.9, 4.10, 5.0, 5.1, 5.2, 5.2.1, 5.3 > > The list should either be kept up to date, or more sensibly be replaced with > > FreeBSD 1.0, 1.1, 1.1.5, 2.0, 2.0.5, etc. etc. > > Hi Poul-Henning, Does the diff below look reasonable? (Added NetBSD release 3.0 as well). Index: groff_mdoc.man =================================================================== RCS file: /home/ncvs/src/contrib/groff/tmac/groff_mdoc.man,v retrieving revision 1.1.1.19 diff -u -r1.1.1.19 groff_mdoc.man --- groff_mdoc.man 20 Oct 2005 10:45:18 -0000 1.1.1.19 +++ groff_mdoc.man 1 Jan 2006 19:42:03 -0000 @@ -863,12 +863,12 @@ .It NetBSD 0.8, 0.8a, 0.9, 0.9a, 1.0, 1.0a, 1.1, 1.2, 1.2a, 1.2b, 1.2c, 1.2d, 1.2e, 1.3, 1.3a, 1.4, 1.4.1, 1.4.2, 1.4.3, 1.5, 1.5.1, 1.5.2, 1.5.3, 1.6, 1.6.1, -1.6.2, 2.0, 2.0.1, 2.0.2, 2.1 +1.6.2, 2.0, 2.0.1, 2.0.2, 2.1, 3.0 .It FreeBSD 1.0, 1.1, 1.1.5, 1.1.5.1, 2.0, 2.0.5, 2.1, 2.1.5, 2.1.6, 2.1.7, 2.2, 2.2.1, 2.2.2, 2.2.5, 2.2.6, 2.2.7, 2.2.8, 3.0, 3.1, 3.2, 3.3, 3.4, 3.5, 4.0, 4.1, 4.1.1, 4.2, 4.3, 4.4, 4.5, 4.6, 4.6.2, 4.7, 4.8, 4.9, 4.10, 5.0, 5.1, 5.2, -5.2.1, 5.3 +5.2.1, 5.3, 5.4, 6.0 .El .Ed .Pp -- Kind regards, Remko Lodder ** remko@elvandar.org FreeBSD ** remko@FreeBSD.org In message <20060101194413.GA73743@elvandar.org>, Remko Lodder writes: >On Fri, Dec 23, 2005 at 01:34:42PM +0100, Poul-Henning Kamp wrote: >> >Description: >> >> The mdoc(7) manual enumerates (pointlessly in my opinion) the various releases >> of FreeBSD that can be specified to the Os and Fx macros: >> >> FreeBSD 1.0, 1.1, 1.1.5, 1.1.5.1, 2.0, 2.0.5, 2.1, 2.1.5, >> 2.1.6, 2.1.7, 2.2, 2.2.1, 2.2.2, 2.2.5, 2.2.6, >> 2.2.7, 2.2.8, 3.0, 3.1, 3.2, 3.3, 3.4, 3.5, 4.0, >> 4.1, 4.1.1, 4.2, 4.3, 4.4, 4.5, 4.6, 4.6.2, 4.7, >> 4.8, 4.9, 4.10, 5.0, 5.1, 5.2, 5.2.1, 5.3 >> >> The list should either be kept up to date, or more sensibly be replaced with >> >> FreeBSD 1.0, 1.1, 1.1.5, 2.0, 2.0.5, etc. etc. >> >> > >Hi Poul-Henning, > > Does the diff below look reasonable? Is it a more future proof solution to just list a handful and add "etc" ? -- Poul-Henning Kamp | UNIX since Zilog Zeus 3.20 phk@FreeBSD.ORG | TCP/IP since RFC 956 FreeBSD committer | BSD since 4.3-tahoe Never attribute to malice what can adequately be explained by incompetence. On 1 Jan 2006, at 23:00, Poul-Henning Kamp wrote: > In message <20060101194413.GA73743@elvandar.org>, Remko Lodder > writes: >> On Fri, Dec 23, 2005 at 01:34:42PM +0100, Poul-Henning Kamp wrote: >>>> Description: >>> >>> The mdoc(7) manual enumerates (pointlessly in my opinion) the >>> various releases >>> of FreeBSD that can be specified to the Os and Fx macros: >>> >>> FreeBSD 1.0, 1.1, 1.1.5, 1.1.5.1, 2.0, 2.0.5, >>> 2.1, 2.1.5, >>> 2.1.6, 2.1.7, 2.2, 2.2.1, 2.2.2, >>> 2.2.5, 2.2.6, >>> 2.2.7, 2.2.8, 3.0, 3.1, 3.2, 3.3, >>> 3.4, 3.5, 4.0, >>> 4.1, 4.1.1, 4.2, 4.3, 4.4, 4.5, 4.6, >>> 4.6.2, 4.7, >>> 4.8, 4.9, 4.10, 5.0, 5.1, 5.2, 5.2.1, >>> 5.3 >>> >>> The list should either be kept up to date, or more sensibly be >>> replaced with >>> >>> FreeBSD 1.0, 1.1, 1.1.5, 2.0, 2.0.5, etc. etc. >>> >>> >> >> Hi Poul-Henning, >> >> Does the diff below look reasonable? > > Is it a more future proof solution to just list a handful and add > "etc" ? We should ask Ruslan whether we can rely on them all being supported. Ceri On Mon, Jan 02, 2006 at 05:23:53PM +0000, Ceri Davies wrote: > > On 1 Jan 2006, at 23:00, Poul-Henning Kamp wrote: > > In message <20060101194413.GA73743@elvandar.org>, Remko Lodder > >writes: > >>On Fri, Dec 23, 2005 at 01:34:42PM +0100, Poul-Henning Kamp wrote: > >>>>Description: > >>> > >>> The mdoc(7) manual enumerates (pointlessly in my opinion) the > >>>various releases > >>> of FreeBSD that can be specified to the Os and Fx macros: > >>> > >>> FreeBSD 1.0, 1.1, 1.1.5, 1.1.5.1, 2.0, 2.0.5, > >>>2.1, 2.1.5, > >>> 2.1.6, 2.1.7, 2.2, 2.2.1, 2.2.2, > >>>2.2.5, 2.2.6, > >>> 2.2.7, 2.2.8, 3.0, 3.1, 3.2, 3.3, > >>>3.4, 3.5, 4.0, > >>> 4.1, 4.1.1, 4.2, 4.3, 4.4, 4.5, 4.6, > >>>4.6.2, 4.7, > >>> 4.8, 4.9, 4.10, 5.0, 5.1, 5.2, 5.2.1, > >>>5.3 > >>> > >>> The list should either be kept up to date, or more sensibly be > >>>replaced with > >>> > >>> FreeBSD 1.0, 1.1, 1.1.5, 2.0, 2.0.5, etc. etc. > >>> > >>> > >> > >>Hi Poul-Henning, > >> > >> Does the diff below look reasonable? > > > > Is it a more future proof solution to just list a handful and add > >"etc" ? > > We should ask Ruslan whether we can rely on them all being supported. > The -mdoc warns when an incorrect version is supplied as an argument, and it helps improve the quality of documentation. If we just replace the list with "etc. etc." it's in my opinion not different to not keeping it up-to-date. We and our BSD brothers did a good job until now to keep the list regularly updated, so I don't see a reason to not continue doing it now. You have a Groff maintainer in FreeBSD, me, who's also co-authoring the next-generation -mdoc code, so you have the point of contact. I suggest that this discussion stops with the patches being sent upstream. In fact, I already have such patches and will send them upstream when I have time for this. Happy New Year to you all! Cheers, -- Ruslan Ermilov ru@FreeBSD.org FreeBSD committer Hi,
ru@ submitted a patch upstream so that it can be fixed from
top to bottom. Since this involves a /contrib file we should
not modify this within the FreeBSD structure. Within time a
new vendor import will contain this change and the versions
will get updated.
I will take the PR and 'monitor' it so that the audit-trail
keeps doing what it should.
Thanks ru@ for submitting it upstream!
--
Kind regards,
Remko Lodder ** remko@elvandar.org
FreeBSD ** remko@FreeBSD.org
State Changed From-To: open->suspended Suspend the PR till we get a vendor import which has the patch which was sent upstream included. I will also grab the PR so that i can monitor this. Responsible Changed From-To: freebsd-doc->remko Suspend the PR till we get a vendor import which has the patch which was sent upstream included. I will also grab the PR so that i can monitor this. State Changed From-To: suspended->closed The import was done 8 weeks ago in revision 1.1.1.20 on the vendor branch. The commit log was: Merge support for new BSD releases from upstream: - Darwin 8.[0-3].0 - FreeBSD 4.11, 5.4, 6.0, 6.1 - NetBSD 3.0 -- Thanks to ru@ for doing to update! Close the PR since what had been requested had been done. |
The mdoc(7) manual enumerates (pointlessly in my opinion) the various releases of FreeBSD that can be specified to the Os and Fx macros: FreeBSD 1.0, 1.1, 1.1.5, 1.1.5.1, 2.0, 2.0.5, 2.1, 2.1.5, 2.1.6, 2.1.7, 2.2, 2.2.1, 2.2.2, 2.2.5, 2.2.6, 2.2.7, 2.2.8, 3.0, 3.1, 3.2, 3.3, 3.4, 3.5, 4.0, 4.1, 4.1.1, 4.2, 4.3, 4.4, 4.5, 4.6, 4.6.2, 4.7, 4.8, 4.9, 4.10, 5.0, 5.1, 5.2, 5.2.1, 5.3 The list should either be kept up to date, or more sensibly be replaced with FreeBSD 1.0, 1.1, 1.1.5, 2.0, 2.0.5, etc. etc.