Package: libunicode-linebreak-perl
Version: 0.0.20190101-3
Severity: minor
Tags: patch

Dear Maintainer,

>From "/usr/share/doc/debian/bug-reporting.txt.gz":

  Don't file bugs upstream

   If you file a bug in Debian, don't send a copy to the upstream software
   maintainers yourself, as it is possible that the bug exists only in
   Debian. If necessary, the maintainer of the package will forward the
   bug upstream.

-.-

  I do not send reports upstream if I have to get an account there.
The Debian maintainers have one already.

  If I get a negative (or no) response from upstream, I send henceforth
bugs to Debian.

-.-

   * What led up to the situation?

     Checking for defects with a new version

test-[g|n]roff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=0 -ww -z < "man page"

  [Use 

grep -n -e ' $' -e '\\~$' -e ' \\f.$' -e ' \\"' <file>

  to find (most) trailing spaces.]

  ["test-groff" is a script in the repository for "groff"; is not shipped]
(local copy and "troff" slightly changed by me).

  [The fate of "test-nroff" was decided in groff bug #55941.]

   * What was the outcome of this action?

Output from "test-groff  -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=0 -ww -z ":

troff:<stdin>:70: warning: trailing space in the line
troff:<stdin>:232: warning: trailing space in the line

   * What outcome did you expect instead?

     No output (no warnings).

-.-

  General remarks and further material, if a diff-file exist, are in the
attachments.


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

Kernel: Linux 6.17.13+deb14-amd64 (SMP w/2 CPU threads; PREEMPT)
Locale: LANG=is_IS.iso88591, LC_CTYPE=is_IS.iso88591 (charmap=ISO-8859-1), 
LANGUAGE not set
Shell: /bin/sh linked to /usr/bin/dash
Init: sysvinit (via /sbin/init)

Versions of packages libunicode-linebreak-perl depends on:
ii  libc6                       2.42-10+b1
ii  libmime-charset-perl        1.013.1-2
ii  libsombok3                  2.4.0-2+b3
ii  perl                        5.40.1-7
ii  perl-base [perlapi-5.40.1]  5.40.1-7

libunicode-linebreak-perl recommends no packages.

libunicode-linebreak-perl suggests no packages.

-- no debconf information
Input file is Text::LineFold.3pm

Output from "mandoc -T lint  Text::LineFold.3pm": (shortened list)

      1 STYLE: input text line longer than 80 bytes: 
      1 STYLE: whitespace at end of input line
      2 WARNING: empty block: RS

Find most trailing spaces with:
grep -n -e ' $' -e ' \\f.$' -e ' \\"' <man page>

-.-.

Output from
test-nroff -mandoc -t -ww -z Text::LineFold.3pm: (shortened list)

      2 line(s) with a trailing space

Find most trailing spaces with:
grep -n -e ' $' -e ' \\f.$' -e ' \\"' <man page>

-.-.

Input file is Text::LineFold.3pm

Show if Pod::Man generated this.

2:.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)

Latest version in Debian testing:

This is perl 5, version 40, subversion 1 (v5.40.1) built for 
x86_64-linux-gnu-thread-multi
(with 48 registered patches, see perl -V for more detail)

-.-.

Remove space characters (whitespace) at the end of lines.
Use "git apply ... --whitespace=fix" to fix extra space issues, or use
global configuration "core.whitespace".

Number of lines affected is

2

-.-.

Change '-' (\-) to '\(en' (en-dash) for a (numeric) range.

GNU gnulib has recently (2023-06-18) updated its
"build_aux/update-copyright" to recognize "\(en" in man pages.

Text::LineFold.3pm:230:Copyright (C) 2009\-2012 Hatuka*nezumi \- IKEDA Soji 
<hatuka(at)nezumi.nu>.

-.-.

Strings longer than 3/4 of a standard line length (80).

Use "\:" to split the string at the end of an output line, for example a
long URL (web address).
This is a groff extension.

221 <http://rt.cpan.org/Public/Dist/Display.html?Name=Unicode\-LineBreak>.

-.-.

Split lines longer than 80 characters (fill completely
an A4 sized page line on a terminal)
into two or more lines.
Appropriate break points are the end of a sentence and a subordinate
clause; after punctuation marks.
Add "\:" to split the string for the output, "\<newline>" in the source.  

Line 58, length 86

.TH Text::LineFold 3pm 2026-01-23 "perl v5.40.1" "User Contributed Perl 
Documentation"

Line 119, length 83

If a special value \f(CW"_UNICODE_"\fR is specified, result will be Unicode 
string.


Longest line is number 58 with 86 characters

-.-.

Add a zero (0) in front of a decimal fraction that begins with a period
(.)

7:.if t .sp .5v

-.-.

Use a character "\(->" instead of plain "->" or "\->", if not typeset with
a constant width font.

69:\&    $lf = Text::LineFold\->new();
72:\&    $folded = $lf\->fold($string, \*(AqPLAIN\*(Aq);
73:\&    $indented = $lf\->fold(\*(Aq \*(Aq x 8, \*(Aq \*(Aq x 4, $string);
76:\&    $unfolded = $lf\->unfold($string, \*(AqFIXED\*(Aq);
89:.ie n .IP "$self\->config (KEY)" 4
90:.el .IP "\f(CW$self\fR\->config (KEY)" 4
91:.IX Item "$self->config (KEY)"
93:.ie n .IP "$self\->config ([KEY => VAL, ...])" 4
94:.el .IP "\f(CW$self\fR\->config ([KEY => VAL, ...])" 4
95:.IX Item "$self->config ([KEY => VAL, ...])"
154:.ie n .IP "$self\->fold (STRING, [METHOD])" 4
155:.el .IP "\f(CW$self\fR\->fold (STRING, [METHOD])" 4
156:.IX Item "$self->fold (STRING, [METHOD])"
158:.ie n .IP "$self\->fold (INITIAL_TAB, SUBSEQUENT_TAB, STRING, ...)" 4
159:.el .IP "\f(CW$self\fR\->fold (INITIAL_TAB, SUBSEQUENT_TAB, STRING, ...)" 4
160:.IX Item "$self->fold (INITIAL_TAB, SUBSEQUENT_TAB, STRING, ...)"
192:.ie n .IP "$self\->unfold (STRING, METHOD)" 4
193:.el .IP "\f(CW$self\fR\->unfold (STRING, METHOD)" 4
194:.IX Item "$self->unfold (STRING, METHOD)"

-.-.

Add lines to use the CR font for groff instead of CW.

.if t \{\
.  ie \\n(.g .ft CR
.  el .ft CW
.\}


11:.ft CW

-.-.

.\" Define a fallback for the CW font
.
.if \n(.g \{\
.  ie t .ftr CW CR
.  el .ftr CW R
.\}

90:.el .IP "\f(CW$self\fR\->config (KEY)" 4
94:.el .IP "\f(CW$self\fR\->config ([KEY => VAL, ...])" 4
104:Default is \f(CW"UTF\-8"\fR.
109:Default is \f(CW"XX"\fR.
114:Default is \f(CW"\en"\fR.
119:If a special value \f(CW"_UNICODE_"\fR is specified, result will be Unicode 
string.
155:.el .IP "\f(CW$self\fR\->fold (STRING, [METHOD])" 4
159:.el .IP "\f(CW$self\fR\->fold (INITIAL_TAB, SUBSEQUENT_TAB, STRING, ...)" 4
172:.el .IP "\f(CW""FIXED""\fR" 4
174:Lines preceded by \f(CW">"\fR won't be folded.
177:.el .IP "\f(CW""FLOWED""\fR" 4
179:\&\f(CW"Format=Flowed; DelSp=Yes"\fR formatting defined by RFC 3676.
181:.el .IP "\f(CW""PLAIN""\fR" 4
193:.el .IP "\f(CW$self\fR\->unfold (STRING, METHOD)" 4
200:.el .IP "\f(CW""FIXED""\fR" 4
203:Lines preceded by \f(CW">"\fR won't be conjuncted.
206:.el .IP "\f(CW""FLOWED""\fR" 4
208:Unfold \f(CW"Format=Flowed; DelSp=Yes"\fR formatting defined by RFC 3676.
210:.el .IP "\f(CW""FLOWEDSP""\fR" 4
212:Unfold \f(CW"Format=Flowed; DelSp=No"\fR formatting defined by RFC 3676.
224:Consult \f(CW$VERSION\fR variable.

-.-.

Put a (long) web address on a new output line to reduce the posibility of
splitting the address between two output lines.
Or inhibit hyphenation with "\%" in front of the name.


221:<http://rt.cpan.org/Public/Dist/Display.html?Name=Unicode\-LineBreak>.

-.-.

Change comment lines of type '.\" ====' (and an empty '.\"' line) to
a single period, as they contain no information and waste work each time
they are processed.

3:.\"
5:.\" ========================================================================
28:.\"
32:.\"
37:.\"
55:.\" ========================================================================
56:.\"

-.-.

Output from "test-groff  -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=0 -ww -z ":

troff:<stdin>:70: warning: trailing space in the line
troff:<stdin>:232: warning: trailing space in the line

-.-

Additionally:

Remove empty RS blocks.

-.-

Generally:

Split (sometimes) lines after a punctuation mark; before a conjunction.
--- Text::LineFold.3pm  2026-01-29 16:57:45.034933846 +0000
+++ Text::LineFold.3pm.new      2026-01-29 17:13:59.856088730 +0000
@@ -4,14 +4,25 @@
 .\" Standard preamble:
 .\" ========================================================================
 .de Sp \" Vertical space (when we can't use .PP)
-.if t .sp .5v
+.if t .sp 0.5v
 .if n .sp
 ..
+.
 .de Vb \" Begin verbatim text
-.ft CW
+.if t \{\
+.  ie \\n(.g .ft CR
+.  el .ft CW
+.\}
 .nf
 .ne \\$1
 ..
+.\" Define a fallback for the CW font
+.
+.if \n(.g \{\
+.  ie t .ftr CW CR
+.  el .ftr CW R
+.\}
+.
 .de Ve \" End verbatim text
 .ft R
 .fi
@@ -67,7 +78,7 @@ Text::LineFold \- Line Folding for Plain
 .Vb 2
 \&    use Text::LineFold;
 \&    $lf = Text::LineFold\->new();
-\&    
+\&
 \&    # Fold lines
 \&    $folded = $lf\->fold($string, \*(AqPLAIN\*(Aq);
 \&    $indented = $lf\->fold(\*(Aq \*(Aq x 8, \*(Aq \*(Aq x 4, $string);
@@ -149,8 +160,6 @@ Default is 8.
 .PD
 See "Options" in Unicode::LineBreak.
 .RE
-.RS 4
-.RE
 .ie n .IP "$self\->fold (STRING, [METHOD])" 4
 .el .IP "\f(CW$self\fR\->fold (STRING, [METHOD])" 4
 .IX Item "$self->fold (STRING, [METHOD])"
@@ -211,8 +220,6 @@ Unfold \f(CW"Format=Flowed; DelSp=Yes"\f
 .IX Item """FLOWEDSP"""
 Unfold \f(CW"Format=Flowed; DelSp=No"\fR formatting defined by RFC 3676.
 .RE
-.RS 4
-.RE
 .SH BUGS
 .IX Header "BUGS"
 Please report bugs or buggy behaviors to developer.
@@ -227,7 +234,7 @@ Consult \f(CW$VERSION\fR variable.
 Unicode::LineBreak, Text::Wrap.
 .SH AUTHOR
 .IX Header "AUTHOR"
-Copyright (C) 2009\-2012 Hatuka*nezumi \- IKEDA Soji <hatuka(at)nezumi.nu>.
+Copyright (C) 2009\(en2012 Hatuka*nezumi \- IKEDA Soji <hatuka(at)nezumi.nu>.
 .PP
-This program is free software; you can redistribute it and/or modify it 
+This program is free software; you can redistribute it and/or modify it
 under the same terms as Perl itself.
  Any program (person), that produces man pages, should check the output
for defects by using (both groff and nroff)

[gn]roff -mandoc -t -ww -b -z -K utf8 <man page>

  To find trailing space use

grep -n -e ' $' -e ' \\f.$' -e ' \\"' <man page>

  The same goes for man pages that are used as an input.

-.-

  For a style guide use

  mandoc -T lint

-.-

  For general input conventions consult the man page "nroff(7)" (item
"Input conventions") or the Texinfo manual about the same item.

-.-

  Any "autogenerator" should check its products with the above mentioned
'groff', 'mandoc', and additionally with 'nroff ...'.

  It should also check its input files for too long (> 80) lines.

  This is just a simple quality control measure.

  The "autogenerator" may have to be corrected to get a better man page,
the source file may, and any additional file may.

-.-

  Common defects:

  Not removing trailing spaces (in in- and output).
  The reason for these trailing spaces should be found and eliminated.

  "git" has a "tool" to point out whitespace,
see for example "git-apply(1)" and git-config(1)")

-.-

  Not beginning each input sentence on a new line.

Line length and patch size should thus be reduced when that has been fixed.

  The script "reportbug" uses 'quoted-printable' encoding when a line is
longer than 1024 characters in an 'ascii' file.

  See man-pages(7), item "semantic newline".

-.-

The difference between the formatted output of the original
and patched file can be seen with:

  nroff -mandoc <file1> > <out1>
  nroff -mandoc <file2> > <out2>
  diff -d -u <out1> <out2>

and for groff, using

\"printf '%s\n%s\n' '.kern 0' '.ss 12 0' | groff -mandoc -Z - \"

instead of 'nroff -mandoc'

  Add the option '-t', if the file contains a table.

  Read the output from 'diff -d -u ...' with 'less -R' or similar.

-.-.

  If 'man' (man-db) is used to check the manual for warnings,
the following must be set:

  The option "-warnings=w"

  The environmental variable:

export MAN_KEEP_STDERR=yes (or any non-empty value)

  or

  (produce only warnings):

export MANROFFOPT="-ww -b -z"

export MAN_KEEP_STDERR=yes (or any non-empty value)

-.-

Reply via email to