Re: mdoc.7: tweak skeleton file

[Jason McIntyre <jmc@kerhand.co.uk>]

On Sat, Aug 28, 2010 at 11:12:30PM +0200, Kristaps Dzonsons wrote:
> >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

aye. ok too.
jmc

> ? 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

--
 To unsubscribe send an email to discuss+unsubscribe@mdocml.bsd.lv