From: Kristaps Dzonsons <kristaps@bsd.lv>
To: discuss@mdocml.bsd.lv
Subject: Re: mdoc.7: tweak skeleton file
Date: Sat, 28 Aug 2010 23:12:30 +0200 [thread overview]
Message-ID: <4C797BBE.7060500@bsd.lv> (raw)
In-Reply-To: <20100826182407.GD31244@bramka.kerhand.co.uk>
[-- Attachment #1: Type: text/plain, Size: 1063 bytes --]
> i wanted to address the very annoying ordering that has always existed
> in mdoc/mdoc.samples:
>
> .\" This comment applies to the section below.
> .\" .Sh BLAH
> .\" .Sh SEE ALSO
> .\" .Xr foobar 1
>
> we should put everything relevant to a section underneath the section,
> not before it (like the order you read it). thus my diff changes things:
>
> .\" .Sh SECTION
> .\" This comment applies to the BLAH section.
> .\" .Sh SEE ALSO
> .\" .Xr foobar 1
>
> ...and since i am in here, let's talk about os-specific things. i have
> noted under LIBRARY and SECURITY CONSIDERATIONS that they are net/free
> only. i still have no solution to Dd and $Mdocdate$. we can
> alternatively look at having os-specific pages if preferred.
Jason,
I like the idea of moving the "next section..." stuff. I always
hiccuped on that.
But it makes more sense to say "not OpenBSD" than "for x, y, and z only"
because the latter covers an open interval.
Enclosed is a patch that uses "not OpenBSD".
Thoughts?
If it's good, I'll put it in man.7 also.
Kristaps
[-- Attachment #2: patch.txt --]
[-- Type: text/plain, Size: 1517 bytes --]
? foo.1
? foo.1.html
? patch.txt
Index: mdoc.7
===================================================================
RCS file: /usr/vhosts/mdocml.bsd.lv/cvs/mdocml/mdoc.7,v
retrieving revision 1.155
diff -u -r1.155 mdoc.7
--- mdoc.7 24 Aug 2010 14:03:46 -0000 1.155
+++ mdoc.7 28 Aug 2010 21:11:31 -0000
@@ -331,8 +331,9 @@
\&.Sh NAME
\&.Nm foo
\&.Nd a description goes here
-\&.\e\*q The next is for sections 2, 3, & 9 only.
\&.\e\*q .Sh LIBRARY
+\&.\e\*q For sections 2, 3, & 9 only.
+\&.\e\*q Not used in OpenBSD.
\&.Sh SYNOPSIS
\&.Nm foo
\&.Op Fl options
@@ -342,18 +343,18 @@
\&.Nm
utility processes files ...
\&.\e\*q .Sh IMPLEMENTATION NOTES
-\&.\e\*q The next is for sections 2, 3, & 9 only.
\&.\e\*q .Sh RETURN VALUES
-\&.\e\*q The next is for sections 1, 6, 7, & 8 only.
+\&.\e\*q For sections 2, 3, & 9 only.
\&.\e\*q .Sh ENVIRONMENT
+\&.\e\*q For sections 1, 6, 7, & 8 only.
\&.\e\*q .Sh FILES
-\&.\e\*q The next is for sections 1 & 8 only.
\&.\e\*q .Sh EXIT STATUS
+\&.\e\*q For sections 1 & 8 only.
\&.\e\*q .Sh EXAMPLES
-\&.\e\*q The next is for sections 1, 4, 6, 7, & 8 only.
\&.\e\*q .Sh DIAGNOSTICS
-\&.\e\*q The next is for sections 2, 3, & 9 only.
+\&.\e\*q For sections 1, 4, 6, 7, & 8 only.
\&.\e\*q .Sh ERRORS
+\&.\e\*q For sections 2, 3, & 9 only.
\&.\e\*q .Sh SEE ALSO
\&.\e\*q .Xr foobar 1
\&.\e\*q .Sh STANDARDS
@@ -362,6 +363,7 @@
\&.\e\*q .Sh CAVEATS
\&.\e\*q .Sh BUGS
\&.\e\*q .Sh SECURITY CONSIDERATIONS
+\&.\e\*q Not used in OpenBSD.
.Ed
.Pp
The sections in an
next prev parent reply other threads:[~2010-08-28 21:12 UTC|newest]
Thread overview: 22+ messages / expand[flat|nested] mbox.gz Atom feed top
2010-08-26 18:24 Jason McIntyre
2010-08-28 21:12 ` Kristaps Dzonsons [this message]
2010-08-28 22:01 ` Jason McIntyre
2010-08-28 22:08 ` Kristaps Dzonsons
2010-08-28 22:18 ` Jason McIntyre
2010-08-28 22:38 ` Jason McIntyre
2010-08-28 23:14 ` Kristaps Dzonsons
2010-08-29 9:10 ` Jason McIntyre
2010-08-29 10:50 ` Thomas Klausner
2010-08-29 11:33 ` Jason McIntyre
2010-08-29 12:09 ` Thomas Klausner
2010-08-29 16:17 ` Jason McIntyre
2010-08-29 17:26 ` Kristaps Dzonsons
2010-08-29 18:06 ` Ulrich Spörlein
2010-08-29 18:28 ` Jason McIntyre
2010-08-29 20:57 ` Thomas Klausner
2010-08-30 6:43 ` Jason McIntyre
2010-08-30 9:01 ` Thomas Klausner
2010-08-30 12:16 ` Jason McIntyre
2010-08-30 12:21 ` Thomas Klausner
2010-08-30 12:29 ` Kristaps Dzonsons
2010-08-31 17:54 ` Jason McIntyre
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=4C797BBE.7060500@bsd.lv \
--to=kristaps@bsd.lv \
--cc=discuss@mdocml.bsd.lv \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).