Project

General

Profile

Bug #4327

rwlock(3c): Formatting issues and typos

Added by Marcel Telka over 5 years ago. Updated over 5 years ago.

Status:
Resolved
Priority:
Low
Assignee:
Category:
manpage - manual pages
Start date:
2013-11-14
Due date:
% Done:

100%

Estimated time:
Difficulty:
Bite-size
Tags:

Description

The first occurrence of "rwlock_init()" in the following paragraph in the rwlock(3c) man page is strange:

     Additionally, readers/writer locks must be initialized prior
     to use.  rwlock_init() The readers/writer lock pointed to by
     rwlp is initialized by  rwlock_init(). A readers/writer lock
     is  capable  of  having  several types of behavior, which is
     specified by type. arg is currently  not  used,  although  a
     future  type  may  define  new behavior parameters by way of
     arg.

In addition, "type" is sometimes italicized and sometimes bold in the man page. It should be always italic.

History

#1

Updated by Marcel Telka over 5 years ago

Extra space before "arg" should be removed here:

     int rwlock_init(rwlock_t *rwlp, int type, void * arg);

s/trys/tries/ (twice):

     rw_tryrdlock() trys to get a read lock on the readers/writer
     lock  pointed  to  by  rwlp.  If  the readers/writer lock is
     locked for writing, it returns an error; otherwise, the read
     lock is acquired.

...

     rw_trywrlock()  trys  to   get   a   write   lock   on   the
     readers/writer   lock   pointed   to   by   rwlp.   If   the
     readers/writer lock is currently locked for reading or writ-
     ing, it returns an error.
#2

Updated by Marcel Telka over 5 years ago

Change "reader or writer" to "readers/writer":

     EBUSY
               The reader or writer lock pointed to by  rwlp  was
               already locked.
#3

Updated by Marcel Telka over 5 years ago

  • Subject changed from rwlock(3c): Formatting issues to rwlock(3c): Formatting issues and typos
#4

Updated by Marcel Telka over 5 years ago

  • Category set to manpage - manual pages
  • Status changed from New to In Progress
#5

Updated by Robert Mustacchi over 5 years ago

  • Status changed from In Progress to Resolved
  • Assignee set to Shruti Sampat
  • % Done changed from 0 to 100
  • Tags deleted (needs-triage)

Resolved in baca903af881b9bbe1d691b85c5d3cfbc3e4b6a5.

Also available in: Atom PDF