Bug#893444: mandoc.1: Some fixes in the manual
Upstream maintainer talking here. This utterly unhelpful. First of all, please don't commit Debian-specific patches fixing trivial and minor style issues in manual pages to the Debian packaging systems. Report them upstream *instead* of bothering downstream, and they will automatically get fixed after a normal release and version update. Second aspect, reporting such minor nits against an utterly outdated release - the current release is 1.14.3, released more than half a year ago, and there were three more releases in between - isn't all that helpful either. Third aspect, for some of the "issues", it is quite unclear to me what Bjarni is doing. Having seen low-quality bug reports from Bjani before, i doubt that he can explain it better, so please don't bother. Bjarni Ingi Gislason wrote on Sun, Mar 18, 2018 at 09:29:37PM +: > mandoc: mandoc.1:838:4: STYLE: unterminated quoted argument > mandoc: mandoc.1:852:4: STYLE: unterminated quoted argument [...] > mandoc: mandoc.1:2433:4: STYLE: unterminated quoted argument > mandoc: mandoc.1:2441:4: STYLE: unterminated quoted argument Cannot reproduce, even though i spent the time of extracting an old tarball, building from it, and checking the file. The above errors simply do not happen. Neither with the mandoc-1.13.3 release version nor with mandoc-current. > Test nr. 2: > Enable and fix warnings from 'test-groff'. > Input file is /tmp/mandoc.1 > 'R' is a string (producing the registered sign), not a macro. > chk_manuals: Output is from: test-groff -Tutf8 -b -e -mandoc -rF0 -t -w w -z That makes no sense whatsoever. The file mandoc.1 doesn't even use the man(7) language, it uses the mdoc(7) language, so there is certainly no .R macro inside. > troff: :849: warning: can't find special character 'Lq' > troff: :849: warning: can't find special character 'Rq' The file mandoc.1 cotains neither the string "Lq" nor "Rq". > Test nr. 7: > Change (or include a "FIXME" paragraph about) misused SI (metric) > numeric prefixes (or names) to the binary ones, like Ki (kibi), Mi > (mebi), Gi (gibi), or Ti (tebi), if indicated. > If the metric prefixes are correct, add the definitions or an explanation > to avoid misunderstanding. > > 2403:of 2^31 bytes (2 Gigabytes). That is completely irrelevant. The full paragraph reads: Unsupported features *input too large* (mdoc, man) Currently, mandoc cannot handle input files larger than its arbitrary size limit of 2^31 bytes (2 Gigabytes). Since useful manuals are always small, this is not a problem in practice. Parsing is aborted as soon as the condition is detected. Obviously, it doesn't matter at all whether these are GB or GiB, it's just a rough hint for a human reader regarding the order of magnitude of the limit. The largest real-world manuals are barely larger than 1 Megabyte, e.g. perltoc(1). Nothing to fix here. > Test nr. 8: > > Protect a full stop (.) with "\&", if it has a blank (white-space) in front > of or (ignoring transparent characters to the full stop) after it, and it does > not mean an end of a sentence. > > 1654:The first argument, i.e. the name, is printed, but without subsequent That is bogus advice. The first argument, i.e.\& the name, is printed, ... would be completely pointless. That kind of escaping only makes sense when the abbreviation happens to appear at the end of an input line. > Test nr. 17: > Change - to \- if it means a minus sign. > 715:$ mandoc \-T lint \(gafind /usr/src -name \e*\e.[1-9]\(ga That is true, and at some point in the future, i'm going to fix these issues in the OpenBSD tree, including mandoc. It's a known task, it was discussed at length on , where the discussion belongs, and i said that i'm going to do it. But it can't be done overnight. A patch fixing one out of 5000 files completely misses the point. And no, please don't send a patch touching 5000 files either. > Test nr. 20: > Use a macro to change to the italic font, instead of \fI [1], if > possible. > The macros have the italic corrections, but "\c" removes them. > [1] man-pages(7) > > 11:[\fB\-I\fR\ \fBos\fR=\fIname\fR] > 12:[\fB\-K\fR\ \fIencoding\fR] I have no idea what this is. A file called man-pages.* doesn't even exist in the mandoc distribution. The content has some similarities with the mandoc(1) manual page, but i haven't the slightest idea what is going on here. > Test nr. 24: > Change a HYPHEN-MINUS (code 0x55, 2D) to a minus (\-), if in front of a > name for an option. See test 17 above. > Test nr. 26: > Find a repeated word > ! 123 --> the That was in a source code comment(!) and was fixed almost two years ago: http://mandoc.bsd.lv/cgi-bin/cvsweb/term.c.diff?r1=1.256&r2=1.257 The file in question has 18 newer commits by now. > Test nr. 27: > > Split lines longer than 80 characters into two or more > lines. Apropriate break points are the end of a sentence or subordinate > clause. > > mandoc.1: line 995length 95 Obviously a bogu
Bug#893444: mandoc.1: Some fixes in the manual
Package: mandoc Version: 1.14.3-3 Severity: minor Tags: patch Dear Maintainers (also sent to "schwa...@openbsd.org"), A patch is in the attachment. NO PATCH mandoc: mandoc.1:838:4: STYLE: unterminated quoted argument mandoc: mandoc.1:852:4: STYLE: unterminated quoted argument mandoc: mandoc.1:863:4: STYLE: unterminated quoted argument mandoc: mandoc.1:871:4: STYLE: unterminated quoted argument mandoc: mandoc.1:879:4: STYLE: unterminated quoted argument mandoc: mandoc.1:889:4: STYLE: unterminated quoted argument mandoc: mandoc.1:900:4: STYLE: unterminated quoted argument mandoc: mandoc.1:915:4: STYLE: unterminated quoted argument mandoc: mandoc.1:924:4: STYLE: unterminated quoted argument mandoc: mandoc.1:931:4: STYLE: unterminated quoted argument mandoc: mandoc.1:938:4: STYLE: unterminated quoted argument mandoc: mandoc.1:948:4: STYLE: unterminated quoted argument mandoc: mandoc.1:959:4: STYLE: unterminated quoted argument mandoc: mandoc.1:971:4: STYLE: unterminated quoted argument mandoc: mandoc.1:980:4: STYLE: unterminated quoted argument mandoc: mandoc.1:991:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1002:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1010:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1019:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1028:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1038:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1045:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1055:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1064:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1071:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1080:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1087:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1105:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1114:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1124:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1129:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1138:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1148:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1154:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1160:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1171:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1183:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1192:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1199:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1206:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1214:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1221:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1229:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1239:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1246:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1251:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1257:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1277:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1287:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1297:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1306:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1313:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1322:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1369:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1377:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1387:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1407:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1422:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1432:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1440:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1448:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1456:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1490:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1495:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1510:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1521:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1528:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1540:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1551:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1560:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1568:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1584:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1599:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1612:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1620:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1628:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1638:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1648:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1657:4: STYLE: unterminated quoted argument mandoc: mandoc.1:1673:4: STYLE:
