]> git.ipfire.org Git - thirdparty/util-linux.git/commitdiff
doc: Fix some warnings from "test-groff" for manuals
authorBjarni Ingi Gislason <bjarniig@rhi.hi.is>
Wed, 10 Jun 2020 02:17:50 +0000 (02:17 +0000)
committerKarel Zak <kzak@redhat.com>
Wed, 10 Jun 2020 08:22:58 +0000 (10:22 +0200)
Source is current git content.

Output is from: test-groff -b -e -mandoc -T utf8 -rF0 -t -w w -z

  [ "test-groff" is a developmental version of "groff" ]

Input file is ././disk-utils/sfdisk.8

troff: backtrace: file '<./disk-utils/sfdisk.8>':67
troff: <./disk-utils/sfdisk.8>:67: warning: trailing space

Input file is ././misc-utils/kill.1

troff: backtrace: '/home/bg/git/groff/build/s-tmac/an-ext.tmac':133: macro 'EE'
troff: backtrace: file '<./misc-utils/kill.1>':167
troff: <./misc-utils/kill.1>:167: warning: macro 'mF' not defined
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an-ext.tmac':134: macro 'EE'
troff: backtrace: file '<./misc-utils/kill.1>':167
troff: <./misc-utils/kill.1>:167: warning: number register 'mE' not defined
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an-ext.tmac':134: macro 'EE'
troff: backtrace: file '<./misc-utils/kill.1>':167
troff: <./misc-utils/kill.1>:167: warning: bad font number
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an-ext.tmac':135: macro 'EE'
troff: backtrace: file '<./misc-utils/kill.1>':167
troff: <./misc-utils/kill.1>:167: warning: number register 'sP' not defined
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an-ext.tmac':134: macro 'EE'
troff: backtrace: file '<./misc-utils/kill.1>':170
troff: <./misc-utils/kill.1>:170: warning: bad font number

Input file is ././sys-utils/ipcs.1

<./sys-utils/ipcs.1>:103 (macro BR): only 1 argument, but more are expected

Input file is ././sys-utils/mount.8

<./sys-utils/mount.8>:68 (macro RB): only 1 argument, but more are expected
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an-old.tmac':467: macro 'RB'
troff: backtrace: file '<./sys-utils/mount.8>':68
troff: <./sys-utils/mount.8>:68: warning [p 1, 3.5i]: can't break line
an-old.tmac: <./sys-utils/mount.8>:201 (.RE): warning: extra .RE or .RS is missing before it; "an-RS-open" is 0.
<./sys-utils/mount.8>:453 (macro BR): only 1 argument, but more are expected
<./sys-utils/mount.8>:500 (macro BR): only 1 argument, but more are expected
<./sys-utils/mount.8>:1050 (macro BR): only 1 argument, but more are expected

Input file is ././sys-utils/setpriv.1

<./sys-utils/setpriv.1>:17 (macro BR): only 1 argument, but more are expected
<./sys-utils/setpriv.1>:154 (macro BR): only 1 argument, but more are expected
<./sys-utils/setpriv.1>:166 (macro BR): only 1 argument, but more are expected

Input file is ././sys-utils/umount.8

<./sys-utils/umount.8>:145 (macro IR): only 1 argument, but more are expected

Input file is ././sys-utils/unshare.1

<./sys-utils/unshare.1>:266 (macro BR): only 1 argument, but more are expected

[kzak@redhat.com: - add .RS to fix extra .RE in mount.8]

Signed-off-by: Bjarni Ingi Gislason <bjarniig@rhi.hi.is>
Signed-off-by: Karel Zak <kzak@redhat.com>
disk-utils/sfdisk.8
misc-utils/kill.1
sys-utils/ipcs.1
sys-utils/mount.8
sys-utils/setpriv.1
sys-utils/umount.8
sys-utils/unshare.1

index 2f8afe88cb3163308e603a5d51afdc95984efbc4..e3b479cbf2436dc90a095291932c14b7ffcd9999 100644 (file)
@@ -64,7 +64,7 @@ uses BLKRRPART (reread partition table) ioctl to make sure that the device is
 not used by system or other tools (see also \-\-no-reread).  It's possible that
 this feature or another sfdisk activity races with \fBudevd\fR.  The recommended way
 how to avoid possible collisions is to use \fB\-\-lock\fR option.
-The exclusive lock will cause udevd to skip the event handling on the device. 
+The exclusive lock will cause udevd to skip the event handling on the device.
 .PP
 The sfdisk prompt is only a hint for users and a displayed partition number does
 not mean that the same partition table entry will be created (if -N not
index 6ca318a6a73afef8fefdc032097de4aa203314e6..5e0ebaf37c9ac4ba4361d8566cc29e47c8085691 100644 (file)
@@ -164,7 +164,7 @@ the signals QUIT, TERM and KILL in sequence and waits for 1000
 milliseconds between sending the signals:
 .IP
 .in +4n
-.EE
+.EX
 kill \-\-verbose \-\-timeout 1000 TERM \-\-timeout 1000 KILL \e
         \-\-signal QUIT 12345
 .EE
index d259a7df6fd3ecc237c7f8f094bba131e528c58b..4d1388485dda6b0bb55c419d23cac05342baff94 100644 (file)
@@ -100,7 +100,7 @@ The current implementation of
 obtains information about available IPC resources by parsing the files in
 .IR /proc/sysvipc .
 Before util-linux version v2.23, an alternate mechanism was used: the
-.BR IPC_STAT
+.B IPC_STAT
 command of
 .BR msgctl (2),
 .BR semctl (2),
index e4ded7e5df130da0e4c5835c0f71de76319f37dc..f8e7e0850c4d8e042745f315c4b8776fd090c1d0 100644 (file)
@@ -61,11 +61,12 @@ mount \- mount a filesystem
 .I device mountpoint
 .LP
 .B mount
-.RB \-\-bind | \-\-rbind | \-\-move
+.BR \-\-bind | \-\-rbind | \-\-move
 .I olddir newdir
 .LP
 .B mount
-.RB \-\-make\-{shared|slave|private|unbindable|rshared|rslave|rprivate|runbindable}
+.BR \-\-make\- { shared | slave | private | unbindable | rshared | \
+rslave | rprivate | runbindable }
 .I mountpoint
 .SH DESCRIPTION
 All files accessible in a Unix system are arranged in one big
@@ -166,6 +167,7 @@ and adding or removing a device can cause changes in names.
 This is the reason why it's
 strongly recommended to use filesystem or partition identifiers like UUID or
 LABEL. Currently supported identifiers (tags):
+.RS
 .TP
 LABEL=\fIlabel\fR
 Human readable filesystem identifier. See also \fB\-L\fR.
@@ -450,7 +452,7 @@ a second place by using:
 Note that the filesystem mount options maintained by the kernel will remain the same as those
 on the original mount point.  The userspace mount options (e.g., _netdev) will not be copied
 by
-.BR mount
+.B mount
 and it's necessary to explicitly specify the options on the
 .B mount
 command line.
@@ -497,7 +499,7 @@ filesystem-specific flags) are silently ignored.  It's impossible to change moun
 options recursively (for example with \fB\-o rbind,ro\fR).
 
 Since util-linux 2.31,
-.BR mount
+.B mount
 ignores the \fBbind\fR flag from
 .I /etc/fstab
 on a
@@ -1047,7 +1049,7 @@ Verbose mode.
 .TP
 .BR \-w , " \-\-rw" , " \-\-read\-write"
 Mount the filesystem read/write.  Read-write is the kernel default and the
-.BR mount
+.B mount
 default is to try read-only if the previous mount syscall with read-write flags
 on write-protected devices of filesystems failed.
 .sp
index dbf5772edb6b089f9a18dd5aa1488409c3939c75..939b69a3af027cdf00019f3c17dea0935bd3e9b7 100644 (file)
@@ -14,7 +14,7 @@ In comparison to
 .BR su (1)
 and
 .BR runuser (1),
-.BR setpriv
+.B setpriv
 neither uses PAM, nor does it prompt for a password.
 It is a simple, non-set-user-ID wrapper around
 .BR execve (2),
@@ -151,7 +151,7 @@ credentials to remedy that situation.
 .BI \-\-selinux\-label " label"
 Request a particular SELinux transition (using a transition on exec, not
 dyntrans).  This will fail and cause
-.BR setpriv
+.B setpriv
 to abort if SELinux is not in use, and the transition may be ignored or cause
 .BR execve (2)
 to fail at SELinux's whim.  (In particular, this is unlikely to work in
@@ -163,7 +163,7 @@ This is similar to
 .BI \-\-apparmor\-profile " profile"
 Request a particular AppArmor profile (using a transition on exec).  This will
 fail and cause
-.BR setpriv
+.B setpriv
 to abort if AppArmor is not in use, and the transition may be ignored or cause
 .BR execve (2)
 to fail at AppArmor's whim.
index ff26d413ef6e825c275d976dfb8605aa1a17b886..6f402fd675cf7ee5e08cb12fa8954828b1471051 100644 (file)
@@ -142,7 +142,7 @@ or special file representing that namespace.
 switches to the namespace when it reads
 .IR /etc/fstab ,
 writes
-.IR /etc/mtab
+.I /etc/mtab
 (or writes to
 .IR /run/mount )
 and calls
index 5292880afbee85129a534661f2ae26e815e6db0a..2096f45ab3bed9e91648157b1cd64f363373aec4 100644 (file)
@@ -263,7 +263,7 @@ and that a new
 filesystem is mounted that contains information corresponding to the new
 PID namespace.
 When the
-.BR readlink
+.B readlink
 command terminates, the new namespaces are automatically torn down.
 .PP
 .in +4n