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

We don't use the "pseudo-device" configuration option any longer,

Browse Source 
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
This commit is contained in:
Mike Pritchard 2001-04-05 09:37:55 +00:00
parent 34702f7e67
commit 0a0869f618
Notes: svn2git 2020-12-20 02:59:44 +00:00 
svn path=/head/; revision=75228
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
share/examples/mdoc/example.4
View File

@ -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