diff options
| author | Mike Pritchard <mpp@FreeBSD.org> | 2001-04-05 09:37:55 +0000 |
|---|---|---|
| committer | Mike Pritchard <mpp@FreeBSD.org> | 2001-04-05 09:37:55 +0000 |
| commit | 0a0869f618e3c9aac64014907827d1faa7fe3f12 (patch) | |
| tree | 9b6c28bfb739b1a241e2605def69861a48396f75 /share | |
| parent | 34702f7e67dca759d4b274fa6f28af1577d09f8d (diff) | |
| download | src-0a0869f618e3c9aac64014907827d1faa7fe3f12.tar.gz src-0a0869f618e3c9aac64014907827d1faa7fe3f12.zip | |
We don't use the "pseudo-device" configuration option any longer,
so update the example to use the correct definition.
Add an example for documenting kernel compile options, along with
a small example of how to reference them in the main text of the
man page (I.e. the .Dv macro).
Inspired-by: a brief exchange I saw in in the commit messages mail
Notes
Notes:
svn path=/head/; revision=75228
Diffstat (limited to 'share')
| -rw-r--r-- | share/examples/mdoc/example.4 | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/share/examples/mdoc/example.4 b/share/examples/mdoc/example.4 index fe889fd4c681..2d950a95e99a 100644 --- a/share/examples/mdoc/example.4 +++ b/share/examples/mdoc/example.4 @@ -39,7 +39,8 @@ .Nm example .Nd example device driver manual page .Sh SYNOPSIS -.Cd pseudo-device example +.Cd device example +.Cd options EXAMPLE_DEBUG .Sh DESCRIPTION This is an example device driver manual page for the @@ -57,6 +58,10 @@ Example ioctl. .It Dv EIOCNULL Example ioctl. .El +.Pp +If the kernel is compiled with the +.Dv EXAMPLE_DEBUG +option, then additional debugging messages will be displayed. .Sh FILES .Bl -tag -width /dev/null -compact .It Pa /dev/null |