Documenting locking requirements in section 9 manual pages

Giorgos Keramidas keramida at FreeBSD.org
Wed Jan 12 17:12:14 UTC 2005


On 2005-01-12 13:14, "Simon L. Nielsen" <simon at freebsd.org> wrote:
>On 2005.01.12 13:29:23 +0200, Ruslan Ermilov wrote:
>>On Wed, Jan 12, 2005 at 02:30:19AM +0000, Joseph Koshy wrote:
>>> Do we have a standard place in our section 9 manual page format
>>> to describe locking requirements of kernel interfaces?
>>>
>>> What do folks think of a ".Sh LOCKING" section like
>>> the existing ".Sh RETURN VALUES"?
>>
>> I think this is important enough to be worth a separate section.
>> Fine with me.  Make sure to update share/examples/mdoc/example.9
>> if you go this way.
>
> Actually we don't have a section 9 example, only 1, 3, and 4.  I guess
> it should be fairly simple for somebody to make an example.9 based on
> one of the other pages.

Shamelessly copied from example.3, how does the following look?

	http://people.freebsd.org/~keramida/example.9

- Giorgos



More information about the freebsd-doc mailing list