[PATCH] man3/pthread_c-z,pu*.3: srcfix: Use a single-font-style macro for a single argument

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



  Use a single-font-style macro (".B", ".I") for a single argument.

  Remove unneeded quotation marks (").

  Separate the "()" from the name of a function.

  The output from "nroff" and "groff" is unchanged, except for the style
of "()" in the file "pthread_mutex_consistent.3".

Signed-off-by: Bjarni Ingi Gislason <bjarniig@xxxxxxxxx>
---
 man3/pthread_cancel.3                |  6 +++---
 man3/pthread_cleanup_push.3          |  2 +-
 man3/pthread_create.3                | 14 +++++++-------
 man3/pthread_detach.3                |  2 +-
 man3/pthread_exit.3                  |  2 +-
 man3/pthread_getattr_default_np.3    |  6 +++---
 man3/pthread_getattr_np.3            |  4 ++--
 man3/pthread_join.3                  |  2 +-
 man3/pthread_mutex_consistent.3      |  6 +++---
 man3/pthread_mutexattr_getpshared.3  |  6 +++---
 man3/pthread_mutexattr_setrobust.3   | 10 +++++-----
 man3/pthread_rwlockattr_setkind_np.3 |  4 ++--
 man3/pthread_self.3                  |  2 +-
 man3/pthread_setaffinity_np.3        |  4 ++--
 man3/pthread_setconcurrency.3        |  4 ++--
 man3/pthread_setname_np.3            |  2 +-
 man3/pthread_setschedparam.3         |  8 ++++----
 man3/pthread_spin_init.3             |  2 +-
 man3/pthread_tryjoin_np.3            |  6 +++---
 man3/pthread_yield.3                 |  4 ++--
 man3/putgrent.3                      |  4 ++--
 man3/putwchar.3                      |  2 +-
 22 files changed, 51 insertions(+), 51 deletions(-)

diff --git a/man3/pthread_cancel.3 b/man3/pthread_cancel.3
index f6c50ec66..0e3ef3d6e 100644
--- a/man3/pthread_cancel.3
+++ b/man3/pthread_cancel.3
@@ -62,9 +62,9 @@ then its cancelability type determines when cancellation occurs.
 A thread's cancellation type, determined by
 .BR pthread_setcanceltype (3),
 may be either
-.IR asynchronous
+.I asynchronous
 or
-.IR deferred
+.I deferred
 (the default for new threads).
 Asynchronous cancelability
 means that the thread can be canceled at any time
@@ -76,7 +76,7 @@ A list of functions that are or may be cancellation points is provided in
 .BR pthreads (7).
 .PP
 When a cancellation requested is acted on, the following steps occur for
-.IR thread
+.I thread
 (in this order):
 .IP 1. 3
 Cancellation clean-up handlers are popped
diff --git a/man3/pthread_cleanup_push.3 b/man3/pthread_cleanup_push.3
index f22907d87..5ff9d8a8a 100644
--- a/man3/pthread_cleanup_push.3
+++ b/man3/pthread_cleanup_push.3
@@ -159,7 +159,7 @@ says that the effect of using
 .IR break ,
 .IR continue ,
 or
-.IR goto
+.I goto
 to prematurely leave a block bracketed
 .BR pthread_cleanup_push ()
 and
diff --git a/man3/pthread_create.3 b/man3/pthread_create.3
index 6ada96a40..713c5c4dd 100644
--- a/man3/pthread_create.3
+++ b/man3/pthread_create.3
@@ -41,7 +41,7 @@ The
 function starts a new thread in the calling process.
 The new thread starts execution by invoking
 .IR start_routine ();
-.IR arg
+.I arg
 is passed as the sole argument of
 .IR start_routine ().
 .PP
@@ -117,7 +117,7 @@ On success,
 .BR pthread_create ()
 returns 0;
 on error, it returns an error number, and the contents of
-.IR *thread
+.I *thread
 are undefined.
 .SH ERRORS
 .TP
@@ -128,7 +128,7 @@ Insufficient resources to create another thread.
 .\" NOTE! The following should match the description in fork(2)
 A system-imposed limit on the number of threads was encountered.
 There are a number of limits that may trigger this error: the
-.BR RLIMIT_NPROC
+.B RLIMIT_NPROC
 soft resource limit (set via
 .BR setrlimit (2)),
 which limits the number of processes and threads for a real user ID,
@@ -169,7 +169,7 @@ POSIX.1-2001, POSIX.1-2008.
 See
 .BR pthread_self (3)
 for further information on the thread ID returned in
-.IR *thread
+.I *thread
 by
 .BR pthread_create ().
 Unless real-time scheduling policies are being employed,
@@ -199,9 +199,9 @@ was set to create the thread in a detached state (using
 .BR pthread_attr_setdetachstate (3)).
 .PP
 Under the NPTL threading implementation, if the
-.BR RLIMIT_STACK
+.B RLIMIT_STACK
 soft resource limit
-.IR "at the time the program started"
+.I at the time the program started
 has any value other than "unlimited",
 then it determines the default stack size of new threads.
 Using
@@ -211,7 +211,7 @@ the stack size attribute can be explicitly set in the
 argument used to create a thread,
 in order to obtain a stack size other than the default.
 If the
-.BR RLIMIT_STACK
+.B RLIMIT_STACK
 resource limit is set to "unlimited",
 a per-architecture value is used for the stack size.
 Here is the value for a few architectures:
diff --git a/man3/pthread_detach.3 b/man3/pthread_detach.3
index 84b9757db..efb869812 100644
--- a/man3/pthread_detach.3
+++ b/man3/pthread_detach.3
@@ -38,7 +38,7 @@ Compile and link with \fI\-pthread\fP.
 The
 .BR pthread_detach ()
 function marks the thread identified by
-.IR thread
+.I thread
 as detached.
 When a detached thread terminates,
 its resources are automatically released back to the system without
diff --git a/man3/pthread_exit.3 b/man3/pthread_exit.3
index 8d503fc5f..deb99ca97 100644
--- a/man3/pthread_exit.3
+++ b/man3/pthread_exit.3
@@ -99,7 +99,7 @@ rather than
 .BR exit (3).
 .PP
 The value pointed to by
-.IR retval
+.I retval
 should not be located on the calling thread's stack,
 since the contents of that stack are undefined after the thread terminates.
 .SH BUGS
diff --git a/man3/pthread_getattr_default_np.3 b/man3/pthread_getattr_default_np.3
index 560943994..48f59e3c4 100644
--- a/man3/pthread_getattr_default_np.3
+++ b/man3/pthread_getattr_default_np.3
@@ -51,11 +51,11 @@ Note the following details about the supplied attributes object:
 The attribute settings in the object must be valid.
 .IP *
 The
-.IR "stack address"
+.I stack address
 attribute must not be set in the object.
 .IP *
 Setting the
-.IR "stack size"
+.I stack size
 attribute to zero means leave the default stack size unchanged.
 .PP
 The
@@ -68,7 +68,7 @@ so that it contains the default attributes used for thread creation.
 .B EINVAL
 .RB ( pthread_setattr_default_np ())
 One of the attribute settings in
-.IR attr
+.I attr
 is invalid, or the stack address attribute is set in
 .IR attr .
 .TP
diff --git a/man3/pthread_getattr_np.3 b/man3/pthread_getattr_np.3
index 253a1aca5..3fc3eface 100644
--- a/man3/pthread_getattr_np.3
+++ b/man3/pthread_getattr_np.3
@@ -86,12 +86,12 @@ refers to the main thread, then
 can fail because of errors from various underlying calls:
 .BR fopen (3),
 if
-.IR /proc/self/maps
+.I /proc/self/maps
 can't be opened;
 and
 .BR getrlimit (2),
 if the
-.BR RLIMIT_STACK
+.B RLIMIT_STACK
 resource limit is not supported.
 .SH VERSIONS
 This function is available in glibc since version 2.2.3.
diff --git a/man3/pthread_join.3 b/man3/pthread_join.3
index 2245225de..5a1dc5dd5 100644
--- a/man3/pthread_join.3
+++ b/man3/pthread_join.3
@@ -38,7 +38,7 @@ Compile and link with \fI\-pthread\fP.
 The
 .BR pthread_join ()
 function waits for the thread specified by
-.IR thread
+.I thread
 to terminate.
 If that thread has already terminated, then
 .BR pthread_join ()
diff --git a/man3/pthread_mutex_consistent.3 b/man3/pthread_mutex_consistent.3
index 579a20bd0..8a9f393ec 100644
--- a/man3/pthread_mutex_consistent.3
+++ b/man3/pthread_mutex_consistent.3
@@ -53,12 +53,12 @@ state.
 A mutex can be left in an inconsistent state if its owner terminates
 while holding the mutex, in which case the next owner who acquires the
 mutex will succeed and be notified by a return value of
-.BR EOWNERDEAD
+.B EOWNERDEAD
 from a call to
 .BR pthread_mutex_lock ().
 .SH RETURN VALUE
 On success,
-.IR pthread_mutex_consistent()
+.IR pthread_mutex_consistent ()
 returns 0.
 Otherwise,
 it returns a positive error number to indicate the cause of the error.
@@ -84,7 +84,7 @@ Before the addition of
 .BR pthread_mutex_consistent ()
 to POSIX,
 glibc defined the following equivalent nonstandard function if
-.BR _GNU_SOURCE
+.B _GNU_SOURCE
 was defined:
 .PP
 .nf
diff --git a/man3/pthread_mutexattr_getpshared.3 b/man3/pthread_mutexattr_getpshared.3
index 2fd48012e..5dd57d3a7 100644
--- a/man3/pthread_mutexattr_getpshared.3
+++ b/man3/pthread_mutexattr_getpshared.3
@@ -58,14 +58,14 @@ including threads in different processes.
 .BR pthread_mutexattr_getpshared ()
 places the value of the process-shared attribute of
 the mutex attributes object referred to by
-.IR attr
+.I attr
 in the location pointed to by
 .IR pshared .
 .PP
 .BR pthread_mutexattr_setpshared ()
 sets the value of the process-shared attribute of
 the mutex attributes object referred to by
-.IR attr
+.I attr
 to the value specified in
 .BR pshared .
 .PP
@@ -87,7 +87,7 @@ is invalid.
 .TP
 .B ENOTSUP
 .I pshared is
-.BR PTHREAD_PROCESS_SHARED
+.B PTHREAD_PROCESS_SHARED
 but the implementation does not support process-shared mutexes.
 .SH CONFORMING TO
 POSIX.1-2001, POSIX.1-2008.
diff --git a/man3/pthread_mutexattr_setrobust.3 b/man3/pthread_mutexattr_setrobust.3
index 47d9c6686..dc4dc16b7 100644
--- a/man3/pthread_mutexattr_setrobust.3
+++ b/man3/pthread_mutexattr_setrobust.3
@@ -75,10 +75,10 @@ the owning thread dies without unlocking the mutex.
 The following values are valid for
 .IR robustness :
 .TP
-.BR PTHREAD_MUTEX_STALLED
+.B PTHREAD_MUTEX_STALLED
 This is the default value for a mutex attributes object.
 If a mutex is initialized with the
-.BR PTHREAD_MUTEX_STALLED
+.B PTHREAD_MUTEX_STALLED
 attribute and its owner dies without unlocking it,
 the mutex remains locked afterwards and any future attempts to call
 .BR pthread_mutex_lock (3)
@@ -86,7 +86,7 @@ on the mutex will block indefinitely.
 .TP
 .B PTHREAD_MUTEX_ROBUST
 If a mutex is initialized with the
-.BR PTHREAD_MUTEX_ROBUST
+.B PTHREAD_MUTEX_ROBUST
 attribute and its owner dies without unlocking it,
 any future attempts to call
 .BR pthread_mutex_lock (3)
@@ -118,7 +118,7 @@ operations on this mutex will still return
 .BR EOWNERDEAD .
 .PP
 Note that the
-.IR attr
+.I attr
 argument of
 .BR pthread_mutexattr_getrobust ()
 and
@@ -167,7 +167,7 @@ and
 .BR pthread_mutexattr_setrobust ()
 to POSIX,
 glibc defined the following equivalent nonstandard functions if
-.BR _GNU_SOURCE
+.B _GNU_SOURCE
 was defined:
 .PP
 .nf
diff --git a/man3/pthread_rwlockattr_setkind_np.3 b/man3/pthread_rwlockattr_setkind_np.3
index 892b461f4..5e0d028a7 100644
--- a/man3/pthread_rwlockattr_setkind_np.3
+++ b/man3/pthread_rwlockattr_setkind_np.3
@@ -114,7 +114,7 @@ The
 .BR pthread_rwlockattr_getkind_np ()
 function returns the value of the lock kind attribute of the
 read-write lock attribute object referred to by
-.IR attr
+.I attr
 in the pointer
 .IR pref .
 .SH RETURN VALUE
@@ -127,7 +127,7 @@ On error,
 returns a nonzero error number.
 .SH ERRORS
 .TP
-.BR EINVAL
+.B EINVAL
 .I pref
 specifies an unsupported value.
 .SH VERSIONS
diff --git a/man3/pthread_self.3 b/man3/pthread_self.3
index d73622d64..dea6b74a7 100644
--- a/man3/pthread_self.3
+++ b/man3/pthread_self.3
@@ -39,7 +39,7 @@ The
 .BR pthread_self ()
 function returns the ID of the calling thread.
 This is the same value that is returned in
-.IR *thread
+.I *thread
 in the
 .BR pthread_create (3)
 call that created this thread.
diff --git a/man3/pthread_setaffinity_np.3 b/man3/pthread_setaffinity_np.3
index 8c664aa0b..7b4ced1a6 100644
--- a/man3/pthread_setaffinity_np.3
+++ b/man3/pthread_setaffinity_np.3
@@ -91,12 +91,12 @@ and permitted to the thread according to any restrictions that
 may be imposed by the "cpuset" mechanism described in
 .BR cpuset (7).
 .TP
-.BR EINVAL
+.B EINVAL
 .RB ( pthread_setaffinity_np ())
 .I cpuset
 specified a CPU that was outside the set supported by the kernel.
 (The kernel configuration option
-.BR CONFIG_NR_CPUS
+.B CONFIG_NR_CPUS
 defines the range of the set supported by the kernel data type
 .\" cpumask_t
 used to represent CPU sets.)
diff --git a/man3/pthread_setconcurrency.3 b/man3/pthread_setconcurrency.3
index f1b07aad1..2a596f410 100644
--- a/man3/pthread_setconcurrency.3
+++ b/man3/pthread_setconcurrency.3
@@ -31,7 +31,7 @@ the concurrency level
 .B #include <pthread.h>
 .PP
 .BI "int pthread_setconcurrency(int " new_level );
-.BI "int pthread_getconcurrency(void);
+.B int pthread_getconcurrency(void);
 .PP
 Compile and link with \fI\-pthread\fP.
 .fi
@@ -74,7 +74,7 @@ can fail with the following error:
 is negative.
 .PP
 POSIX.1 also documents an
-.BR EAGAIN
+.B EAGAIN
 error ("the value specified by
 .I new_level
 would cause a system resource to be exceeded").
diff --git a/man3/pthread_setname_np.3 b/man3/pthread_setname_np.3
index 4e6cc5b5e..5cdb32c9f 100644
--- a/man3/pthread_setname_np.3
+++ b/man3/pthread_setname_np.3
@@ -121,7 +121,7 @@ hence the suffix "_np" (nonportable) in the names.
 internally writes to the thread-specific
 .I comm
 file under the
-.IR /proc
+.I /proc
 filesystem:
 .IR /proc/self/task/[tid]/comm .
 .BR pthread_getname_np ()
diff --git a/man3/pthread_setschedparam.3 b/man3/pthread_setschedparam.3
index 012b503a3..499e06944 100644
--- a/man3/pthread_setschedparam.3
+++ b/man3/pthread_setschedparam.3
@@ -168,11 +168,11 @@ as well as the use of a number of other scheduling-related
 pthreads functions.
 .PP
 In the following run, the main thread sets its scheduling policy to
-.BR SCHED_FIFO
+.B SCHED_FIFO
 with a priority of 10,
 and initializes a thread attributes object with
 a scheduling policy attribute of
-.BR SCHED_RR
+.B SCHED_RR
 and a scheduling priority attribute of 20.
 The program then sets (using
 .BR pthread_attr_setinheritsched (3))
@@ -230,9 +230,9 @@ were taken from the creating thread,
 rather than the thread attributes object.
 .PP
 Note that if we had omitted the
-.IR "\-i\ i"
+.I \-i\ i
 option, the output would have been the same, since
-.BR PTHREAD_INHERIT_SCHED
+.B PTHREAD_INHERIT_SCHED
 is the default for the inherit scheduler attribute.
 .SS Program source
 \&
diff --git a/man3/pthread_spin_init.3 b/man3/pthread_spin_init.3
index 3018d804a..4fdbee834 100644
--- a/man3/pthread_spin_init.3
+++ b/man3/pthread_spin_init.3
@@ -139,7 +139,7 @@ real-time scheduling policies
 or possibly
 .BR SCHED_RR ).
 Use of spin locks with nondeterministic scheduling policies such as
-.BR SCHED_OTHER
+.B SCHED_OTHER
 probably indicates a design mistake.
 The problem is that if a thread operating under such a policy
 is scheduled off the CPU while it holds a spin lock,
diff --git a/man3/pthread_tryjoin_np.3 b/man3/pthread_tryjoin_np.3
index bba7b51f1..71b85d638 100644
--- a/man3/pthread_tryjoin_np.3
+++ b/man3/pthread_tryjoin_np.3
@@ -99,17 +99,17 @@ had not yet terminated at the time of the call.
 .BR pthread_timedjoin_np ()
 can in addition fail with the following errors:
 .TP
-.BR ETIMEDOUT
+.B ETIMEDOUT
 The call timed out before
 .I thread
 terminated.
 .TP
-.BR EINVAL
+.B EINVAL
 .I abstime
 value is invalid
 .RI ( tv_sec
 is less than 0 or
-.IR tv_nsec
+.I  tv_nsec
 is greater than 1e9).
 .PP
 .BR pthread_timedjoin_np ()
diff --git a/man3/pthread_yield.3 b/man3/pthread_yield.3
index 8e3974826..6bde70931 100644
--- a/man3/pthread_yield.3
+++ b/man3/pthread_yield.3
@@ -74,13 +74,13 @@ On Linux, this function is implemented as a call to
 .PP
 .BR pthread_yield ()
 is intended for use with real-time scheduling policies (i.e.,
-.BR SCHED_FIFO
+.B SCHED_FIFO
 or
 .BR SCHED_RR ).
 Use of
 .BR pthread_yield ()
 with nondeterministic scheduling policies such as
-.BR SCHED_OTHER
+.B SCHED_OTHER
 is unspecified and very likely means your application design is broken.
 .SH SEE ALSO
 .BR sched_yield (2),
diff --git a/man3/putgrent.3 b/man3/putgrent.3
index b8fd36167..6738fb678 100644
--- a/man3/putgrent.3
+++ b/man3/putgrent.3
@@ -19,13 +19,13 @@ The
 function is the counterpart for
 .BR fgetgrent (3).
 The function writes the content of the provided
-.IR "struct group"
+.I struct group
 into the
 .IR stream .
 The list of group members must be NULL-terminated or NULL-initialized.
 .PP
 The
-.IR "struct group"
+.I struct group
 is defined as follows:
 .PP
 .in +4n
diff --git a/man3/putwchar.3 b/man3/putwchar.3
index 53f51842b..06eda11d9 100644
--- a/man3/putwchar.3
+++ b/man3/putwchar.3
@@ -39,7 +39,7 @@ becomes true, it returns
 .BR WEOF .
 If a wide character
 conversion error occurs, it sets
-.IR errno
+.I errno
 to
 .B EILSEQ
 and returns
-- 
2.20.1



[Index of Archives]     [Kernel Documentation]     [Netdev]     [Linux Ethernet Bridging]     [Linux Wireless]     [Kernel Newbies]     [Security]     [Linux for Hams]     [Netfilter]     [Bugtraq]     [Yosemite News]     [MIPS Linux]     [ARM Linux]     [Linux RAID]     [Linux Admin]     [Samba]

  Powered by Linux