#1100574 hunspell.1: Some remarks and a patch with editorial changes for this man page

Package:
hunspell
Source:
hunspell
Description:
spell checker and morphological analyzer (program)
Submitter:
Bjarni Ingi Gislason
Date:
2025-03-16 22:03:01 UTC
Severity:
normal
Tags:
#1100574#5
Date:
2025-03-15 15:30:09 UTC
From:
To:
   * 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?

an.tmac:<stdin>:1: style: .TH missing fourth argument; consider package/project name and version (e.g., "groff 1.23.0")
troff:<stdin>:12: warning: trailing space in the line
troff:<stdin>:90: warning: trailing space in the line
troff:<stdin>:275: warning: trailing space in the line
an.tmac:<stdin>:331: misuse, warning: .BR is for at least 2 arguments, got 1
	Use macro '.B' for one argument or split argument.
troff:<stdin>:383: warning: trailing space in the line
troff:<stdin>:390: warning: trailing space in the line
an.tmac:<stdin>:398: misuse, warning: .BI is for at least 2 arguments, got 1
	Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:401: misuse, warning: .BI is for at least 2 arguments, got 1
	Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:405: misuse, warning: .BI is for at least 2 arguments, got 1
	Use macro '.B' for one argument or split argument.


   * What outcome did you expect instead?

     No output (no warnings).

-.-

  General remarks and further material, if a diff-file exist, are in the
attachments.
#1100574#8
Date:
2025-03-15 16:45:42 UTC
From:
To:
Hi Bjarni,


Yeah, well...
writing groff is an art...

Thank you for the patch, could I interest you into sending it upstream
here?
https://github.com/hunspell/hunspell
#1100574#13
Date:
2025-03-15 19:43:44 UTC
From:
To:
[...]

  No interest, it is too complicated for me.

  There exists an alternative called forwarding.

  What seems to be missing, is software in Debian toolbox that makes this
simple for any downstream maintainer.

  In Debian I only found "pkg-perl-tool" which is described as:

  This collection contains the tools which help the group with day-to-day
work, like filing ITPs, forwarding bugs and patches upstream, taking over
a package for ...
#1100574#16
Date:
2025-03-16 13:10:37 UTC
From:
To:
I tried applying your patch against the file man/hunspell.1, however
it's full of conflicts.  Could you explain on what file that diff is
based on?

Of course, in Debian it's generally considered responsability of the
maintainer to submit patches upstream, I was just asking to avoid a
middleman.

Well, personally I blame this on the upstream project as they close off
easier submission channels (plain mails), but anyway...
#1100574#21
Date:
2025-03-16 21:59:30 UTC
From:
To:
  There is a encoding mismatch in the diff-file in the line with UTF-8 code

Author of Hunspell executable ...

  The diff-file must be converted to ISO-8859-1 with (or with the mailer)
---cut---
#!/bin/sh
set -efu

#local_charmap=$(locale -k charmap | sed -e 's/^charmap=//' -e 's/"//g')
#echo charmap = $local_charmap
local_charmap=ISO-8859-1
iconv -f UTF-8 -t ${local_charmap}//TRANSLIT  ${1:-}

exit
---cut---

  My mailer was not configured to send utf-8.

patch --reverse --dry-run hunspell.1 hunspell.1.diff

  shows

checking file hunspell.1
Hunk #17 FAILED at 372.
1 out of 17 hunks FAILED


[...]