[DRE-maint] Bug#1099692: erb3.3.1: Some remarks and a patch with editorial changes for this man page
Bjarni Ingi Gislason
bjarniig at simnet.is
Thu Mar 6 20:00:20 GMT 2025
Package: ruby3.3
Version: 3.3.7-1
Severity: minor
Tags: patch
* 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=10 -ww -z < "man page"
[Use "groff -e ' $' -e '\\~$' <file>" to find obvious 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?
troff:<stdin>:34: warning: integer value saturated
troff:<stdin>:34: warning: integer value saturated
troff:<stdin>:34: warning: integer value saturated
troff:<stdin>:37: warning: [page 1, 3.3i]: cannot break line
[...]
troff:<stdin>:41: warning: [page 1, 4.2i]: line has non-positive width 0m
[...]
* 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: trixie/sid
APT prefers testing
APT policy: (500, 'testing')
Architecture: amd64 (x86_64)
Kernel: Linux 6.12.12-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 ruby3.3 depends on:
ii libc6 2.40-7
ii libcrypt1 1:4.4.38-1
ii libgmp10 2:6.3.0+dfsg-3
ii libruby3.3 3.3.7-1
ii rubygems-integration 1.19
ii zlib1g 1:1.3.dfsg+really1.3.1-1+b1
Versions of packages ruby3.3 recommends:
ii fonts-lato 2.015-1
ii libjs-jquery 3.6.1+dfsg+~3.5.14-1
ruby3.3 suggests no packages.
-- no debconf information
-------------- next part --------------
Input file is erb3.3.1
Output from "mandoc -T lint erb3.3.1": (shortened list)
1 AUTHORS section without An macro
1 input text line longer than 80 bytes: Specifies the defaul...
1 moving content out of list: Pp
2 moving paragraph macro out of list: Pp
1 new sentence, new line
1 no blank before trailing delimiter: Li to UTF-8.
1 operating system explicitly specified: Os UNIX (NetBSD)
1 skipping no-space macro
1 skipping paragraph macro: Pp after Sh
5 skipping paragraph macro: Pp at the end of Sh
4 skipping paragraph macro: Pp before It
1 skipping paragraph macro: Pp before Pp
1 unknown manual section: Dt ... \&1
-.-.
Output from "test-nroff -mandoc -t -ww -z erb3.3.1": (shortened list)
189 cannot break line
3 integer value saturated
3 line has non-positive width 0m
-.-.
Wrong distance between sentences in the input file.
Separate the sentences and subordinate clauses; each begins on a new
line. See man-pages(7) ("Conventions for source file layout") and
"info groff" ("Input Conventions").
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.
Search for two adjacent words is easier, when they belong to the same line,
and the same phrase.
The amount of space between sentences in the output can then be
controlled with the ".ss" request.
Mark a final abbreviation point as such by suffixing it with "\&".
Some sentences (etc.) do not begin on a new line.
Split (sometimes) lines after a punctuation mark; before a conjunction.
Lines with only one (or two) space(s) between sentences could be split,
so latter sentences begin on a new line.
Use
#!/usr/bin/sh
sed -e '/^\./n' \
-e 's/\([[:alpha:]]\)\. */\1.\n/g' $1
to split lines after a sentence period.
Check result with the difference between the formatted outputs.
See also the attachment "general.bugs"
42:Specifies the default value(s) for external encodings and internal encoding. Values should be separated with colon (:).
-.-.
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.
Add "\:" to split the string for the output, "\<newline>" in the source.
Line 42, length 119
Specifies the default value(s) for external encodings and internal encoding. Values should be separated with colon (:).
-.-.
Space after an end of sentence.
erb3.3.1:42:Specifies the default value(s) for external encodings and internal encoding. Values should be separated with colon (:).
-.-.
Put a subordinate sentence (after a comma) on a new line.
erb3.3.1:23:library, which is an implementation of eRuby.
erb3.3.1:26:Using ERB, actual Ruby code can be added to any plain text document for the
erb3.3.1:44:You can omit the one for internal encodings, then the value
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z ":
troff:<stdin>:34: warning: integer value saturated
troff:<stdin>:34: warning: integer value saturated
troff:<stdin>:34: warning: integer value saturated
troff:<stdin>:37: warning: [page 1, 3.3i]: cannot break line
[...]
troff:<stdin>:41: warning: [page 1, 4.2i]: line has non-positive width 0m
[...]
-.-
Additionally:
Some '-' changed to '\-' to get a longer dash, instead of a hyphen.
Removed string "1234567890123", replaced with the calculated width of it.
-------------- next part --------------
--- erb3.3.1 2025-03-06 13:50:39.046632730 +0000
+++ erb3.3.1.new 2025-03-06 19:47:35.232825959 +0000
@@ -1,47 +1,52 @@
.\"Ruby is copyrighted by Yukihiro Matsumoto <matz at netlab.jp>.
.Dd December 16, 2018
-.Dt ERB \&1 "Ruby Programmer's Reference Guide"
+.Dt ERB 1 "Ruby Programmer's Reference Guide"
.Os UNIX
.Sh NAME
.Nm erb
.Nd Ruby Templating
.Sh SYNOPSIS
.Nm
-.Op Fl -version
+.Op Fl \-version
.Op Fl UPdnvx
-.Op Fl E Ar ext Ns Op Ns : Ns int
+.Op Fl E Ar ext Ns Op : Ns int
.Op Fl S Ar level
.Op Fl T Ar mode
.Op Fl r Ar library
.Op Fl -
.Op file ...
-.Pp
.Sh DESCRIPTION
.Nm
is a command line front-end for
.Li "ERB"
-library, which is an implementation of eRuby.
+library,
+which is an implementation of eRuby.
.Pp
ERB provides an easy to use but powerful templating system for Ruby.
-Using ERB, actual Ruby code can be added to any plain text document for the
-purposes of generating document information details and/or flow control.
+Using ERB,
+actual Ruby code can be added to any plain text document for the
+purposes of generating document information details
+and/or flow control.
.Pp
.Nm
is a part of
.Nm Ruby .
-.Pp
.Sh OPTIONS
-.Bl -tag -width "1234567890123" -compact
-.Pp
-.It Fl -version
+.\" needed for groff instead of a string "1234567890123"
+.nr string_width \w'1234567890123'
+.Bl -tag -width \n[string_width]u -compact
+.It Fl \-version
Prints the version of
.Nm .
.Pp
.It Fl E Ar external Ns Op : Ns Ar internal
-.It Fl -encoding Ar external Ns Op : Ns Ar internal
-Specifies the default value(s) for external encodings and internal encoding. Values should be separated with colon (:).
+.It Fl Fl encoding Ar external Ns Op : Ns Ar internal
+Specifies the default value(s) for external encodings and internal
+encoding.
+Values should be separated with colon (:).
.Pp
-You can omit the one for internal encodings, then the value
+You can omit the one for internal encodings,
+then the value
.Pf ( Li "Encoding.default_internal" ) will be nil.
.Pp
.It Fl P
@@ -58,40 +63,37 @@ can be one of
.Bl -hang -offset indent
.It Sy 0
EOL remains after the embedded ruby script is evaluated.
-.Pp
.It Sy 1
EOL is removed if the line ends with
.Li "%>" .
-.Pp
.It Sy 2
EOL is removed if the line starts with
.Li "<%"
and ends with
.Li "%>" .
-.Pp
.It Sy -
EOL is removed if the line ends with
-.Li "-%>" .
+.Li "\-%>" .
And leading whitespaces are removed if the erb directive starts with
-.Li "<%-" .
-.Pp
+.Li "<%\-" .
.El
+.Pp
.It Fl r
Load a library
.Pp
.It Fl U
can be one of
Sets the default value for internal encodings
-.Pf ( Li "Encoding.default_internal" ) to UTF-8.
+.Pf ( Li "Encoding.default_internal" ) to UTF-8 .
.Pp
.It Fl d
-.It Fl -debug
+.It Fl \-debug
Turns on debug mode.
.Li "$DEBUG"
will be set to true.
.Pp
.It Fl h
-.It Fl -help
+.It Fl \-help
Prints a summary of the options.
.Pp
.It Fl n
@@ -106,9 +108,7 @@ will be set to true.
.Pp
.It Fl x
Converts the eRuby script into Ruby script and prints it without line numbers.
-.Pp
.El
-.Pp
.Sh EXAMPLES
Here is an eRuby script
.Bd -literal -offset indent
@@ -132,7 +132,6 @@ prints
<library>2, 3, 5, 7</library>
</erb-example>
.Ed
-.Pp
.Sh SEE ALSO
.Xr ruby 1 .
.Pp
@@ -141,14 +140,12 @@ And see
documentation for
.Li "ERB"
class.
-.Pp
.Sh REPORTING BUGS
.Bl -bullet
.It
Security vulnerabilities should be reported via an email to
.Mt security at ruby-lang.org .
Reported problems will be published after being fixed.
-.Pp
.It
Other bugs and feature requests can be reported via the
Ruby Issue Tracking System
-------------- next part --------------
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>
The same goes for man pages that are used as an input.
For a style guide use
mandoc -T lint
-.-
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.
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)
-.-
More information about the Pkg-ruby-extras-maintainers
mailing list