- Change variable name to 'error', as this is what is mostly used for
functions that return an error.
- Add mutex(9) to the SEE ALSO section.
- Bump the date.
I don't really like the example code. I'd prefer symmetry where possible, eg.
mtx_lock(&example_lock);
error = example(NULL, EXAMPLE_ONE);
mtx_unlock(&example_lock);
if (error != 0)
return (error);
But I'll leave it as it is for now.
Reviewed by: simon
is not interesting, when the driver appeared is. Most people who use this
example leave the manpage appearance date in and the driver date out.
MFC after: 3 days
FreeBSD manual pages:
- POSIX-copyright contains copyright text to be used in manual pages
which has POSIX text inserted.
- deshallify.sh is a shell script which removes many of the ``shall''
statements from the POSIX text and therefore making the text more
readable.
Real work to make this happen by: nectar, ru
Fixed bad example of how to start a new sentence.
Added missing punctuation.
Fixed cut-n-paste error in the STANDARDS section.
Mention modern POSIX and C standards.
should not use a `%' in examples.
I don't know if this is the consensus of doc@, or just a unilateral decision
of committer that corrected my following of this example. Maybe a docs
person could review these files and see if they still show current guidelines.
to have the $FreeBSD$ keyword, as this is now enforced
by the CVSROOT/commit_prep.pl script.
Fold multi-word macro arguments into a single argument
by putting the surrounding double quotes - this speeds
up the -mdoc processing drastically (of course if used
systematically).
Use the new features of -mdoc: exact -width specifiers,
.In macro as an ``.Fd #include'' replacement.
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
Add all of the possible errno's to example.3.
Show examples of the .Bx (BSD) and .At (AT&T UNIX) macros
in the various HISTORY sections.
Add some .Rs/.Re (used for referencing things other
than man pages) in the SEE ALSO sections.
Suggested by: wollman
