Package: ghostscript
Version: 10.07.1~dfsg-1
Severity: minor
Tags: patch

  Additional remarks.

  Mails from me to "[email protected]" are no longer acknowledged.  A
Debian maintainer told me, that he would contact the mail administrator
about me not wanting to send bugs upstream.

-.-

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.

-.-

  For forwarding bug reports to upstream see:

https://www.debian.org/Bugs/Developer#forward

-.-

  "Handling bug reports" in
http://people.debian.org/~enrico/dcg/ch03s02.html

-.-

  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 -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 -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=0 -ww -z ":

      1 tbl preprocessor failed, or it or soelim was not run; table(s) likely 
not rendered (TE macro called with TW register undefined)

   * 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 7.0.10+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 ghostscript depends on:
ii  libc6    2.42-16
ii  libgs10  10.07.1~dfsg-1

ghostscript recommends no packages.

Versions of packages ghostscript suggests:
ii  texlive-binaries  2026.20260303.78225+ds-4

-- no debconf information
Input file is ps2epsi.1

Output from "mandoc -T lint  ps2epsi.1": (shortened list)

      1 STYLE: fill mode already enabled, skipping
      2 WARNING: skipping paragraph macro

-.-.

Wrong distance (not two spaces, not a new line character (\n)) 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:good job. There are certain to be cases, however, where the encapsulation

-.-.

Protect "^{Ff}rom " from forcing a mail software to use "quoted-printable"
encoding, by adding "\&" in front of it.

47:from a variety of sources, using Framemaker 3.0 on a Sun workstation.

-.-.

Only one space character is after a possible end of sentence
(after a punctuation, that can end a sentence).

ps2epsi.1:42:good job. There are certain to be cases, however, where the 
encapsulation

-.-.

The first line of the man page should only contain information about the
preprocessing of tables, see man(1), chapter "DEFAULTS".

1: .TH PS2EPSI 1 "18 Sept 2024" 10.04.0 "Ghostscript Tools" \" -*- nroff -*-

-.-.

-.-

Generally:

Split (sometimes) lines after a punctuation mark; before a conjunction.

-.-

Tables:

  Use the preprocessor 'tbl' to make tables.

  Put data, that are wider than the header in the (centered) last column,
in a "T{...\nT}" block(, when the table gets wider than the output line).

  Table headings, that are wider than any data in the corresponding
column, do not need to be centered, so left adjustment (l, L) is
sufficient.
--- ps2epsi.1   2026-06-06 02:16:37.027506526 +0000
+++ ps2epsi.1.new       2026-06-06 02:25:49.798886186 +0000
@@ -1,3 +1,4 @@
+'\" t
 .TH PS2EPSI 1 "18 Sept 2024" 10.04.0 "Ghostscript Tools" \" -*- nroff -*-
 .SH NAME
 ps2epsi \- generate conforming Encapsulated PostScript
@@ -19,7 +20,6 @@ PostScript, and thus has the normal Post
 .SH USAGE
 On Unix systems invoke \fBps2epsi\fR like this:
 .PP
-.br
        \fBps2epsi\fR \fIinfile.ps\fR [ \fIoutfile.epsi\fR ]
 .PP
 where "infile.ps" is the input file and "outfile.epsi" is the resulting
@@ -28,7 +28,6 @@ input filename.  When a standard extensi
 ".epsf") is used, it is replaced with the output extension ".epsi".  On
 DOS systems the command is:
 .PP
-.br
        \fBps2epsi\fR \fIinfile.ps outfile.epi\fR
 .PP
 where "infile.ps" is the original PostScript file, and "outfile.epi"
@@ -44,7 +43,7 @@ does not work because of the content of
 .SH COMPATIBILITY
 The \fBFramemaker\fR DTP system is one application which understands EPSI
 files, and \fBps2epsi\fR has been tested on a number of PostScript diagrams
-from a variety of sources, using Framemaker 3.0 on a Sun workstation.
+\&from a variety of sources, using Framemaker 3.0 on a Sun workstation.
 Framemaker on other platforms should be able to use these files, although I
 have not been able to test this.
 .SH FILES
@@ -55,7 +54,6 @@ ps2epsi>Unix shell script
 ps2epsi.bat>DOS batch file
 ps2epsi.ps>the Ghostscript program which does the work
 .TE
-.fi
 .SH SEE ALSO
 \fBgs\fR(1)
 .SH VERSION
  Check the output from "lintian" in the Debian distribution.

  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 most trailing spaces 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)

-.-
--- Begin Message ---
  Trailing whitespace is so unnecessary, that its presence may be removed
before files containing it are distributed.

  Some programs have a tool to point out its presence, like

gcc

  with option "-Wtrailing-whitespace"

git
  with option "apply --whitespace=..."

  and in ".git/config"

[core]
        whitespace=...

grep

  with option -e ' $'

less

  with command "/ $"

mandoc -T lint

  default action

--- End Message ---

Reply via email to