Various pages: srcfix: Remove redundant .PP
PATCH 1/1 Various pages: srcfix: Remove redundant .PP
.PP are redundant just after .SH or .SS.
Remove them.
$ find man? -type f \
|xargs sed -i '/^\.S[HS]/{n;/\.PP/d}';Plus a couple manual edits.
Signed-off-by Alejandro Colomar <[email protected]>
--- man3/stailq.3 | 2 +- man3/tailq.3 | 2 +- man4/lirc.4 | 9 --------- man4/st.4 | 3 --- man5/utmp.5 | 2 -- man7/boot.7 | 2 -- man7/credentials.7 | 1 - man7/futex.7 | 4 ---- man7/mailaddr.7 | 3 --- man7/sigevent.7 | 1 - man7/time_namespaces.7 | 2 -- man7/uri.7 | 5 ----- 12 files changed, 2 insertions(+), 34 deletions(-)
man3/stailq.3 +1 -1
@@ -256,13 +256,13 @@ macro. .\" .BR STAILQ_REMOVE (), .\" this macro does not traverse the entire tail queue. .SS Other features -.PP .BR STAILQ_CONCAT () concatenates the tail queue headed by .I head2 onto the end of the one headed by .I head1 removing all entries from the former. +.\" .PP .\" .BR STAILQ_SWAP () .\" swaps the contents of .\" .I head1
man3/tailq.3 +1 -1
@@ -306,12 +306,12 @@ removes the element .I elm from the queue. .SS Other features -.\" .PP .\" .BR TAILQ_SWAP () .\" swaps the contents of .\" .I head1 .\" and .\" .IR head2 . +.\" .PP .BR TAILQ_CONCAT () concatenates the queue headed by .I head2
man4/lirc.4 +0 -9
@@ -25,7 +25,6 @@ .SH NAME lirc \- lirc devices .SH DESCRIPTION -.PP The .I /dev/lirc* character devices provide a low-level
@@ -65,7 +64,6 @@ receiving and sending is supported, and in which modes, amongst other features. .\" .SS Reading input with the LIRC_MODE_MODE2 mode -.PP In the \fBLIRC_MODE_MODE2 mode\fR, the data returned by .BR read (2) provides 32-bit values representing a space or a pulse duration.
@@ -90,7 +88,6 @@ The package reflects a timeout; see the ioctl. .\" .SS Reading input with the LIRC_MODE_SCANCODE mode -.PP In the \fBLIRC_MODE_SCANCODE\fR mode, the data returned by .BR read (2)
@@ -100,7 +97,6 @@ is stored in \fIrc_proto\fR. This field has one the values of the \fIenum rc_proto\fR. .\" .SS Writing output with the LIRC_MODE_PULSE mode -.PP The data written to the character device using .BR write (2) is a pulse/space sequence of integer values.
@@ -116,7 +112,6 @@ If more data is provided than the hardware can send, the call fails with the error .BR EINVAL . .SS Writing output with the LIRC_MODE_SCANCODE mode -.PP The data written to the character devices must be a single struct \fIlirc_scancode\fR. The \fIscancode\fR and \fIrc_proto\fR fields must
@@ -127,7 +122,6 @@ The protocol or scancode is invalid, or the .B lirc device cannot transmit. .SH IOCTL COMMANDS -.PP The LIRC device's ioctl definition is bound by the ioctl function definition of .IR "struct file_operations" ,
@@ -153,7 +147,6 @@ referred to below as .IR val . .\" .SS Always Supported Commands -.PP \fI/dev/lirc*\fR devices always support the following commands: .TP 4 .BR LIRC_GET_FEATURES " (\fIvoid\fP)"
@@ -166,7 +159,6 @@ it is safe to assume it is not a device. .\" .SS Optional Commands -.PP Some .B lirc devices support the commands listed below.
@@ -363,7 +355,6 @@ Trying to disable a wide band receiver while carrier reports are active will do nothing. .\" .SH FEATURES -.PP the .BR LIRC_GET_FEATURES ioctl returns a bit mask describing features of the driver.
man4/st.4 +0 -3
@@ -238,7 +238,6 @@ driver. The definitions below are from .IR /usr/include/linux/mtio.h : .SS MTIOCTOP \(em perform a tape operation -.PP This request takes an argument of type .IR "(struct mtop\ *)" . Not all drives support all operations.
@@ -686,7 +685,6 @@ the cleaning request. If the pattern is nonzero, the pattern must match the masked sense data byte. .SS MTIOCGET \(em get status -.PP This request takes an argument of type .IR "(struct mtget\ *)" . .PP
@@ -815,7 +813,6 @@ This value is set to \-1 when the block number is unknown (e.g., after or .BR MTSEEK ). .SS MTIOCPOS \(em get tape position -.PP This request takes an argument of type .I "(struct mtpos\ *)" and reports the drive's notion of the current tape block number,
man5/utmp.5 +0 -2
@@ -237,7 +237,6 @@ removed, record-keeping is turned off. .br .I /var/log/wtmp .SH CONFORMING TO -.PP POSIX.1 does not specify a .I utmp structure, but rather one named
@@ -289,7 +288,6 @@ Linux uses the BSD conventions for line contents, as documented above. .\" informative messages such as \fB"new time"\fP in the line field. System V has no \fIut_host\fP or \fIut_addr_v6\fP fields. .SH NOTES -.PP Unlike various other systems, where utmp logging can be disabled by removing the file, utmp must always exist on Linux.
man7/boot.7 +0 -2
@@ -16,7 +16,6 @@ .SH NAME boot \- System bootup process based on UNIX System V Release 4 .SH DESCRIPTION -.PP The \fBbootup process\fR (or "\fBboot sequence\fR") varies in details among systems, but can be roughly divided into phases controlled by the following components:
@@ -215,7 +214,6 @@ A boot script in \fI/etc/init.d\fR reads and includes its configuration file (that is, it "\fBsources\fR" its configuration file) and then uses the variable values. .SH FILES -.PP .IR /etc/init.d/ , .IR /etc/rc[S0\-6].d/ , .I /etc/sysconfig/
man7/credentials.7 +0 -1
@@ -284,7 +284,6 @@ that the process may create (see .BR inotify (7)). .\" .SS Modifying process user and group IDs -.PP Subject to rules described in the relevant manual pages, a process can use the following APIs to modify its user and group IDs: .TP
man7/futex.7 +0 -4
@@ -16,7 +16,6 @@ futex \- fast user-space locking .B #include <linux/futex.h> .fi .SH DESCRIPTION -.PP The Linux kernel provides futexes ("Fast user-space mutexes") as a building block for fast user-space locking and semaphores.
@@ -49,7 +48,6 @@ Processes can share this integer using via shared memory segments, or because they share memory space, in which case the application is commonly called multithreaded. .SS Semantics -.PP Any futex operation starts in user space, but it may be necessary to communicate with the kernel using the .BR futex (2)
@@ -90,12 +88,10 @@ for more details. The same holds for asynchronous futex waiting. .SH VERSIONS -.PP Initial futex support was merged in Linux 2.5.7 but with different semantics from those described above. Current semantics are available from Linux 2.5.40 onward. .SH NOTES -.PP To reiterate, bare futexes are not intended as an easy-to-use abstraction for end users. Implementors are expected to be assembly literate and to have read
man7/mailaddr.7 +0 -3
@@ -77,7 +77,6 @@ The name may have to be quoted using "", for example, if it contains ".": .PP "John Q. Doe" <[email protected]> .SS Abbreviation -.PP Some mail systems let users abbreviate the domain name. For instance, users at example.com may get away with "john.doe@monet" to
@@ -85,7 +84,6 @@ send mail to John Doe. .I "This behavior is deprecated." Sometimes it works, but you should not depend on it. .SS Route-addrs -.PP In the past, sometimes one had to route a message through several hosts to get it to its final destination. Addresses which show these relays are termed "route-addrs".
@@ -102,7 +100,6 @@ They occur sometimes in old mail archives. It is generally possible to ignore all but the "user@hostc" part of the address to determine the actual address. .SS Postmaster -.PP Every site is required to have a user or user alias designated "postmaster" to which problems with the mail system may be addressed.
man7/sigevent.7 +0 -1
@@ -52,7 +52,6 @@ struct sigevent { }; .fi .SH DESCRIPTION -.PP The .I sigevent structure is used by various APIs
man7/time_namespaces.7 +0 -2
@@ -185,7 +185,6 @@ the contents of the .I timens_offsets file are inherited from the time namespace of the creating process. .SH NOTES -.PP Use of time namespaces requires a kernel that is configured with the .B CONFIG_TIME_NS option.
@@ -211,7 +210,6 @@ The motivation for adding time namespaces was to allow the monotonic and boot-time clocks to maintain consistent values during container migration and checkpoint/restore. .SH EXAMPLES -.PP The following shell session demonstrates the operation of time namespaces. We begin by displaying the inode number of the time namespace of a shell in the initial time namespace:
man7/uri.7 +0 -5
@@ -69,7 +69,6 @@ absolute_path = "/" path_segments relative_path = relative_segment [ absolute_path ] .fi .SH DESCRIPTION -.PP A Uniform Resource Identifier (URI) is a short string of characters identifying an abstract or physical resource (for example, a web page). A Uniform Resource Locator (URL) is a URI
@@ -487,7 +486,6 @@ URNs are to be supported by the urn: scheme, with a hierarchical name space URNs are not widely implemented. Not all tools support all schemes. .SS Character encoding -.PP URIs use a limited number of characters so that they can be typed in and used in a variety of situations. .PP
@@ -582,7 +580,6 @@ permitted, and can be used only when there is no defined base Don't use abbreviated URIs as hypertext links inside a document; use the standard format as described here. .SH CONFORMING TO -.PP .UR http://www.ietf.org\:/rfc\:/rfc2396.txt (IETF RFC\ 2396) .UE ,
@@ -628,7 +625,6 @@ will converge to common URI formats, and a future version of this man page will describe the converged result. Efforts to aid this convergence are encouraged. .SS Security -.PP A URI does not in itself pose a security threat. There is no general guarantee that a URL, which at one time located a given resource, will continue to do so.
@@ -671,7 +667,6 @@ In particular, the use of a password within the "userinfo" component of a URI is strongly recommended against except in those rare cases where the "password" parameter is intended to be public. .SH BUGS -.PP Documentation may be placed in a variety of locations, so there currently isn't a good URI scheme for general online documentation in arbitrary formats.
Signature · 1 line
2.30.0
Hi ALex,
Quoted 9 lines · Alejandro Colomar
.PP are redundant just after .SH or .SS.
Remove them.$ find man? -type f \ |xargs sed -i '/^\.S[HS]/{n;/\.PP/d}';Plus a couple manual edits.
Signed-off-by Alejandro Colomar <[email protected]>
Oops -- we partly worked on the same thing at the same time, and I pushed a change that breaks this patch. I reverted my patch, and applied your (better) patch.
Thanks,
Michael
Quoted 346 lines
--- man3/stailq.3 | 2 +- man3/tailq.3 | 2 +- man4/lirc.4 | 9 --------- man4/st.4 | 3 --- man5/utmp.5 | 2 -- man7/boot.7 | 2 -- man7/credentials.7 | 1 - man7/futex.7 | 4 ---- man7/mailaddr.7 | 3 --- man7/sigevent.7 | 1 - man7/time_namespaces.7 | 2 -- man7/uri.7 | 5 ----- 12 files changed, 2 insertions(+), 34 deletions(-)man3/stailq.3 +1
-1@@ -256,13 +256,13 @@ macro. .\" .BR STAILQ_REMOVE (), .\" this macro does not traverse the entire tail queue. .SS Other features -.PP .BR STAILQ_CONCAT () concatenates the tail queue headed by .I head2 onto the end of the one headed by .I head1 removing all entries from the former. +.\" .PP .\" .BR STAILQ_SWAP () .\" swaps the contents of .\" .I head1man3/tailq.3 +1
-1@@ -306,12 +306,12 @@ removes the element .I elm from the queue. .SS Other features -.\" .PP .\" .BR TAILQ_SWAP () .\" swaps the contents of .\" .I head1 .\" and .\" .IR head2 . +.\" .PP .BR TAILQ_CONCAT () concatenates the queue headed by .I head2man4/lirc.4 +0
-9@@ -25,7 +25,6 @@ .SH NAME lirc \- lirc devices .SH DESCRIPTION -.PP The .I /dev/lirc* character devices provide a low-level@@ -65,7 +64,6 @@ receiving and sending is supported, and in which modes, amongst other features. .\" .SS Reading input with the LIRC_MODE_MODE2 mode -.PP In the \fBLIRC_MODE_MODE2 mode\fR, the data returned by .BR read (2) provides 32-bit values representing a space or a pulse duration.@@ -90,7 +88,6 @@ The package reflects a timeout; see the ioctl. .\" .SS Reading input with the LIRC_MODE_SCANCODE mode -.PP In the \fBLIRC_MODE_SCANCODE\fR mode, the data returned by .BR read (2)@@ -100,7 +97,6 @@ is stored in \fIrc_proto\fR. This field has one the values of the \fIenum rc_proto\fR. .\" .SS Writing output with the LIRC_MODE_PULSE mode -.PP The data written to the character device using .BR write (2) is a pulse/space sequence of integer values.@@ -116,7 +112,6 @@ If more data is provided than the hardware can send, the call fails with the error .BR EINVAL . .SS Writing output with the LIRC_MODE_SCANCODE mode -.PP The data written to the character devices must be a single struct \fIlirc_scancode\fR. The \fIscancode\fR and \fIrc_proto\fR fields must@@ -127,7 +122,6 @@ The protocol or scancode is invalid, or the .B lirc device cannot transmit. .SH IOCTL COMMANDS -.PP The LIRC device's ioctl definition is bound by the ioctl function definition of .IR "struct file_operations" ,@@ -153,7 +147,6 @@ referred to below as .IR val . .\" .SS Always Supported Commands -.PP \fI/dev/lirc*\fR devices always support the following commands: .TP 4 .BR LIRC_GET_FEATURES " (\fIvoid\fP)"@@ -166,7 +159,6 @@ it is safe to assume it is not a device. .\" .SS Optional Commands -.PP Some .B lirc devices support the commands listed below.@@ -363,7 +355,6 @@ Trying to disable a wide band receiver while carrier reports are active will do nothing. .\" .SH FEATURES -.PP the .BR LIRC_GET_FEATURES ioctl returns a bit mask describing features of the driver.man4/st.4 +0
-3@@ -238,7 +238,6 @@ driver. The definitions below are from .IR /usr/include/linux/mtio.h : .SS MTIOCTOP \(em perform a tape operation -.PP This request takes an argument of type .IR "(struct mtop\ *)" . Not all drives support all operations.@@ -686,7 +685,6 @@ the cleaning request. If the pattern is nonzero, the pattern must match the masked sense data byte. .SS MTIOCGET \(em get status -.PP This request takes an argument of type .IR "(struct mtget\ *)" . .PP@@ -815,7 +813,6 @@ This value is set to \-1 when the block number is unknown (e.g., after or .BR MTSEEK ). .SS MTIOCPOS \(em get tape position -.PP This request takes an argument of type .I "(struct mtpos\ *)" and reports the drive's notion of the current tape block number,man5/utmp.5 +0
-2@@ -237,7 +237,6 @@ removed, record-keeping is turned off. .br .I /var/log/wtmp .SH CONFORMING TO -.PP POSIX.1 does not specify a .I utmp structure, but rather one named@@ -289,7 +288,6 @@ Linux uses the BSD conventions for line contents, as documented above. .\" informative messages such as \fB"new time"\fP in the line field. System V has no \fIut_host\fP or \fIut_addr_v6\fP fields. .SH NOTES -.PP Unlike various other systems, where utmp logging can be disabled by removing the file, utmp must always exist on Linux.man7/boot.7 +0
-2@@ -16,7 +16,6 @@ .SH NAME boot \- System bootup process based on UNIX System V Release 4 .SH DESCRIPTION -.PP The \fBbootup process\fR (or "\fBboot sequence\fR") varies in details among systems, but can be roughly divided into phases controlled by the following components:@@ -215,7 +214,6 @@ A boot script in \fI/etc/init.d\fR reads and includes its configuration file (that is, it "\fBsources\fR" its configuration file) and then uses the variable values. .SH FILES -.PP .IR /etc/init.d/ , .IR /etc/rc[S0\-6].d/ , .I /etc/sysconfig/man7/credentials.7 +0
-1@@ -284,7 +284,6 @@ that the process may create (see .BR inotify (7)). .\" .SS Modifying process user and group IDs -.PP Subject to rules described in the relevant manual pages, a process can use the following APIs to modify its user and group IDs: .TPman7/futex.7 +0
-4@@ -16,7 +16,6 @@ futex \- fast user-space locking .B #include <linux/futex.h> .fi .SH DESCRIPTION -.PP The Linux kernel provides futexes ("Fast user-space mutexes") as a building block for fast user-space locking and semaphores.@@ -49,7 +48,6 @@ Processes can share this integer using via shared memory segments, or because they share memory space, in which case the application is commonly called multithreaded. .SS Semantics -.PP Any futex operation starts in user space, but it may be necessary to communicate with the kernel using the .BR futex (2)@@ -90,12 +88,10 @@ for more details. The same holds for asynchronous futex waiting. .SH VERSIONS -.PP Initial futex support was merged in Linux 2.5.7 but with different semantics from those described above. Current semantics are available from Linux 2.5.40 onward. .SH NOTES -.PP To reiterate, bare futexes are not intended as an easy-to-use abstraction for end users. Implementors are expected to be assembly literate and to have readman7/mailaddr.7 +0
-3@@ -77,7 +77,6 @@ The name may have to be quoted using "", for example, if it contains ".": .PP "John Q. Doe" <[email protected]> .SS Abbreviation -.PP Some mail systems let users abbreviate the domain name. For instance, users at example.com may get away with "john.doe@monet" to@@ -85,7 +84,6 @@ send mail to John Doe. .I "This behavior is deprecated." Sometimes it works, but you should not depend on it. .SS Route-addrs -.PP In the past, sometimes one had to route a message through several hosts to get it to its final destination. Addresses which show these relays are termed "route-addrs".@@ -102,7 +100,6 @@ They occur sometimes in old mail archives. It is generally possible to ignore all but the "user@hostc" part of the address to determine the actual address. .SS Postmaster -.PP Every site is required to have a user or user alias designated "postmaster" to which problems with the mail system may be addressed.man7/sigevent.7 +0
-1@@ -52,7 +52,6 @@ struct sigevent { }; .fi .SH DESCRIPTION -.PP The .I sigevent structure is used by various APIsman7/time_namespaces.7 +0
-2@@ -185,7 +185,6 @@ the contents of the .I timens_offsets file are inherited from the time namespace of the creating process. .SH NOTES -.PP Use of time namespaces requires a kernel that is configured with the .B CONFIG_TIME_NS option.@@ -211,7 +210,6 @@ The motivation for adding time namespaces was to allow the monotonic and boot-time clocks to maintain consistent values during container migration and checkpoint/restore. .SH EXAMPLES -.PP The following shell session demonstrates the operation of time namespaces. We begin by displaying the inode number of the time namespace of a shell in the initial time namespace:man7/uri.7 +0
-5@@ -69,7 +69,6 @@ absolute_path = "/" path_segments relative_path = relative_segment [ absolute_path ] .fi .SH DESCRIPTION -.PP A Uniform Resource Identifier (URI) is a short string of characters identifying an abstract or physical resource (for example, a web page). A Uniform Resource Locator (URL) is a URI@@ -487,7 +486,6 @@ URNs are to be supported by the urn: scheme, with a hierarchical name space URNs are not widely implemented. Not all tools support all schemes. .SS Character encoding -.PP URIs use a limited number of characters so that they can be typed in and used in a variety of situations. .PP@@ -582,7 +580,6 @@ permitted, and can be used only when there is no defined base Don't use abbreviated URIs as hypertext links inside a document; use the standard format as described here. .SH CONFORMING TO -.PP .UR http://www.ietf.org\:/rfc\:/rfc2396.txt (IETF RFC\ 2396) .UE ,@@ -628,7 +625,6 @@ will converge to common URI formats, and a future version of this man page will describe the converged result. Efforts to aid this convergence are encouraged. .SS Security -.PP A URI does not in itself pose a security threat. There is no general guarantee that a URL, which at one time located a given resource, will continue to do so.@@ -671,7 +667,6 @@ In particular, the use of a password within the "userinfo" component of a URI is strongly recommended against except in those rare cases where the "password" parameter is intended to be public. .SH BUGS -.PP Documentation may be placed in a variety of locations, so there currently isn't a good URI scheme for general online documentation in arbitrary formats.
Signature · 3 lines
Michael Kerrisk Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/ Linux/UNIX System Programming Training: http://man7.org/training/