[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Bug#1091618: marked as done (ovf2ovp.1: Some remarks and a patch with editorial changes for this man page)

Your message dated Thu, 13 Mar 2025 21:07:44 +0000
with message-id <E1tspmK-00GfwG-98@fasolo.debian.org>
and subject line Bug#1091618: fixed in texlive-bin 2024.20240313.70630+ds-6
has caused the Debian Bug report #1091618,
regarding ovf2ovp.1: Some remarks and a patch with editorial changes for this man page
to be marked as done.

This means that you claim that the problem has been dealt with.
If this is not the case it is now your responsibility to reopen the
Bug report if necessary, and/or fix the problem forthwith.

(NB: If you are a system administrator and have no idea what this
message is talking about, this may indicate a serious mail system
misconfiguration somewhere. Please contact owner@bugs.debian.org
immediately.)


-- 
1091618: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=1091618
Debian Bug Tracking System
Contact owner@bugs.debian.org with problems
--- Begin Message --- 
Package: texlive-binaries
Version: 2024.20240313.70630+ds-5+b1
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 ' $' <file>" to find 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>:45: 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: trixie/sid
  APT prefers testing
  APT policy: (500, 'testing')
Architecture: amd64 (x86_64)

Kernel: Linux 6.12.6-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 texlive-binaries depends on:
ii  libc6            2.40-4
ii  libcairo2        1.18.2-2
ii  libfontconfig1   2.15.0-1.1+b1
ii  libfreetype6     2.13.3+dfsg-1
ii  libgcc-s1        14.2.0-8
ii  libgraphite2-3   1.3.14-2+b1
ii  libharfbuzz0b    10.1.0-1
ii  libicu72         72.1-5+b1
ii  libkpathsea6     2024.20240313.70630+ds-5+b1
ii  libmpfi0         1.5.4+ds-4
ii  libmpfr6         4.2.1-1+b2
ii  libpaper2        2.2.5-0.3
ii  libpixman-1-0    0.44.0-3
ii  libpng16-16t64   1.6.44-3
ii  libpotrace0      1.16-2+b2
ii  libptexenc1      2024.20240313.70630+ds-5+b1
ii  libstdc++6       14.2.0-8
ii  libsynctex2      2024.20240313.70630+ds-5+b1
ii  libteckit0       2.5.12+ds1-1+b1
ii  libtexlua53-5    2024.20240313.70630+ds-5+b1
ii  libx11-6         2:1.8.10-2
ii  libxaw7          2:1.0.16-1
ii  libxi6           2:1.8.2-1
ii  libxmu6          2:1.1.3-3+b3
ii  libxpm4          1:3.5.17-1+b2
ii  libxt6t64        1:1.2.1-1.2+b1
ii  libzzip-0-13t64  0.13.72+dfsg.1-1.2+b1
ii  perl             5.40.0-8
ii  t1utils          1.41-4
ii  tex-common       6.18
ii  zlib1g           1:1.3.dfsg+really1.3.1-1+b1

Versions of packages texlive-binaries recommends:
pn  dvisvgm       <none>
ii  texlive-base  2024.20241115-1

Versions of packages texlive-binaries suggests:
pn  hintview               <none>
pn  texlive-binaries-sse2  <none>

Versions of packages tex-common depends on:
ii  ucf  3.0046

Versions of packages tex-common suggests:
pn  debhelper  <none>

Versions of packages texlive-binaries is related to:
ii  tex-common    6.18
ii  texlive-base  2024.20241115-1

-- no debconf information

Input file is ovf2ovp.1

  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

-.-

  So any 'generator' should check its products with the above mentioned
'groff', 'mandoc',  and additionally with 'nroff ...'.

  This is just a simple quality control measure.

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

  Common defects:

  Input text line longer than 80 bytes.

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

  Not beginning each input sentence on a new line.
Lines should thus be shorter.

  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 -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 of 'diff -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)


-.-.

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

      1 input text line longer than 80 bytes
     17 skipping paragraph macro
     37 whitespace at end of input line

-.-.

Output from "test-groff -mandoc -t -ww -z ovf2ovp.1": (shortened list)

      1 trailing space in the line

-.-.

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

22

-.-.

Change a HYPHEN-MINUS (code 0x2D) to a minus(-dash) (\-),
if it
is in front of a name for an option,
is a symbol for standard input,
is a single character used to indicate an option,
or is in the NAME section (man-pages(7)).
N.B. - (0x2D), processed as a UTF-8 file, is changed to a hyphen
(0x2010, groff \[u2010] or \[hy]) in the output.

28:.IP "\fB-charcode-format=\fP\fItype\fP" 
33:.IP "\fB-char-format=\fP\fIstype\fP"
36:-charcode-format.  (These two redundant options both exist only for
38:.IP "\fB-num-format=\fP\fIntype\fP"
41:.IP "\fB-text-format=\fP\fIttype\fP"
44:.IP "\fB-help\fP" 
46:.IP "\fB-verbose\fP" 
48:.IP "\fB-version\fP" 

-.-.

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 abbreviation point as such by suffixing them with "\&".


35:either `num\&' or `ascii\&'\&. Default is `num'; `ascii' as in
83:virtual font was inspired by the work of David R\&. Fuchs who designed a
95:This manual page was written by C\&.M\&. Connelly for the Debian
96:GNU/Linux system\&. It is also now maintained as part of TeX Live.

-.-.

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.


Line 4, length 88

ovf2ovp \- convert virtual font file and associated font metrics to property-list format

-.-.

No need for "\&" to be in front of a period (.) if not at the beginning of
a line.

18:human-readable property-list format\&.  The program writes to standard
30:either `hex\&', `octal\&' or `ascii\&'\&.  Default is
35:either `num\&' or `ascii\&'\&. Default is `num'; `ascii' as in
82:which is part of the standard TeXware library\&.  The idea of a
83:virtual font was inspired by the work of David R\&. Fuchs who designed a
85:for ArborText, Inc\&.  He wrote a somewhat similar program called
95:This manual page was written by C\&.M\&. Connelly for the Debian
96:GNU/Linux system\&. It is also now maintained as part of TeX Live.

-.-.

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

troff:<stdin>:45: warning: trailing space in the line

-.-.

  Additionally (general):

  Abbreviations get a '\&' added after their final full stop (.) to mark them
as such and not as an end of a sentence.

  There is no need to add a '\&' before a full stop (.) if it has a character
before it!

--- ovf2ovp.1	2024-12-28 19:05:44.803452575 +0000
+++ ovf2ovp.1.new	2024-12-28 19:33:41.660113116 +0000
@@ -1,96 +1,81 @@
 .TH OVF2OVP 1 "8 March 2022" "Web2C 2025/dev"
-.PP 
-.SH "NAME" 
-ovf2ovp \- convert virtual font file and associated font metrics to property-list format
-.PP 
-.SH "SYNOPSIS" 
-.PP 
+.SH "NAME"
+ovf2ovp \- convert virtual font file and associated font metrics to
+property-list format
+.SH "SYNOPSIS"
 .B ovf2ovp
 .RI [ options ]
 .IR ovfname [ \fB.ovf\fP ]
 .RI [ ofmname [ \fB.ofm\fP ]
 .RI [ ovpfile [ \fB.ovp\fP ]]]
-.PP 
-.SH "DESCRIPTION" 
-.PP 
+.SH "DESCRIPTION"
 \fBovf2ovp\fP translates a virtual font (OVF) file, \fIovfname\fP,
 and its companion font metric (OFM) file, \fIofmname\fP, into a
-human-readable property-list format\&.  The program writes to standard
-output (by default) or to a file specified as \fIovpname\fP\&.
-.PP 
-The program also works with TeX VF and TFM files, producing TeX VPL
-files\&.
-.PP 
-.SH "OPTIONS" 
+human-readable property-list format.  The program writes to standard
+output (by default) or to a file specified as \fIovpname\fP.
 .PP
+The program also works with TeX VF and TFM files, producing TeX VPL
+files.
+.SH "OPTIONS"
 (Same as \fBofm2opl\fP).
-.IP
-.IP "\fB-charcode-format=\fP\fItype\fP" 
+.IP "\fB\-charcode-format=\fP\fItype\fP"
 output character codes according to \fItype\fP,
-either `hex\&', `octal\&' or `ascii\&'\&.  Default is
-`hex\&'\&; `ascii' says to use
-ASCII for letters and digits, hex for all else\&.
-.IP "\fB-char-format=\fP\fIstype\fP"
+either `hex', `octal' or `ascii'.  Default is
+`hex'; `ascii' says to use
+ASCII for letters and digits, hex for all else.
+.IP "\fB\-char-format=\fP\fIstype\fP"
 output character codes according to \fIstype\fP,
-either `num\&' or `ascii\&'\&. Default is `num'; `ascii' as in
--charcode-format.  (These two redundant options both exist only for
-historical compatibility.)
-.IP "\fB-num-format=\fP\fIntype\fP"
+either `num' or `ascii'.
+Default is `num'; `ascii' as in \-charcode-format.
+(These two redundant options both exist only for historical compatibility.)
+.IP "\fB\-num-format=\fP\fIntype\fP"
 output numbers according to \fIntype\fP,
 either `hex' or `octal'; default is hex.
-.IP "\fB-text-format=\fP\fIttype\fP"
+.IP "\fB\-text-format=\fP\fIttype\fP"
 output coding scheme and family according to \fIttype\fP,
 either `mixed' or `upper' case; default is mixed.
-.IP "\fB-help\fP" 
-display a brief summary of syntax and options 
-.IP "\fB-verbose\fP" 
+.IP "\fB\-help\fP"
+display a brief summary of syntax and options
+.IP "\fB\-verbose\fP"
 display progress reports
-.IP "\fB-version\fP" 
+.IP "\fB\-version\fP"
 output version information and exit
-.IP 
-.PP 
-.SH "FILES" 
-.PP 
-.IP "\fIovpfile\fP" 
+.SH "FILES"
+.IP "\fIovpfile\fP" 9n
 Omega Virtual Property List file
-.IP "\fIofmname\fP" 
+.IP "\fIofmname\fP" 9n
 Omega Font Metric file
-.IP "\fIovfname\fP" 
+.IP "\fIovfname\fP" 9n
 Omega Virtual Font file
-.PP 
-.SH "BUGS" 
-.PP 
+.SH "BUGS"
 Email bug reports to <https://lists.tug.org/tex-k>
 (mailing list); good to check if the same bug is present in
-\fBvftovp\fP(1)\&.
+\fBvftovp\fP(1).
 .PP
 General discussion of Omega (and Aleph) can take place
 on the <http://lists.tug.org/omega> mailing list.
-.PP 
-.SH "SEE ALSO" 
-.PP 
+.SH "SEE ALSO"
 \fBomega\fP(1), \fBaleph\fP(1), \fBofm2opl\fP(1), \fBovp2ovf\fP(1),
 \fBpltotf\fP(1), \fBtftopl\fP(1), \fBvftovp\fP(1),
 \fBvptovf\fP(1)
-.PP 
-.SH "AUTHOR" 
-.PP 
+.SH "AUTHOR"
 According to the WEB documentation:
-.PP 
-.RS 
+.PP
+.RS
 \fBVFtoVP\fP is an extended version of the program \fBTFtoPL\fP,
-which is part of the standard TeXware library\&.  The idea of a
-virtual font was inspired by the work of David R\&. Fuchs who designed a
+which is part of the standard TeXware library.  The idea of a
+virtual font was inspired by the work of David R.\& Fuchs who designed a
 similar set of conventions in 1984 while developing a device driver
-for ArborText, Inc\&.  He wrote a somewhat similar program called
-\fBAMFtoXPL\fP\&.
-.RE 
+for ArborText, Inc.
+He wrote a somewhat similar program called \fBAMFtoXPL\fP.
+.RE
 .PP
 Thus, \fBovf2ovp\fP is based on the WEB source code for \fBvftovp\fP(1),
 although nowadays it is a link to \fBomfonts\fP, implemented entirely in C.
-.PP 
+.PP
 The primary authors of Omega were John Plaice and Yannis Haralambous.
 Omega (and Aleph) are now maintained as part of TeX Live.
-.PP 
-This manual page was written by C\&.M\&. Connelly for the Debian
-GNU/Linux system\&. It is also now maintained as part of TeX Live.
+.PP
+This manual page was written by C.M.\& Connelly for the Debian
+GNU/Linux system.
+It is also now maintained as part of TeX Live.

--- End Message ---
--- Begin Message --- 
Source: texlive-bin
Source-Version: 2024.20240313.70630+ds-6
Done: Hilmar Preuße <hille42@debian.org>

We believe that the bug you reported is fixed in the latest version of
texlive-bin, which is due to be installed in the Debian FTP archive.

A summary of the changes between this version and the previous one is
attached.

Thank you for reporting the bug, which will now be closed.  If you
have further comments please address them to 1091618@bugs.debian.org,
and the maintainer will reopen the bug report if appropriate.

Debian distribution maintenance software
pp.
Hilmar Preuße <hille42@debian.org> (supplier of updated texlive-bin package)

(This message was generated automatically at their request; if you
believe that there is a problem with it please contact the archive
administrators by mailing ftpmaster@ftp-master.debian.org)


-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA512

Format: 1.8
Date: Thu, 13 Mar 2025 21:10:00 +0100
Source: texlive-bin
Architecture: source
Version: 2024.20240313.70630+ds-6
Distribution: unstable
Urgency: medium
Maintainer: Debian TeX Task Force <debian-tex-maint@lists.debian.org>
Changed-By: Hilmar Preuße <hille42@debian.org>
Closes: 1088318 1088853 1091540 1091615 1091618 1091630
Changes:
 texlive-bin (2024.20240313.70630+ds-6) unstable; urgency=medium
 .
   * Patches for manual pages thanks to Bjarni Ingi Gislason
     <bjarniig@simnet.is>.
     - aleph.1 (Closes: #1088318)
     - autosp.1 (Closes: #1088853)
     - opl2ofm.1 (Closes: #1091540)
     - outocp.1: (Closes: #1091615)
     - ovf2ovp.1 (Closes: #1091618)
     - ovp2ovf.1 (Closes: #1091630)
   * Remove mflua.1 from texlive-binaries, it is/will be shipped by
     texlive-extra-utils.
Checksums-Sha1:
 dc61308fd2c9b3bc57f33322a9f20df93593888a 3553 texlive-bin_2024.20240313.70630+ds-6.dsc
 6e30ba9e88a0f712bacc0ee23bb321193f727c54 60420 texlive-bin_2024.20240313.70630+ds-6.debian.tar.xz
 12044c9e89a118f33aab915064a6226d468fb72e 5972 texlive-bin_2024.20240313.70630+ds-6_source.buildinfo
Checksums-Sha256:
 965bf32798a7d5248ad669435263785ce5ac82734788953ffc9694f3478444a3 3553 texlive-bin_2024.20240313.70630+ds-6.dsc
 74f687abfb12d654326a9750e9a3a3c7be762224e1869388c1c7948d85f0430e 60420 texlive-bin_2024.20240313.70630+ds-6.debian.tar.xz
 9593017307864f19ae35f19074b4d28242d4b795da1a576ff589d7894f47a9a2 5972 texlive-bin_2024.20240313.70630+ds-6_source.buildinfo
Files:
 d327d75e22deab7df8335cc94f316e93 3553 tex optional texlive-bin_2024.20240313.70630+ds-6.dsc
 969a57e1372f2ee49d3de5cd55e1c4c3 60420 tex optional texlive-bin_2024.20240313.70630+ds-6.debian.tar.xz
 0101eeaa6360b8f6c13d3c939ddef83b 5972 tex optional texlive-bin_2024.20240313.70630+ds-6_source.buildinfo

-----BEGIN PGP SIGNATURE-----

iQKTBAEBCgB9FiEEaXGmC/nkbIhxf16kxiZYRqvgLIsFAmfTO9NfFIAAAAAALgAo
aXNzdWVyLWZwckBub3RhdGlvbnMub3BlbnBncC5maWZ0aGhvcnNlbWFuLm5ldDY5
NzFBNjBCRjlFNDZDODg3MTdGNUVBNEM2MjY1ODQ2QUJFMDJDOEIACgkQxiZYRqvg
LIveKw//bcfwgkEZgif+9sljm2gvU31ieTkfzNMrLQsNBvjfV0d/M4Xi4JYjXndz
FmU5WjVYSiENh3OOXcuxSocF9t51LIwKyJ2IopULYACPUEnkmISa/uqYdhfxUJ3U
GYi8LkPO/VrHs8Kd9HW+9jGbp2G3WLJpE1kTjPItcBeT2/Gttoa0yaxf4L5wIXM8
JDUU2yASPMFvakMhyiOrgn7wjPxpCZTWSt1IiMoVl4vYNl1GS18xuoSRNImV1GgM
jfWq3FIrMwpMmy1WrU3il3iAT+ypts6uRqdVfqfrfRd65+NxbjhjEu6ibb6iYYcE
QvI2vS0V6Vae7c+bpYn/AMoji4RsnfLSSjstG8gnKLU7me+eUMkUu+LxS0+Va8gV
SXI9LgcYvFmKF+vBD7CUK2eXgvnHJLNQDTF2Kq6so5Ffm6Dr4mNDE/WDawTwexsO
ldmJEHDVW/6lEfmVRmHwOUhqfIwXLocA6R+GGyfAFap8s4MJrHgqtRrrmBgUs50V
5epV0Pwrgft7Uvjb0u5Yvh0ZAzTFc1mK6oTN3y5cels2p7RT/j3PP02WE5eOtRcZ
hYJvNxD/c4aGwnwGZ+squzejzW30+FJhYlOlKG6ySsPlSZDAWd+kjZSDVs5A0w+n
+gOCJKhUhaHVQ0CD795tMQIVwfZOtIyp81fef69XIEsOooMLSo0=
=Rrzn
-----END PGP SIGNATURE-----

Attachment: pgp3QjRgTzxqz.pgp
Description: PGP signature


--- End Message ---
Reply to: