]> git.ipfire.org Git - thirdparty/util-linux.git/commitdiff
doc: sys-utils/*: fix some warnings from "mandoc -T lint"
authorBjarni Ingi Gislason <bjarniig@rhi.hi.is>
Thu, 11 Jun 2020 00:50:33 +0000 (00:50 +0000)
committerKarel Zak <kzak@redhat.com>
Mon, 15 Jun 2020 09:28:01 +0000 (11:28 +0200)
mandoc: ./sys-utils/adjtime_config.5:26:1: WARNING: skipping paragraph macro: sp after PP

mandoc: ./sys-utils/chcpu.8:98:2: WARNING: skipping paragraph macro: br at the end of SH

mandoc: ./sys-utils/choom.1:26:22: STYLE: unterminated quoted argument

mandoc: ./sys-utils/dmesg.1:90:5: STYLE: unterminated quoted argument
mandoc: ./sys-utils/dmesg.1:147:5: STYLE: unterminated quoted argument
mandoc: ./sys-utils/dmesg.1:33:2: WARNING: skipping paragraph macro: PP empty
mandoc: ./sys-utils/dmesg.1:255:2: WARNING: skipping paragraph macro: br after sp

mandoc: ./sys-utils/flock.1:183:2: WARNING: line scope broken: TQ breaks TP
mandoc: ./sys-utils/flock.1:43:2: WARNING: skipping paragraph macro: PP after SH

mandoc: ./sys-utils/fsfreeze.8:79:2: WARNING: skipping paragraph macro: PP after SH
mandoc: ./sys-utils/fsfreeze.8:83:2: WARNING: skipping paragraph macro: PP after SH

mandoc: ./sys-utils/ipcmk.1:43:2: WARNING: skipping paragraph macro: PP empty

mandoc: ./sys-utils/lsirq.1:16:11: STYLE: unterminated quoted argument
mandoc: ./sys-utils/lsirq.1:31:11: STYLE: unterminated quoted argument
mandoc: ./sys-utils/lsirq.1:34:11: STYLE: unterminated quoted argument

mandoc: ./sys-utils/mount.8:901:4: STYLE: unterminated quoted argument
mandoc: ./sys-utils/mount.8:2239:38: STYLE: unterminated quoted argument
mandoc: ./sys-utils/mount.8:88:2: WARNING: skipping paragraph macro: br after sp
mandoc: ./sys-utils/mount.8:90:2: WARNING: skipping paragraph macro: br before sp

mandoc: ./sys-utils/mountpoint.1:50:2: WARNING: skipping paragraph macro: PP after SH
mandoc: ./sys-utils/mountpoint.1:57:2: WARNING: skipping paragraph macro: PP after SH

mandoc: ./sys-utils/readprofile.8:10:2: WARNING: skipping paragraph macro: PP after SH
mandoc: ./sys-utils/readprofile.8:100:2: WARNING: skipping paragraph macro: PP after SH

mandoc: ./sys-utils/renice.1:65:11: STYLE: unterminated quoted argument
mandoc: ./sys-utils/renice.1:68:11: STYLE: unterminated quoted argument
mandoc: ./sys-utils/renice.1:72:11: STYLE: unterminated quoted argument
mandoc: ./sys-utils/renice.1:55:2: WARNING: skipping paragraph macro: PP empty

mandoc: ./sys-utils/swapon.8:227:2: WARNING: skipping paragraph macro: br after SH

mandoc: ./sys-utils/unshare.1:350:32: STYLE: unterminated quoted argument
mandoc: ./sys-utils/unshare.1:253:2: WARNING: skipping paragraph macro: PP after SH

####

  The ouput from "nroff" and "groff" is unchanged.

Signed-off-by: Bjarni Ingi Gislason <bjarniig@rhi.hi.is>
14 files changed:
sys-utils/adjtime_config.5
sys-utils/chcpu.8
sys-utils/choom.1
sys-utils/dmesg.1
sys-utils/flock.1
sys-utils/fsfreeze.8
sys-utils/ipcmk.1
sys-utils/lsirq.1
sys-utils/mount.8
sys-utils/mountpoint.1
sys-utils/readprofile.8
sys-utils/renice.1
sys-utils/swapon.8
sys-utils/unshare.1

index 9482e25f957f539ddd396164959bf9bd42d4a438..0166461c4e5c3f04db3ab49954cc10b5291e3d7d 100644 (file)
@@ -23,7 +23,7 @@ For more details see "\fBThe Adjust Function\fR" and  "\fBThe Adjtime File\fR" s
 .BR hwclock (8)
 man page.
 .PP
-
+.
 The format of the adjtime file is, in ASCII.
 .sp
 .SS First line
index 10273f6e2ecc718765ec42a4a83fb332e38c5ce6..41b2d0951249aeab9a7c88fd9f708f8130f5067f 100644 (file)
@@ -95,7 +95,6 @@ Heiko Carstens
 .ME
 .SH COPYRIGHT
 Copyright IBM Corp. 2011
-.br
 .SH SEE ALSO
 .BR lscpu (1)
 .SH AVAILABILITY
index def31d5f0b783d0453aeb75fc1a4fd676cc1d8ec..ce2b8b5399adc73f9a6b0c4b7ba80a09d8eddc3d 100644 (file)
@@ -23,7 +23,7 @@ The \fBchoom\fP command displays and adjusts Out-Of-Memory killer score setting.
 
 .SH OPTIONS
 .TP
-.BR \-p ", " \-\-pid " \fIpid\fP
+.BR \-p ", " \-\-pid " \fIpid\fP"
 Specifies process ID.
 .TP
 .BR \-n , " \-\-adjust " \fIvalue\fP
index 6c5773a6b211af8dc2496590f72141a841bb7788..4bec7892bb90e4500c9f05fd4a4206962a8aeb5a 100644 (file)
@@ -30,7 +30,6 @@ The
 and
 .B \-\-console\-level
 options are mutually exclusive.
-.PP
 .IP "\fB\-C\fR, \fB\-\-clear\fR"
 Clear the ring buffer.
 .IP "\fB\-c\fR, \fB\-\-read\-clear\fR"
@@ -87,7 +86,7 @@ of levels.  For example:
 will print error and warning messages only.  For all supported levels see the
 .B \-\-help
 output.
-.IP "\fB\-n\fR, \fB\-\-console\-level \fIlevel\fR
+.IP "\fB\-n\fR, \fB\-\-console\-level \fIlevel\fR"
 Set the
 .I level
 at which printing of messages is done to the console.  The
@@ -144,7 +143,7 @@ kernel interface to read kernel messages.  The default is to use /dev/kmsg rathe
 than
 .BR syslog (2)
 since kernel 3.5.0.
-.IP "\fB\-s\fR, \fB\-\-buffer\-size \fIsize\fR
+.IP "\fB\-s\fR, \fB\-\-buffer\-size \fIsize\fR"
 Use a buffer of
 .I size
 to query the kernel ring buffer.  This is 16392 by default.  (The default
@@ -252,7 +251,6 @@ for more details.
 Karel Zak
 .ME
 
-.br
 .B dmesg
 was originally written by
 .MT tytso@athena.mit.edu
index def273dbd0ab4b0f390ba2b04ec581bb8d1734f4..20975f82c2d4ce3258059546e550509edf9c91ae 100644 (file)
@@ -40,7 +40,6 @@ flock \- manage locks from shell scripts
 .B flock
 .RI [options] " number"
 .SH DESCRIPTION
-.PP
 This utility manages
 .BR flock (2)
 locks from within shell scripts or from the command line.
@@ -181,7 +180,6 @@ then execute flock and grab an exclusive non-blocking lock (using the script
 itself as the lock file) before re-execing itself with the right arguments.  It
 also sets the FLOCKER env var to the right value so it doesn't run again.
 .TP
-.TQ
 shell> exec 4<>/var/lock/mylockfile
 .TQ
 shell> flock -n 4
index eb32147698f786479e37c7c516317d51c8b9e109..cbde489ad199e43368c050e7c6ec774c254f7322 100644 (file)
@@ -76,11 +76,9 @@ Previous list may be incomplete, as more filesystems get support.  If in
 doubt easiest way to know if a filesystem has support is create a small
 loopback mount and test freezing it.
 .SH NOTES
-.PP
 This man page is based on
 .BR xfs_freeze (8).
 .SH AUTHORS
-.PP
 Written by Hajime Taira.
 .SH SEE ALSO
 .BR mount (8)
index c402220141bfb13413e3ac35d0e8b1868da276dd..a194af41ea546289305cb511e33224101a3c1668 100644 (file)
@@ -40,7 +40,6 @@ Display version information and exit.
 .TP
 .BR \-h , " \-\-help"
 Display help text and exit.
-.PP
 .SH AUTHORS
 .MT hayden.james@gmail.com
 Hayden A. James
index 767077123c3b3672aa3830809769d024d3f6e43b..d58605bffe087ea3e5d710d6e428d97d055d0b6b 100644 (file)
@@ -13,7 +13,7 @@ expected columns by using
 .BR \-\-output .
 .SH OPTIONS
 .TP
-.BR \-n , " \-\-noheadings
+.BR \-n ", " \-\-noheadings
 Don't print headings.
 .TP
 .BR \-o , " \-\-output " \fIlist\fP
@@ -28,10 +28,10 @@ Specify sort criteria by column name.  See
 .B \-\-help
 output to get column names.
 .TP
-.BR \-J , " \-\-json
+.BR \-J ", " \-\-json
 Use JSON output format.
 .TP
-.BR \-P , " \-\-pairs
+.BR \-P ", " \-\-pairs
 Produce output in the form of key="value" pairs.  All potentially unsafe characters
 are hex-escaped (\\x<code>).
 .TP
index f8e7e0850c4d8e042745f315c4b8776fd090c1d0..733dbaa3fa47faa71163aee44f8cdb20ade17f65 100644 (file)
@@ -85,9 +85,7 @@ The standard form of the
 command is:
 .RS
 
-.br
 .BI "mount \-t" " type device dir"
-.br
 
 .RE
 This tells the kernel to attach the filesystem found on
@@ -899,7 +897,7 @@ but mount operations is done on another place, for example:
 .RS
 .RS
 .sp
-.B "mount \-\-all \-\-target\-prefix /chroot \-o X\-mount.mkdir
+.B "mount \-\-all \-\-target\-prefix /chroot \-o X\-mount.mkdir"
 .sp
 .RE
 mounts all from system
@@ -2237,7 +2235,7 @@ Enable POSIX Access Control Lists.  See the
 .BR acl (5)
 manual page.
 .TP
-.BR barrier=none " / " barrier=flush "
+.BR barrier=none " / " barrier=flush
 This disables / enables the use of write barriers in the journaling code.
 barrier=none disables, barrier=flush enables (default).  This also requires an
 IO stack which can support barriers, and if reiserfs gets an error on a barrier
index cadb026da2091c7ff80e10ec4721a71a88e754ef..a100721433b3f8ddf03696e12689f5df04f0bb88 100644 (file)
@@ -47,14 +47,12 @@ Zero if the directory or file is a mountpoint, non-zero if not.
 .IP LIBMOUNT_DEBUG=all
 enables libmount debug output.
 .SH NOTES
-.PP
 The util-linux
 .B mountpoint
 implementation was written from scratch for libmount.  The original version
 for sysvinit suite was written by Miquel van Smoorenburg.
 
 .SH AUTHORS
-.PP
 Karel Zak <kzak@redhat.com>
 .SH SEE ALSO
 .BR mount (8)
index c335644d7e077fd628eeaeb61a40b17c24d063b6..b987abb7fb98e069da217a11ed8ddce46d91ff41 100644 (file)
@@ -7,7 +7,6 @@ readprofile \- read kernel profiling information
 .SH VERSION
 This manpage documents version 2.0 of the program.
 .SH DESCRIPTION
-.LP
 The
 .B readprofile
 command uses the
@@ -97,7 +96,6 @@ Display help text and exit.
 /usr/src/linux/*           The program being profiled :-)
 .fi
 .SH BUGS
-.LP
 .B readprofile
 only works with a 1.3.x or newer kernel, because
 .I /proc/profile
index cb98631432dda7a9d4d6253f02c5f96faec96d88..c39aa1f39a674593c3009e42632abf6f612d4267 100644 (file)
@@ -52,7 +52,6 @@ scheduling priority altered.
 .BR renice 'ing
 a user causes all processes owned by the user to have their scheduling
 priority altered.
-.PP
 .SH OPTIONS
 .TP
 .BR \-n , " \-\-priority " \fIpriority\fR
@@ -62,14 +61,14 @@ to be used for the process, process group, or user.  Use of the option
 .BR \-n " or " \-\-priority
 is optional, but when used it must be the first argument.
 .TP
-.BR \-g , " \-\-pgrp
+.BR \-g ", " \-\-pgrp
 Interpret the succeeding arguments as process group IDs.
 .TP
-.BR \-p , " \-\-pid
+.BR \-p ", " \-\-pid
 Interpret the succeeding arguments as process IDs
 (the default).
 .TP
-.BR \-u , " \-\-user
+.BR \-u ", " \-\-user
 Interpret the succeeding arguments as usernames or UIDs.
 .TP
 .BR \-V , " \-\-version"
index b10076c9082220e242dd4ff05c4e812eb26421d2..486e02840e6885ab6385d0ac1e04b43d47e7d667 100644 (file)
@@ -224,7 +224,6 @@ enables libmount debug output.
 enables libblkid debug output.
 
 .SH FILES
-.br
 .I /dev/sd??
 standard paging devices
 .br
index 2096f45ab3bed9e91648157b1cd64f363373aec4..bd5f416b4ae30de26b83cf987b89c9b140465446 100644 (file)
@@ -250,7 +250,6 @@ restricted so that a less privileged user can not get more access to sensitive
 files that a more privileged user made unavailable. In short the rule for proc
 and sysfs is as close to a bind mount as possible.
 .SH EXAMPLES
-.PP
 The following command creates a PID namespace, using
 .B \-\-fork
 to ensure that the executed command is performed in a child process
@@ -347,7 +346,7 @@ is killed, all of the processes within the PID namespace are killed.
 
 .BR "# ps h \-o 'comm' $!     " "# Show that background job is unshare(1)"
 unshare
-.BR "# kill $!               " "# Kill unshare(1)
+.BR "# kill $!               " "# Kill unshare(1)"
 .B # pidof sleep
 .EE
 .in