From owner-freebsd-doc Sun Aug 15 9:40:51 1999 Delivered-To: freebsd-doc@freebsd.org Received: from freefall.freebsd.org (freefall.FreeBSD.ORG [204.216.27.21]) by hub.freebsd.org (Postfix) with ESMTP id 88FDF14F61 for ; Sun, 15 Aug 1999 09:40:49 -0700 (PDT) (envelope-from gnats@FreeBSD.org) Received: (from gnats@localhost) by freefall.freebsd.org (8.9.3/8.9.2) id JAA01634; Sun, 15 Aug 1999 09:40:03 -0700 (PDT) (envelope-from gnats@FreeBSD.org) Date: Sun, 15 Aug 1999 09:40:03 -0700 (PDT) Message-Id: <199908151640.JAA01634@freefall.freebsd.org> To: freebsd-doc@freebsd.org Cc: From: "Alexey M. Zelkin" Subject: Re: docs/13144: [PATCH] lots of style patches for -mdoc manpages Reply-To: "Alexey M. Zelkin" Sender: owner-freebsd-doc@FreeBSD.ORG Precedence: bulk X-Loop: FreeBSD.org The following reply was made to PR docs/13144; it has been noted by GNATS. From: "Alexey M. Zelkin" To: mpp@mpp.pro-ns.net (Mike Pritchard) Cc: phantom@cris.net, FreeBSD-gnats-submit@FreeBSD.ORG Subject: Re: docs/13144: [PATCH] lots of style patches for -mdoc manpages Date: Sun, 15 Aug 1999 19:27:05 +0400 (MSD) hi, > > >Number: 13144 > > I am working on translation man pages to russian language and found > > a lot of style inconsistenses. > > > > Patch is huge. More than 180 pages were updated. > > > > What's changed ? > > > > main points: > > . -mdoc style fixes (according to mdoc(7)) > > 99.9% of these of these looked good. I've got the 2 or 3 bad ones written > down. Which ones exactly ? > > additional points: > > . Correcting Section Headers names (like AUTHOR -> AUTHORS). See mdoc(7) for > > complete list correct headers. > > Since there are so many of these man pages out there, I'm almost thinking > that we should add document that it is OK to use these. However, > I did notice that some of the ones you updated had multiple authors > listed, so people are are forgetting to change AUTHOR to AUTHORS when > adding a second person to the author list. But if we fix them all > now, and just keep an eye on all new man pages, it shouldn't > be a problem again in the future. hmm ... maybe I'll improve my script which checked these inconsistenses and submit it (something like portlint). Then we just can add note to mdoc(7) as requrement to check new/updated manpages with that ? And maybe once per month check all manpages in source tree ? I don't think that adding new, but with same meaning section headers names to style guide is good way. > Then there are the man pages in contrib/. I would leave the style > things alone in those man pages and request that the author fix > them. That will make importing new versions of these easier. Ok, I will send them to bind(8) mainteiner. > > . few references like "(1) (yet another port)" expanded to > > "/usr/ports//". Maybe it's good idea to do it with all > > same references, e.g. gated(1),portlint(1) ? It will make references more > I've been toying with the idea of adding a ".Pr" macro (ports reference). > > E.g. > > .Pr gated 1 > > Would expand to something like: > > gated(1) (from the portse collection) It's really that I asked for! > I suppose we could also do: > .Pr gated 1 net Sure. > gated(1) (from the ports net collection) -- Sincerely Yours, | phantom@crimea.edu (primary) Alexey Zelkin | phantom@scorpion.crimea.ua (home) | ICQ: #6196584, FIDO: 2:460/12.26 To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-doc" in the body of the message