]> git.ipfire.org Git - thirdparty/util-linux.git/commitdiff
doc: misc-utils/*: Fix some warnings from "mandoc -T lint"
authorBjarni Ingi Gislason <bjarniig@rhi.hi.is>
Wed, 10 Jun 2020 23:57:22 +0000 (23:57 +0000)
committerKarel Zak <kzak@redhat.com>
Mon, 15 Jun 2020 09:28:01 +0000 (11:28 +0200)
mandoc: ./misc-utils/cal.1:214:2: WARNING: skipping paragraph macro: br after sp
mandoc: ./misc-utils/cal.1:216:2: WARNING: skipping paragraph macro: br before sp
mandoc: ./misc-utils/cal.1:225:2: WARNING: skipping paragraph macro: PP after SH

mandoc: ./misc-utils/findfs.8:36:2: WARNING: skipping paragraph macro: br after sp
mandoc: ./misc-utils/findfs.8:38:2: WARNING: skipping paragraph macro: br before sp
mandoc: ./misc-utils/findfs.8:41:2: WARNING: skipping paragraph macro: br before sp
mandoc: ./misc-utils/findfs.8:44:2: WARNING: skipping paragraph macro: br before sp
mandoc: ./misc-utils/findfs.8:48:2: WARNING: skipping paragraph macro: PP empty

mandoc: ./misc-utils/logger.1:118:15: STYLE: unterminated quoted argument
mandoc: ./misc-utils/logger.1:231:2: WARNING: skipping paragraph macro: IP empty

mandoc: ./misc-utils/look.1:116:2: STYLE: fill mode already disabled, skipping: nf

mandoc: ./misc-utils/hardlink.1:1:5: STYLE: lower case character in document title: TH hardlink
mandoc: ./misc-utils/hardlink.1:1:2: WARNING: missing date, using today's date: TH
mandoc: ./misc-utils/hardlink.1:9:2: WARNING: skipping paragraph macro: PP after SH
mandoc: ./misc-utils/hardlink.1:52:2: WARNING: skipping paragraph macro: PP after SH
mandoc: ./misc-utils/hardlink.1:65:2: WARNING: skipping paragraph macro: PP after SH

mandoc: ./misc-utils/rename.1:65:2: WARNING: skipping paragraph macro: PP empty
mandoc: ./misc-utils/rename.1:65:2: WARNING: skipping paragraph macro: PP empty
mandoc: ./misc-utils/rename.1:97:2: WARNING: skipping paragraph macro: PP empty
mandoc: ./misc-utils/rename.1:107:2: WARNING: skipping paragraph macro: PP empty
mandoc: ./misc-utils/rename.1:116:2: WARNING: skipping paragraph macro: PP empty

mandoc: ./misc-utils/whereis.1:82:2: WARNING: line scope broken: IP breaks TP
mandoc: ./misc-utils/whereis.1:152:2: WARNING: skipping paragraph macro: PP empty

####

  There is no change in the ouput of "nroff" or "groff", except for

1) a very long line in "logger.1".

2) '-' changed to '\-' for a option in "logger.1".

Signed-off-by: Bjarni Ingi Gislason <bjarniig@rhi.hi.is>
misc-utils/cal.1
misc-utils/findfs.8
misc-utils/hardlink.1
misc-utils/logger.1
misc-utils/look.1
misc-utils/rename.1
misc-utils/whereis.1

index ac606b3556516b72e6623491cef89ceff334eef8..2115e9af3a0a6f5ec938ca52099de612b36b132f 100644 (file)
@@ -211,9 +211,7 @@ numbering is used, where the first Thursday is in week number 1.
 Implicit coloring can be disabled as follows:
 .RS
 
-.br
 .B touch /etc/terminal-colors.d/cal.disable
-.br
 
 .RE
 See
@@ -222,7 +220,6 @@ for more details about colorization configuration.
 .SH HISTORY
 A cal command appeared in Version 6 AT&T UNIX.
 .SH BUGS
-.PP
 The default
 .B cal
 output uses 3 September 1752 as the Gregorian calendar reform date.  The
index 26762f83de993994cb6cabbff66e633c55e95c72..59466c1b08a8f8131978a811241dc4ba30930ddd 100644 (file)
@@ -33,19 +33,14 @@ The complete overview about filesystems and partitions you can get for example
 by
 .RS
 
-.br
 .B lsblk \-\-fs
-.br
 
 .B partx --show <disk>
-.br
 
 .B blkid
-.br
 
 .RE
 
-.PP
 .SH EXIT STATUS
 .RS
 .PD 0
index cb23ab190b1d7319c0c307516e5be509a9231302..de26d34b74fb1cf9e10b903583a7fba5c3b9c6cd 100644 (file)
@@ -6,7 +6,6 @@ hardlink \- Consolidate duplicate files via hardlinks
 [options]
 .RI [ directory ...]
 .SH DESCRIPTION
-.PP
 This manual page documents \fBhardlink\fR, a
 program which consolidates duplicate files in one or more directories
 using hardlinks.
@@ -49,7 +48,6 @@ Display help text and exit.
 .BR \-V , " \-\-version"
 Display version information and exit.
 .SH BUGS
-.PP
 \fBhardlink\fR assumes that its target directory trees do not change from under
 it.  If a directory tree does change, this may result in \fBhardlink\fR
 accessing files and/or directories outside of the intended directory tree.
@@ -62,7 +60,6 @@ other characters. That prior behavior can be achieved by specifying
 .br
 \-x '^(\\.in\\.|\\.[^.]{6}$)'
 .SH AUTHORS
-.PP
 \fBhardlink\fR was written by Jakub Jelinek <jakub@redhat.com> and later modified by
 Ruediger Meier <ruediger.meier@ga-group.nl> and Karel Zak <kzak@redhat.com> for util-linux.
 .PP
index 3cf6b0b1ecded0fda999a27c32f577117955ebc4..448311d0382b7e75529e16a3dd03fd2e2fa78191 100644 (file)
@@ -115,7 +115,7 @@ To include newlines in MESSAGE, specify MESSAGE several times.  This is
 handled as a special case, other fields will be stored as an array in
 the journal if they appear multiple times.
 .TP
-.BR \-\-msgid " \fImsgid
+.BI \-\-msgid " msgid"
 Sets the RFC5424 MSGID field.  Note that the space character is not permitted
 inside of \fImsgid\fR.  This option is only used if \fB\-\-rfc5424\fR is
 specified as well; otherwise, it is silently ignored.
@@ -225,12 +225,13 @@ than once for the same element.  Note that the quotation marks around
 .IP
 produces:
 .IP
-.nf
+.\".nf
+.\" this long line gets cut of in the output of "troff", and wraps
+.\" in "nroff"
 \fB  <13>1 2015-10-01T14:07:59.168662+02:00 ws kzak - - [timeQuality tzKnown="1" isSynced="1" syncAccuracy="218616"][zoo@123 tiger="hungry" zebra="running"][manager@123 onMeeting="yes"] this is message
-.fi
-.IP
+.\".fi
 .TP
-.BR \-S , " -\-size " \fIsize
+.BR \-S , " \-\-size " \fIsize
 Sets the maximum permitted message size to \fIsize\fR.  The default
 is 1KiB characters, which is the limit traditionally used and specified
 in RFC 3164.  With RFC 5424, this limit has become flexible.  A good assumption
index 4367fa5eb3c853ed0ac96f2e7d99a23badcbafec..2de4f8d99f7336da4552e476a87a3f596e377af3 100644 (file)
@@ -113,7 +113,7 @@ utility appeared in Version 7 AT&T Unix.
 .nf
 sort \-d /etc/passwd \-o /tmp/look.dict
 look \-t: root:foobar /tmp/look.dict
-.nf
+.fi
 .RE
 .SH SEE ALSO
 .BR grep (1),
index 701bc4f182f255f6d616f05c126e7713da74dac6..6b69ffc9f216d5a473e3943695fd0a6afa70a73d 100644 (file)
@@ -57,12 +57,11 @@ short) in canonical mode, where the line is buffered by the tty and you press
 ENTER to validate the user input.  If you put your tty in cbreak mode however,
 rename requires only a single key press to answer the prompt.  To set cbreak
 mode, run for example:
-.RS
 .PP
+.RS
 .nf
 sh \-c 'stty \-icanon min 1; "$0" "$@"; stty icanon' rename \-i from to files
 .fi
-.PP
 .RE
 .SH EXIT STATUS
 .RS
@@ -88,33 +87,33 @@ unanticipated error occurred
 Given the files
 .IR foo1 ", ..., " foo9 ", " foo10 ", ..., " foo278 ,
 the commands
-.RS
 .PP
+.RS
 .nf
 rename foo foo00 foo?
 rename foo foo0 foo??
 .fi
-.PP
 .RE
+.PP
 will turn them into
 .IR foo001 ", ..., " foo009 ", " foo010 ", ..., " foo278 .
 And
-.RS
 .PP
+.RS
 .nf
 rename .htm .html *.htm
 .fi
-.PP
 .RE
+.PP
 will fix the extension of your html files.
 Provide an empty string for shortening:
-.RS
 .PP
+.RS
 .nf
 rename '_with_long_name' '' file_with_long_name.*
 .fi
-.PP
 .RE
+.PP
 will remove the substring in the filenames.
 .SH SEE ALSO
 .BR mv (1)
index 1b8c3be7cfd94e97a028be69f2e724df2c3226a1..08e351cec2bc54c036872b8d9a0d2a7fbc7da45f 100644 (file)
@@ -79,7 +79,6 @@ searches for "ls" man pages in all default paths, but for "cal" in
 the /usr/share/man/man1 directory only.
 
 .SH OPTIONS
-.TP
 .IP \fB\-b\fP
 Search for binaries.
 .IP \fB\-m\fP
@@ -149,7 +148,6 @@ and
 .B \-S
 are displayed with
 .BR \-l .
-.PP
 .SH ENVIRONMENT
 .IP WHEREIS_DEBUG=all
 enables debug output.