Package: debianutils
Version: 4.9.1
Severity: minor
Tags: patch

Dear Maintainer,

  Input file is savelog.8

Test nr. 2:

Enable and fix warnings from 'test-groff'.


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 ./savelog.8

<savelog.8>:71 (macro IR): only 1 argument, but more are expected

####

Test nr. 16:

Use the correct macro for the font change of a single argument.

71:.IR "file"

#####

Test nr. 36:

Wrong distance between sentences or protect the indicator.

a) Separate the sentences and subordinate clauses; each begins on a new
line.  See man-pages(7) and "info groff".

 The best procedure is to always start a new sentence on a new line,
at least, if you are typing on a computer.

Remember coding: Only one command ("sentence") on each (logical) line.

E-mail: Easier to quote exactly the relevant lines.

Generally: Easier to edit the sentence.

Patches: Less unaffected text.


107:Save cycle versions of the logfile (default: 7). The
126:For xz no strength option is set, and xz decides on the default based on 
the total amount of physical RAM. Note that xz can use a very large amount of 
memory for the higher compression levels.
145:instead of . to roll files

#####

Test nr. 37:

Split lines longer than 80 characters into two or more lines.
Appropriate break points are the end of a sentence and a subordinate
clause; after punctuation marks.

savelog.8: line 8       length 92
[\-J] [\-1\ .\|.\ \-9] [\-C] [\-d] [\-l] [\-r rolldir] [\-n] [\-q] [\-D 
dateformat] file ...

savelog.8: line 126     length 192
For xz no strength option is set, and xz decides on the default based on the 
total amount of physical RAM. Note that xz can use a very large amount of 
memory for the higher compression levels.


#####

Test nr. 42:

Remove superfluous quotation marks (") from the argument of a
single-font macro.

54:.I "file"

#####

Test nr. 59:

Protect a period (.) or a apostrophe (') with '\&' from becoming a
control character, if it could end up at the start of a line

145:instead of . to roll files

#####

  Print constants in bold, not italic (e.g., "file.1")

#####

  Add ".sp 1" to empty lines.

#####

  Patch:

--- savelog.8   2019-12-07 02:13:44.000000000 +0000
+++ savelog.8.new       2020-05-23 02:21:53.000000000 +0000
@@ -5,7 +5,9 @@ savelog \- save a log file
 .SH SYNOPSIS
 .B savelog
 [\-m mode] [\-u user] [\-g group] [\-t] [\-p] [\-c cycle] [\-l] [\-j]
-[\-J] [\-1\ .\|.\ \-9] [\-C] [\-d] [\-l] [\-r rolldir] [\-n] [\-q] [\-D 
dateformat] file ...
+[\-J] [\-1\ .\|.\ \-9] [\-C] [\-d] [\-l] [\-r rolldir] [\-n] [\-q]
+[\-D dateformat] file ...
+.
 .SH DESCRIPTION
 The
 .B savelog
@@ -14,9 +16,9 @@ of
 .I file
 are named:
 .RS
-
-.IR "file" "." "<number>" "" "<compress_suffix>"
-
+.sp 1
+.IR file "." <number> "" <compress_suffix>
+.sp 1
 .RE
 where
 .I <number>
@@ -29,49 +31,49 @@ have
 opened for I/O.  Only
 .I cycle
 versions of the file are kept.
-
+.sp 1
 If the file does not exist and
 .B \-t
 was given, it will be created.
-
+.sp 1
 For files that do exist and have lengths greater than zero, the following
 actions are performed:
-
+.sp 1
 .IP 1)
 Version numbered files are cycled.  Version
-.IR "file" "." "2"
+.IB file \&.2
 is moved to version
-.IR "file" "." "3",
+.IB file \&.3 \fR,
 version
-.IR "file" "." "1"
+.IB file \&.1
 is moved to version
-.IR "file" "." "2",
+.IB file \&.2 \fR,
 and so on.  Finally version
-.IR "file" "." "0"
+.IB file \&.0
 is moved to version
-.IR "file" "." "1",
+.IB file \&.1 \fR,
 and version
-.I "file"
+.I file
 is deleted.  Both
 compressed names and uncompressed names are cycled, regardless of
 .BR \-l .
 Missing version files are ignored.
-
+.
 .IP 2)
 The new
-.IR "file" "." "1"
+.IB file \&.1
 is compressed unless the
 .B \-l
 flag was given.  It is changed subject to the
 .BR "\-m" ", " "\-u" ", and " "\-g"
 flags.
-
+.
 .IP 3)
 The main
-.IR "file"
+.I file
 is moved to
-.IR "file" "." "0".
-
+.IB file .0 \fR.
+.
 .IP 4)
 If the
 .BR "\-m" ", " "\-u" ", " "\-g" ",  " "\-t" ", or " "\-p"
@@ -81,14 +83,14 @@ is created subject to the given flags.
 .B \-p
 flag, the file is created with the same owner, group, and permissions as
 before.
-
+.
 .IP 5)
 The new
-.IR "file" "." "0"
+.IB file \&.0
 is changed subject to the
 .BR "\-m" ", " "\-u" ", and " "\-g"
 flags.
-
+.
 .SH OPTIONS
 .TP
 .B "\-m mode"
@@ -104,7 +106,8 @@ chgrp log files to group, implies
 .B \-t
 .TP
 .B "\-c cycle"
-Save cycle versions of the logfile (default: 7). The
+Save cycle versions of the logfile (default: 7).
+The
 .I cycle
 count must be at least 2.
 .TP
@@ -122,8 +125,12 @@ compress with bzip2 instead of gzip
 .TP
 .B \-J
 compress with xz instead of gzip
-
-For xz no strength option is set, and xz decides on the default based on the 
total amount of physical RAM. Note that xz can use a very large amount of 
memory for the higher compression levels.
+.sp 1
+For xz no strength option is set,
+and xz decides on the default based on the total amount of physical
+RAM.
+Note that xz can use a very large amount of memory for the higher
+compression levels.
 .TP
 .B \-1\ .\|.\ \-9
 compression strength or memory usage (default: 9, except for xz)
@@ -142,7 +149,7 @@ command
 .B \-r
 use
 .I rolldir
-instead of . to roll files
+instead of \&.\& to roll files
 .TP
 .B \-n
 do not rotate empty files
@@ -151,10 +158,10 @@ do not rotate empty files
 be quiet
 .SH BUGS
 If a process is still writing to
-.IR "file.0" ","
+.IB file \&.0 \fR,
 and savelog moves it to
-.I file.1
+.IB file \&.1
 and compresses it, data could be lost.
-
-.SH "SEE ALSO"
+.
+.SH SEE ALSO
 .BR logrotate (8)



-- System Information:
Debian Release: bullseye/sid
  APT prefers testing
  APT policy: (500, 'testing'), (500, 'stable')
Architecture: amd64 (x86_64)

Kernel: Linux 5.6.14-1 (SMP w/2 CPU cores)
Locale: LANG=is_IS.iso88591, LC_CTYPE=is_IS.iso88591 (charmap=ISO-8859-1), 
LANGUAGE=is_IS.iso88591 (charmap=ISO-8859-1)
Shell: /bin/sh linked to /bin/dash
Init: sysvinit (via /sbin/init)

Versions of packages debianutils depends on:
ii  libc6  2.30-8

debianutils recommends no packages.

debianutils suggests no packages.

-- no debconf information

-- 
Bjarni I. Gislason

Reply via email to