d/freebsd-nq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Move the LOCKING section to before the EXAMPLES section.

Browse Source 
Make example locking calls in the EXAMPLES section.

Reviewed by:	keramida
This commit is contained in:
Joseph Koshy 2005-01-15 16:01:19 +00:00
parent 1b7525eb4b
commit bff0341efe
1 changed files with 22 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
share/examples/mdoc/example.9
View File

@ -33,11 +33,11 @@
.Nm example
.Nd "example kernel interface manual page"
.Sh SYNOPSIS
.In example.h
.In sys/example.h
.Ft int
.Fn example "char *ptr" "int mode"
.Sh DESCRIPTION
This is an example library function manual page for the
This is an example manual page for the
.Fn example
kernel function.
It is intended that this example can be used as a template
@ -72,6 +72,21 @@ as follows:
The
.Fn example
function is not actually implemented.
.Sh LOCKING
The
.Va example_lock
lock must be held before
.Fn example
is called.
.Pp
Since
.Va example_lock
is a
.Xr mutex 9 ,
no sleepable locks (i.e.,
.Xr sx 9
locks) can be acquired in
.Fn example .
.Sh RETURN VALUES
The
.Fn example
@ -83,8 +98,12 @@ section is returned, to indicate the error.
.Bd -literal
int val;
if ((val = example(NULL, EXAMPLE_ONE)) != 0)
mutex_lock(&example_lock);
if ((val = example(NULL, EXAMPLE_ONE)) != 0) {
mutex_unlock(&example_lock);
return (val);
}
mutex_unlock(&example_lock);
.Ed
.Sh COMPATIBILITY
The
@ -275,21 +294,6 @@ Attribute not found.
.It Bq Er EDOOFUS
Programming error.
.El
.Sh LOCKING
The
.Va example_lock
lock must be held before
.Fn example
is called.
.Pp
Since
.Va example_lock
is a
.Xr mutex 9 ,
no sleepable locks (i.e.,
.Xr sx 9
locks) can be acquired in
.Fn example .
.Sh SEE ALSO
.Xr example 1 ,
.Xr example 3 ,