diff options
| author | mpp <mpp@FreeBSD.org> | 2001-04-05 09:37:55 +0000 |
|---|---|---|
| committer | mpp <mpp@FreeBSD.org> | 2001-04-05 09:37:55 +0000 |
| commit | d86e39313640f3a555e31f18510c9bd25313d504 (patch) | |
| tree | f5a3ff268f02b517f29bbe48ca2cd37d76c54148 /share/examples/mdoc | |
| parent | 5b73c24bc3f0e966e06ab1628e2e3eb726128b24 (diff) | |
| download | FreeBSD-src-d86e39313640f3a555e31f18510c9bd25313d504.zip FreeBSD-src-d86e39313640f3a555e31f18510c9bd25313d504.tar.gz | |
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
Diffstat (limited to 'share/examples/mdoc')
| -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 fe889fd..2d950a9 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 |
