diff options
author | Ingo Schwarze <schwarze@cvs.openbsd.org> | 2014-02-16 14:26:52 +0000 |
---|---|---|
committer | Ingo Schwarze <schwarze@cvs.openbsd.org> | 2014-02-16 14:26:52 +0000 |
commit | 47d423d801792a0e01ec52aecbc22966193ddcd7 (patch) | |
tree | 1de53d2f20dc5544dbf6aaeb88cbeacbd11ca5b3 | |
parent | 9e0e7df20ef42c55ffc250f97783069ec55d8969 (diff) |
After Werner Lemberg accepted and committed some updates to the manual
page template contained in groff_mdoc(7), catch up with our own stuff.
In particular, allow ERRORS in section 4 and DIAGNOSTICS in section 9.
ok jmc@
-rw-r--r-- | share/man/man7/man.7 | 34 | ||||
-rw-r--r-- | share/man/man7/mdoc.7 | 28 | ||||
-rw-r--r-- | share/misc/mdoc.template | 10 | ||||
-rw-r--r-- | usr.bin/mandoc/mdoc_validate.c | 8 |
4 files changed, 47 insertions, 33 deletions
diff --git a/share/man/man7/man.7 b/share/man/man7/man.7 index 40e9d92353d..3eae777f471 100644 --- a/share/man/man7/man.7 +++ b/share/man/man7/man.7 @@ -1,4 +1,4 @@ -.\" $OpenBSD: man.7,v 1.36 2014/02/14 17:27:58 schwarze Exp $ +.\" $OpenBSD: man.7,v 1.37 2014/02/16 14:26:51 schwarze Exp $ .\" .\" Copyright (c) 2009, 2010, 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv> .\" Copyright (c) 2011, 2012, 2013 Ingo Schwarze <schwarze@openbsd.org> @@ -16,7 +16,7 @@ .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" -.Dd $Mdocdate: February 14 2014 $ +.Dd $Mdocdate: February 16 2014 $ .Dt MAN 7 .Os .Sh NAME @@ -98,30 +98,30 @@ file for a utility .Bd -literal -offset indent \&.TH PROGNAME 1 2009-10-10 \&.SH NAME -\efBprogname\efR \e(en a description goes here +\efBprogname\efR \e(en one line about what it does \&.\e\(dq .SH LIBRARY -\&.\e\(dq For sections 2 & 3 only. +\&.\e\(dq For sections 2, 3, and 9 only. \&.\e\(dq Not used in OpenBSD. \&.SH SYNOPSIS -\efBprogname\efR [\efB\e-options\efR] arguments... +\efBprogname\efR [\efB\e-options\efR] \efIfile ...\efR \&.SH DESCRIPTION -The \efBfoo\efR utility processes files... +The \efBfoo\efR utility processes files ... \&.\e\(dq .SH IMPLEMENTATION NOTES \&.\e\(dq Not used in OpenBSD. \&.\e\(dq .SH RETURN VALUES -\&.\e\(dq For sections 2, 3, & 9 only. +\&.\e\(dq For sections 2, 3, and 9 function return values only. \&.\e\(dq .SH ENVIRONMENT -\&.\e\(dq For sections 1, 6, 7, & 8 only. +\&.\e\(dq For sections 1, 6, 7, and 8 only. \&.\e\(dq .SH FILES \&.\e\(dq .SH EXIT STATUS -\&.\e\(dq For sections 1, 6, & 8 only. +\&.\e\(dq For sections 1, 6, and 8 only. \&.\e\(dq .SH EXAMPLES \&.\e\(dq .SH DIAGNOSTICS -\&.\e\(dq For sections 1, 4, 6, 7, & 8 only. +\&.\e\(dq For sections 1, 4, 6, 7, 8, and 9 printf/stderr messages only. \&.\e\(dq .SH ERRORS -\&.\e\(dq For sections 2, 3, & 9 only. +\&.\e\(dq For sections 2, 3, 4, and 9 errno settings only. \&.\e\(dq .SH SEE ALSO -\&.\e\(dq .BR foo ( 1 ) +\&.\e\(dq .BR foobar ( 1 ) \&.\e\(dq .SH STANDARDS \&.\e\(dq .SH HISTORY \&.\e\(dq .SH AUTHORS @@ -197,13 +197,19 @@ well-tested invocations. Make sure that examples work properly! .It Em DIAGNOSTICS Documents error conditions. -This is most useful in section 4 manuals. +In section 4 and 9 manuals, these are usually messages +printed by the kernel to the console and to the kernel log. +In section 1, 6, 7, and 8, these are usually messages +printed by userland programs to the standard error output. +.Pp Historically, this section was used in place of .Em EXIT STATUS for manuals in sections 1, 6, and 8; however, this practise is discouraged. .It Em ERRORS -Documents error handling in sections 2, 3, and 9. +Documents +.Xr errno 2 +settings in sections 2, 3, 4, and 9. .It Em SEE ALSO References other manuals with related topics. This section should exist for most manuals. diff --git a/share/man/man7/mdoc.7 b/share/man/man7/mdoc.7 index 845c7e1710c..2f5a0627763 100644 --- a/share/man/man7/mdoc.7 +++ b/share/man/man7/mdoc.7 @@ -1,4 +1,4 @@ -.\" $OpenBSD: mdoc.7,v 1.107 2014/01/24 22:54:30 schwarze Exp $ +.\" $OpenBSD: mdoc.7,v 1.108 2014/02/16 14:26:51 schwarze Exp $ .\" .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> .\" Copyright (c) 2010, 2011, 2013 Ingo Schwarze <schwarze@openbsd.org> @@ -15,7 +15,7 @@ .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" -.Dd $Mdocdate: January 24 2014 $ +.Dd $Mdocdate: February 16 2014 $ .Dt MDOC 7 .Os .Sh NAME @@ -125,7 +125,7 @@ file for a utility \&.Nm progname \&.Nd one line about what it does \&.\e\(dq .Sh LIBRARY -\&.\e\(dq For sections 2, 3, & 9 only. +\&.\e\(dq For sections 2, 3, and 9 only. \&.\e\(dq Not used in OpenBSD. \&.Sh SYNOPSIS \&.Nm progname @@ -138,17 +138,17 @@ utility processes files ... \&.\e\(dq .Sh IMPLEMENTATION NOTES \&.\e\(dq Not used in OpenBSD. \&.\e\(dq .Sh RETURN VALUES -\&.\e\(dq For sections 2, 3, & 9 only. +\&.\e\(dq For sections 2, 3, and 9 function return values only. \&.\e\(dq .Sh ENVIRONMENT -\&.\e\(dq For sections 1, 6, 7, & 8 only. +\&.\e\(dq For sections 1, 6, 7, and 8 only. \&.\e\(dq .Sh FILES \&.\e\(dq .Sh EXIT STATUS -\&.\e\(dq For sections 1, 6, & 8 only. +\&.\e\(dq For sections 1, 6, and 8 only. \&.\e\(dq .Sh EXAMPLES \&.\e\(dq .Sh DIAGNOSTICS -\&.\e\(dq For sections 1, 4, 6, 7, & 8 only. +\&.\e\(dq For sections 1, 4, 6, 7, 8, and 9 printf/stderr messages only. \&.\e\(dq .Sh ERRORS -\&.\e\(dq For sections 2, 3, & 9 only. +\&.\e\(dq For sections 2, 3, 4, and 9 errno settings only. \&.\e\(dq .Sh SEE ALSO \&.\e\(dq .Xr foobar 1 \&.\e\(dq .Sh STANDARDS @@ -358,8 +358,12 @@ Example usages. This often contains snippets of well-formed, well-tested invocations. Make sure that examples work properly! .It Em DIAGNOSTICS -Documents error conditions. -This is most useful in section 4 manuals. +Documents error messages. +In section 4 and 9 manuals, these are usually messages printed by the +kernel to the console and to the kernel log. +In section 1, 6, 7, and 8, these are usually messages printed by +userland programs to the standard error output. +.Pp Historically, this section was used in place of .Em EXIT STATUS for manuals in sections 1, 6, and 8; however, this practise is @@ -369,7 +373,9 @@ See .Sx \&Bl .Fl diag . .It Em ERRORS -Documents error handling in sections 2, 3, and 9. +Documents +.Xr errno 2 +settings in sections 2, 3, 4, and 9. .Pp See .Sx \&Er . diff --git a/share/misc/mdoc.template b/share/misc/mdoc.template index 56ab6e6a1e0..98d1d58b042 100644 --- a/share/misc/mdoc.template +++ b/share/misc/mdoc.template @@ -1,4 +1,4 @@ -.\" $OpenBSD: mdoc.template,v 1.13 2012/09/06 01:01:58 tedu Exp $ +.\" $OpenBSD: mdoc.template,v 1.14 2014/02/16 14:26:51 schwarze Exp $ .\" .\" Copyright (c) YYYY YOUR NAME HERE <user@your.dom.ain> .\" @@ -36,15 +36,15 @@ utility processes files ... .\" .Sh RETURN VALUES .\" For sections 2, 3, and 9 function return values only. .\" .Sh ENVIRONMENT -.\" For sections 1, 6, 7 & 8 only. +.\" For sections 1, 6, 7, and 8 only. .\" .Sh FILES .\" .Sh EXIT STATUS -.\" For sections 1, 6, & 8 only. +.\" For sections 1, 6, and 8 only. .\" .Sh EXAMPLES .\" .Sh DIAGNOSTICS -.\" For sections 1, 4, 6, 7, and 8 only. +.\" For sections 1, 4, 6, 7, 8, and 9 printf/stderr messages only. .\" .Sh ERRORS -.\" For sections 2, 3, and 9 error and signal handling only. +.\" For sections 2, 3, 4, and 9 errno settings only. .\" .Sh SEE ALSO .\" .Xr foobar 1 .\" .Sh STANDARDS diff --git a/usr.bin/mandoc/mdoc_validate.c b/usr.bin/mandoc/mdoc_validate.c index 2ad5c5ff6b5..bae8ea76ee4 100644 --- a/usr.bin/mandoc/mdoc_validate.c +++ b/usr.bin/mandoc/mdoc_validate.c @@ -1,4 +1,4 @@ -/* $Id: mdoc_validate.c,v 1.120 2014/01/11 22:16:03 schwarze Exp $ */ +/* $Id: mdoc_validate.c,v 1.121 2014/02/16 14:26:51 schwarze Exp $ */ /* * Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv> * Copyright (c) 2010-2014 Ingo Schwarze <schwarze@openbsd.org> @@ -2038,9 +2038,11 @@ post_sh_head(POST_ARGS) assert(mdoc->meta.msec); switch (sec) { - case (SEC_RETURN_VALUES): - /* FALLTHROUGH */ case (SEC_ERRORS): + if (*mdoc->meta.msec == '4') + break; + /* FALLTHROUGH */ + case (SEC_RETURN_VALUES): /* FALLTHROUGH */ case (SEC_LIBRARY): if (*mdoc->meta.msec == '2') |