summaryrefslogtreecommitdiff
path: root/share/man/man7
diff options
context:
space:
mode:
authorDavid Gwynne <dlg@cvs.openbsd.org>2014-03-30 23:57:44 +0000
committerDavid Gwynne <dlg@cvs.openbsd.org>2014-03-30 23:57:44 +0000
commitc866c332c53011e4fb5d07e8965bf00902248a9b (patch)
treee914fa7deb3aa93b88bdde4499b3fb121ca82898 /share/man/man7
parent1460ec2fcd99a7d904be4f2a22d54bcc0d8c4b05 (diff)
i suggested a CONTEXT section for kernel manpages that describes
which contexts you can call functions in. deraadt@ encouraged me to pursue it. ive applied it to a few pages and i think it is worth moving forward with. this specific diff was requested by schwartz@ while we were discussing it before 5.5. tweaks from jmc@ schwartz@ ok schwartz@
Diffstat (limited to 'share/man/man7')
-rw-r--r--share/man/man7/man.79
-rw-r--r--share/man/man7/mdoc.79
2 files changed, 14 insertions, 4 deletions
diff --git a/share/man/man7/man.7 b/share/man/man7/man.7
index 3eae777f471..61e10fc3e47 100644
--- a/share/man/man7/man.7
+++ b/share/man/man7/man.7
@@ -1,4 +1,4 @@
-.\" $OpenBSD: man.7,v 1.37 2014/02/16 14:26:51 schwarze Exp $
+.\" $OpenBSD: man.7,v 1.38 2014/03/30 23:57:43 dlg 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 16 2014 $
+.Dd $Mdocdate: March 30 2014 $
.Dt MAN 7
.Os
.Sh NAME
@@ -106,6 +106,8 @@ file for a utility
\efBprogname\efR [\efB\e-options\efR] \efIfile ...\efR
\&.SH DESCRIPTION
The \efBfoo\efR utility processes files ...
+\&.\e\(dq .Sh CONTEXT
+\&.\e\(dq For section 9 functions only.
\&.\e\(dq .SH IMPLEMENTATION NOTES
\&.\e\(dq Not used in OpenBSD.
\&.\e\(dq .SH RETURN VALUES
@@ -171,6 +173,9 @@ This expands upon the brief, one-line description in
.Em NAME .
It usually contains a break-down of the options (if documenting a
command).
+.It Em CONTEXT
+This section lists the contexts in which functions can be called in section 9.
+The contexts are autoconf, process, or interrupt.
.It Em IMPLEMENTATION NOTES
Implementation-specific notes should be kept here.
This is useful when implementing standard functions that may have side
diff --git a/share/man/man7/mdoc.7 b/share/man/man7/mdoc.7
index 9d327766880..1b39102ee22 100644
--- a/share/man/man7/mdoc.7
+++ b/share/man/man7/mdoc.7
@@ -1,4 +1,4 @@
-.\" $OpenBSD: mdoc.7,v 1.109 2014/03/18 22:36:31 miod Exp $
+.\" $OpenBSD: mdoc.7,v 1.110 2014/03/30 23:57:43 dlg 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: March 18 2014 $
+.Dd $Mdocdate: March 30 2014 $
.Dt MDOC 7
.Os
.Sh NAME
@@ -135,6 +135,8 @@ file for a utility
The
\&.Nm
utility processes files ...
+\&.\e\(dq .Sh CONTEXT
+\&.\e\(dq For section 9 functions only.
\&.\e\(dq .Sh IMPLEMENTATION NOTES
\&.\e\(dq Not used in OpenBSD.
\&.\e\(dq .Sh RETURN VALUES
@@ -318,6 +320,9 @@ macro followed by a non-standard section name, and each having
several subsections, like in the present
.Nm
manual.
+.It Em CONTEXT
+This section lists the contexts in which functions can be called in section 9.
+The contexts are autoconf, process, or interrupt.
.It Em IMPLEMENTATION NOTES
Implementation-specific notes should be kept here.
This is useful when implementing standard functions that may have side