[PATCH] man2/pe*-po*: srcfix: Use a single-font-change macro for a single argument

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

 



  Use a single-font-change macro for a single argument.

  Remove '.RB' and quotation marks (perf_event_open.2).

  Remove a line only containing '.RB' (pkey_alloc.2).

  The output from "nroff" and "groff" is unchanged, except for one
space character less, that the removed line containing only ".RB'
created (pkey_alloc.2).

Signed-off-by: Bjarni Ingi Gislason <bjarniig@xxxxxxxxx>
---
 man2/perf_event_open.2 | 70 +++++++++++++++++++++---------------------
 man2/personality.2     | 18 +++++------
 man2/pipe.2            | 18 +++++------
 man2/pkey_alloc.2      |  1 -
 man2/posix_fadvise.2   |  2 +-
 5 files changed, 54 insertions(+), 55 deletions(-)

diff --git a/man2/perf_event_open.2 b/man2/perf_event_open.2
index 03bc82d8b..f2fa6b79d 100644
--- a/man2/perf_event_open.2
+++ b/man2/perf_event_open.2
@@ -123,7 +123,7 @@ The leader is created first, with
 The rest of the group members are created with subsequent
 .BR perf_event_open ()
 calls with
-.IR group_fd
+.I group_fd
 being set to the file descriptor of the group leader.
 (A single event on its own is created with
 .IR group_fd " = \-1"
@@ -157,9 +157,9 @@ at the same time as another thread calls
 then
 .BR execve (2).
 .TP
-.BR PERF_FLAG_FD_NO_GROUP
+.B PERF_FLAG_FD_NO_GROUP
 This flag tells the event to ignore the
-.IR group_fd
+.I group_fd
 parameter except for the purpose of setting up output redirection
 using the
 .B PERF_FLAG_FD_OUTPUT
@@ -321,7 +321,7 @@ This indicates a hardware breakpoint as provided by the CPU.
 Breakpoints can be read/write accesses to an address as well as
 execution of an instruction address.
 .TP
-.RB "dynamic PMU"
+dynamic PMU
 Since Linux 2.6.38,
 .\" commit 2e80a82a49c4c7eca4e35734380f28298ba5db19
 .BR perf_event_open ()
@@ -646,11 +646,11 @@ Its parameters are set in other places.
 If
 .I type
 is
-.BR kprobe
+.B kprobe
 or
 .BR uprobe ,
 set
-.IR retprobe
+.I retprobe
 (bit 0 of
 .IR config ,
 see
@@ -663,7 +663,7 @@ for more details.
 .TP
 .IR kprobe_func ", " uprobe_path ", " kprobe_addr ", and " probe_offset
 These fields describe the kprobe/uprobe for dynamic PMUs
-.BR kprobe
+.B kprobe
 and
 .BR uprobe .
 For
@@ -853,7 +853,7 @@ hardware at the time of the sampled
 instruction's retirement.
 .RE
 .TP
-.IR "read_format"
+.I read_format
 This field specifies the format of the data returned by
 .BR read (2)
 on a
@@ -882,7 +882,7 @@ Adds a 64-bit unique value that corresponds to the event group.
 Allows all counter values in an event group to be read with one read.
 .RE
 .TP
-.IR "disabled"
+.I disabled
 The
 .I disabled
 bit specifies whether the counter starts out disabled or enabled.
@@ -903,7 +903,7 @@ Despite
 being 0, the child events will not start until the group leader
 is enabled.
 .TP
-.IR "inherit"
+.I inherit
 The
 .I inherit
 bit specifies that this counter should count events of child
@@ -913,11 +913,11 @@ the time the counter is created (nor to any new children of
 existing children).
 .IP
 Inherit does not work for some combinations of
-.IR read_format
+.I read_format
 values, such as
 .BR PERF_FORMAT_GROUP .
 .TP
-.IR "pinned"
+.I pinned
 The
 .I pinned
 bit specifies that the counter should always be on the CPU if at all
@@ -930,7 +930,7 @@ return end-of-file (i.e.,
 .BR read (2)
 returns 0) until the counter is subsequently enabled or disabled.
 .TP
-.IR "exclusive"
+.I exclusive
 The
 .I exclusive
 bit specifies that when this counter's group is on the CPU,
@@ -946,13 +946,13 @@ This includes any users running a system-wide
 measurement as well as any kernel use of the performance counters
 (including the commonly enabled NMI Watchdog Timer interface).
 .TP
-.IR "exclude_user"
+.I exclude_user
 If this bit is set, the count excludes events that happen in user space.
 .TP
-.IR "exclude_kernel"
+.I exclude_kernel
 If this bit is set, the count excludes events that happen in kernel space.
 .TP
-.IR "exclude_hv"
+.I exclude_hv
 If this bit is set, the count excludes events that happen in the
 hypervisor.
 This is mainly for PMUs that have built-in support for handling this
@@ -960,12 +960,12 @@ This is mainly for PMUs that have built-in support for handling this
 Extra support is needed for handling hypervisor measurements on most
 machines.
 .TP
-.IR "exclude_idle"
+.I exclude_idle
 If set, don't count when the CPU is running the idle task.
 While you can currently enable this for any event type, it is ignored
 for all but software events.
 .TP
-.IR "mmap"
+.I mmap
 The
 .I mmap
 bit enables generation of
@@ -979,7 +979,7 @@ This allows tools to notice new executable code being mapped into
 a program (dynamic shared libraries for example)
 so that addresses can be mapped back to the original code.
 .TP
-.IR "comm"
+.I comm
 The
 .I comm
 bit enables tracking of process command name as modified by the
@@ -998,30 +998,30 @@ can be used to differentiate the
 .BR exec (2)
 case from the others.
 .TP
-.IR "freq"
+.I freq
 If this bit is set, then
 .I sample_frequency
 not
 .I sample_period
 is used when setting up the sampling interval.
 .TP
-.IR "inherit_stat"
+.I inherit_stat
 This bit enables saving of event counts on context switch for
 inherited tasks.
 This is meaningful only if the
 .I inherit
 field is set.
 .TP
-.IR "enable_on_exec"
+.I enable_on_exec
 If this bit is set, a counter is automatically
 enabled after a call to
 .BR exec (2).
 .TP
-.IR "task"
+.I task
 If this bit is set, then
 fork/exit notifications are included in the ring buffer.
 .TP
-.IR "watermark"
+.I watermark
 If set, have an overflow notification happen when we cross the
 .I wakeup_watermark
 boundary.
@@ -1224,13 +1224,13 @@ No breakpoint.
 .BR HW_BREAKPOINT_R
 Count when we read the memory location.
 .TP
-.BR HW_BREAKPOINT_W
+.B HW_BREAKPOINT_W
 Count when we write the memory location.
 .TP
-.BR HW_BREAKPOINT_RW
+.B HW_BREAKPOINT_RW
 Count when we read or write the memory location.
 .TP
-.BR HW_BREAKPOINT_X
+.B HW_BREAKPOINT_X
 Count when we execute code at the memory location.
 .PP
 The values can be combined via a bitwise or, but the
@@ -1690,7 +1690,7 @@ Where
 .IR time_mult ,
 .IR time_shift ,
 and
-.IR cyc
+.I cyc
 are read in the
 seqcount loop described above.
 This delta can then be added to
@@ -1777,7 +1777,7 @@ The desired offset and size must be page aligned, and the size
 must be a power of two.
 These values are then passed to mmap in order to map the AUX buffer.
 Pages in the AUX buffer are included as part of the
-.BR RLIMIT_MEMLOCK
+.B RLIMIT_MEMLOCK
 resource limit (see
 .BR setrlimit (2)),
 and also as part of the
@@ -1889,9 +1889,9 @@ system call.
 .BR PERF_RECORD_MISC_SWITCH_OUT " (since Linux 4.3)"
 .\" commit 45ac1403f564f411c6a383a2448688ba8dd705a4
 When a
-.BR PERF_RECORD_SWITCH
+.B PERF_RECORD_SWITCH
 or
-.BR PERF_RECORD_SWITCH_CPU_WIDE
+.B PERF_RECORD_SWITCH_CPU_WIDE
 record is generated, this bit indicates that the
 context switch is away from the current process
 (instead of into the current process).
@@ -2258,7 +2258,7 @@ Support for
 .IR mispred ,
 .IR predicted ,
 and
-.IR cycles
+.I cycles
 is optional; if not supported, those
 values will be 0.
 .PP
@@ -2744,9 +2744,9 @@ or
 .BR epoll (7).
 Alternatively, the overflow events can be captured via sa signal handler,
 by enabling I/O signaling on the file descriptor; see the discussion of the
-.BR F_SETOWN
+.B F_SETOWN
 and
-.BR F_SETSIG
+.B F_SETSIG
 operations in
 .BR fcntl (2).
 .PP
@@ -2934,7 +2934,7 @@ This allows pausing and resuming the event's ring-buffer.
 A paused ring-buffer does not prevent generation of samples,
 but simply discards them.
 The discarded samples are considered lost, and cause a
-.BR PERF_RECORD_LOST
+.B PERF_RECORD_LOST
 sample to be generated when possible.
 An overflow signal may still be triggered by the discarded sample
 even though the ring-buffer remains empty.
diff --git a/man2/personality.2 b/man2/personality.2
index a05feb181..758314f24 100644
--- a/man2/personality.2
+++ b/man2/personality.2
@@ -54,7 +54,7 @@ is not
 sets the caller's execution domain to the value specified by
 .IR persona .
 Specifying
-.IR persona
+.I persona
 as 0xffffffff provides a way of retrieving
 the current persona without changing it.
 .PP
@@ -93,9 +93,9 @@ Map page 0 as read-only
 .TP
 .BR READ_IMPLIES_EXEC " (since Linux 2.6.8)"
 With this flag set,
-.BR PROT_READ
+.B PROT_READ
 implies
-.BR PROT_EXEC
+.B PROT_EXEC
 for
 .BR mmap (2).
 .TP
@@ -183,7 +183,7 @@ was defined as.
 .TP
 .BR PER_OSR5 " (since Linux 2.4)"
 Implies
-.BR STICKY_TIMEOUTS
+.B STICKY_TIMEOUTS
 and
 .BR WHOLE_SECONDS ;
 otherwise no effects.
@@ -214,35 +214,35 @@ support was removed in Linux 2.6.26.
 .TP
 .BR PER_SVR3 " (since Linux 1.2.0)"
 Implies
-.BR STICKY_TIMEOUTS
+.B STICKY_TIMEOUTS
 and
 .BR SHORT_INODE ;
 otherwise no effects.
 .TP
 .BR PER_SVR4 " (since Linux 1.2.0)"
 Implies
-.BR STICKY_TIMEOUTS
+.B STICKY_TIMEOUTS
 and
 .BR MMAP_PAGE_ZERO ;
 otherwise no effects.
 .TP
 .BR PER_UW7 " (since Linux 2.4)"
 Implies
-.BR STICKY_TIMEOUTS
+.B STICKY_TIMEOUTS
 and
 .BR MMAP_PAGE_ZERO ;
 otherwise no effects.
 .TP
 .BR PER_WYSEV386 " (since Linux 1.2.0)"
 Implies
-.BR STICKY_TIMEOUTS
+.B STICKY_TIMEOUTS
 and
 .BR SHORT_INODE ;
 otherwise no effects.
 .TP
 .BR PER_XENIX " (since Linux 1.2.0)"
 Implies
-.BR STICKY_TIMEOUTS
+.B STICKY_TIMEOUTS
 and
 .BR SHORT_INODE ;
 otherwise no effects.
diff --git a/man2/pipe.2 b/man2/pipe.2
index fcae8c0ab..020bba1d3 100644
--- a/man2/pipe.2
+++ b/man2/pipe.2
@@ -53,11 +53,11 @@ pipe, pipe2 \- create pipe
 creates a pipe, a unidirectional data channel that
 can be used for interprocess communication.
 The array
-.IR pipefd
+.I pipefd
 is used to return two file descriptors referring to the ends of the pipe.
-.IR pipefd[0]
+.I pipefd[0]
 refers to the read end of the pipe.
-.IR pipefd[1]
+.I pipefd[1]
 refers to the write end of the pipe.
 Data written to the write end of the pipe is buffered by the kernel
 until it is read from the read end of the pipe.
@@ -65,13 +65,13 @@ For further details, see
 .BR pipe (7).
 .PP
 If
-.IR flags
+.I flags
 is 0, then
 .BR pipe2 ()
 is the same as
 .BR pipe ().
 The following values can be bitwise ORed in
-.IR flags
+.I flags
 to obtain different behavior:
 .TP
 .B O_CLOEXEC
@@ -94,12 +94,12 @@ Note the following points:
 .RS
 .IP * 3
 Writes of greater than
-.BR PIPE_BUF
+.B PIPE_BUF
 bytes (see
 .BR pipe (7))
 will be split into multiple packets.
 The constant
-.BR PIPE_BUF
+.B PIPE_BUF
 is defined in
 .IR <limits.h> .
 .IP *
@@ -109,7 +109,7 @@ specifies a buffer size that is smaller than the next packet,
 then the requested number of bytes are read,
 and the excess bytes in the packet are discarded.
 Specifying a buffer size of
-.BR PIPE_BUF
+.B PIPE_BUF
 will be sufficient to read the largest possible packets
 (see the previous point).
 .IP *
@@ -133,7 +133,7 @@ setting of a pipe file descriptor using
 .TP
 .B O_NONBLOCK
 Set the
-.BR O_NONBLOCK
+.B O_NONBLOCK
 file status flag on the open file descriptions
 referred to by the new file descriptors.
 Using this flag saves extra calls to
diff --git a/man2/pkey_alloc.2 b/man2/pkey_alloc.2
index bd1c6e0b6..0626fa88e 100644
--- a/man2/pkey_alloc.2
+++ b/man2/pkey_alloc.2
@@ -45,7 +45,6 @@ is reserved for future use and currently must always be specified as 0.
 The
 .BR pkey_alloc ()
 .I access_rights
-.BR
 argument may contain zero or more disable operations:
 .TP
 .B PKEY_DISABLE_ACCESS
diff --git a/man2/posix_fadvise.2 b/man2/posix_fadvise.2
index 937f85ca6..5f4c6a0cc 100644
--- a/man2/posix_fadvise.2
+++ b/man2/posix_fadvise.2
@@ -176,7 +176,7 @@ These changes affect the entire file, not just the specified region
 (but other open file handles to the same file are unaffected).
 .PP
 The contents of the kernel buffer cache can be cleared via the
-.IR /proc/sys/vm/drop_caches
+.I /proc/sys/vm/drop_caches
 interface described in
 .BR proc (5).
 .PP
-- 
2.20.1


-- 
Bjarni I. Gislason



[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