luaotfload-tool.1: Some editorial remarks about this man page
Bjarni Ingi Gislason <[email protected]> Mon, 3 Aug 2026 21:45:02 +0000
| Newsgroups | gmane.linux.debian.devel.tetex |
|---|---|
| Message-ID | <[email protected]> |
--R5azhanZMPOc/q6I Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Package: texlive-luatex Version: 2026.20260711-2 Severity: minor 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. -.- * 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=0 -ww -z < "man page" [Use grep -n -e ' $' -e '\\~$' -e ' \\f.$' -e ' \\"' -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 ": troff:<stdin>:36: warning: register 'an-margin' not defined [-w reg] * 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.1.3+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 texlive-luatex depends on: ii lmodern 2.005-2 ii tex-common 6.20 ii texlive-base 2026.20260711-2 ii texlive-binaries 2026.20260303.78225+ds-4 texlive-luatex recommends no packages. texlive-luatex suggests no packages. Versions of packages tex-common depends on: ii bzip2 1.0.8-6+b2 ii ucf 3.0056 Versions of packages tex-common suggests: ii debhelper 14.3 Versions of packages texlive-luatex is related to: ii tex-common 6.20 ii texlive-binaries 2026.20260303.78225+ds-4 -- no debconf information --R5azhanZMPOc/q6I Content-Type: text/plain; charset=us-ascii Content-Disposition: attachment; filename=chk_man.err.luaotfload-tool.1 Input file is luaotfload-tool.1 Output from "mandoc -T lint luaotfload-tool.1": (shortened list) 6 WARNING: skipping paragraph macro: sp after SH 2 WARNING: unknown font, skipping request: ft C -.-. Output from test-groff mandoc -Kutf8 -ww -z luaotfload-tool.1: (shortened list) 1 register 'an-margin' not defined [-w reg] -.-. Show if generated from reStructuredText or rd2 A patch to a generated man page is to show where the generator failed to make a "clean" man page rendering (that is without warnings) and sometimes to show a better format for it. Generated files create bigger and more difficult to read/check patches when the generator creats long lines, instead of shorter ones or by postprocesing its output in such a way. 1:.\" Man page generated from reStructuredText. 447:.\" Generated by docutils manpage writer. Latest version: docutils (Docutils 0.22.4, Python 3.13.14, on linux) -.-. Add a "\&" (or a comma (Oxford comma)) after an abbreviation or use English words (man-pages(7)). Abbreviation points should be marked as such and protected against being interpreted as an end of sentence, if they are not, and that independent of the current place on the line. 97:Suppress auto\-updates to the database (e.g. 139:i.e. \fB\-\-find=file:foo.otf\fP checks whether 382:commas, e.g. \fB\-\-diagnose=files,permissions\fP\&. -.-. 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" [List of affected lines removed.] 68:the \fILuaotfload\fP package. There are two general modes: \fBupdate\fP and 88:Include font files in \fB$PWD\fP\&. This option 90:rebuilt. Thus it is quite inefficient. 102:font index through gzip. Useful for debugging 139:i.e. \fB\-\-find=file:foo.otf\fP checks whether 171:the \fB\->\fP separator, e. g. 180:matches \fBvalue\fP\&. The \fBvalue\fP can contain 224:the \fB\->\fP separator, e. g. 262:building the database. Warning: this will 295:respectively. The next bisection step will 299:the current bisection session. Hint: Use 305:\fBstart\fP directive. This sets the pivot to the 309:fonts up to the pivot will be considered. If 321:or \fBbad\fP will have no effect anymore. \fBrun\fP 358:Run the diagnostic procedure \fICHECK\fP\&. Available 382:commas, e.g. \fB\-\-diagnose=files,permissions\fP\&. 386:Read the configuration from \fIFILE\fP\&. See 397:aliases file. This option is experimental and 439:(\fI\%https://github.com/lualatex/\fP). It is currently maintained by the LaTeX -.-. Split lines longer than 80 characters (fill completely an A4 sized page line on a terminal) into two or more lines. Appropriate break points are the end of a sentence and a subordinate clause; after punctuation marks. Line 44, length 86 .B \fBluaotfload\-tool\fP \-\-find=FONTNAME [ \-\-fuzzy ] [ \-\-info ] [ \-\-inspect ] -.-. Put a parenthetical sentence, phrase on a separate line, if not part of a code. See man-pages(7), item "semantic newline". luaotfload-tool.1:113:supported file extensions (otf, ttf, ttc). luaotfload-tool.1:149:file (requires \fB\-\-find\fP). luaotfload-tool.1:253:Show blacklisted files (not directories). luaotfload-tool.1:335:No verbose output (log level set to zero). -.-. Use a character "\(->" instead of plain "->" or "\->", if not typeset with a constant width font. 171:the \fB\->\fP separator, e. g. 172:\fBfile\->location\fP, \fBstyle\->units_per_em\fP, 174:\fBnames\->sanitized\->english\->prefmodifiers\fP\&. 176:containing \fB\->\fP be properly quoted! 192:\&./luaotfload\-tool.lua \-\-list="format" \-\-fields="file\->base,version" 224:the \fB\->\fP separator, e. g. 225:\fBfile\->location\fP, \fBstyle\->units_per_em\fP, 226:or \fBnames\->sanitized\->english\->subfamily\fP\&. 241:\fBpurge\fP \-> delete Lua files from cache; 243:\fBerase\fP \-> delete Lua and Luc files from 246:\fBshow\fP \-> print stats. 279:\fBrun\fP \-> Make \fBluaotfload\-tool\fP respect 286:\fBstart\fP \-> Start bisection: create a 290:\fBstop\fP \-> Terminate the current bisection 293:\fBgood\fP | \fBbad\fP \-> Mark the section 298:\fBstatus\fP \-> Print status information about 342:\fBstdout\fP \-> all output will be 345:\fBfile\fP \-> write to a file to the temporary 362:\fBfiles\fP \-> check \fILuaotfload\fP files for 365:\fBpermissions\fP \-> check permissions of 370:.B \fBenvironment\fP \-> print relevant 374:\fBrepository\fP \-> check the git repository 377:\fBindex\fP \-> check database, display -.-. Only one space character is after a possible end of sentence (after a punctuation, that can end a sentence). Start a new sentence on a new line. luaotfload-tool.1:68:the \fILuaotfload\fP package. There are two general modes: \fBupdate\fP and luaotfload-tool.1:88:Include font files in \fB$PWD\fP\&. This option luaotfload-tool.1:90:rebuilt. Thus it is quite inefficient. luaotfload-tool.1:102:font index through gzip. Useful for debugging luaotfload-tool.1:139:i.e. \fB\-\-find=file:foo.otf\fP checks whether luaotfload-tool.1:171:the \fB\->\fP separator, e. g. luaotfload-tool.1:180:matches \fBvalue\fP\&. The \fBvalue\fP can contain luaotfload-tool.1:224:the \fB\->\fP separator, e. g. luaotfload-tool.1:262:building the database. Warning: this will luaotfload-tool.1:295:respectively. The next bisection step will luaotfload-tool.1:299:the current bisection session. Hint: Use luaotfload-tool.1:305:\fBstart\fP directive. This sets the pivot to the luaotfload-tool.1:309:fonts up to the pivot will be considered. If luaotfload-tool.1:321:or \fBbad\fP will have no effect anymore. \fBrun\fP luaotfload-tool.1:358:Run the diagnostic procedure \fICHECK\fP\&. Available luaotfload-tool.1:382:commas, e.g. \fB\-\-diagnose=files,permissions\fP\&. luaotfload-tool.1:386:Read the configuration from \fIFILE\fP\&. See luaotfload-tool.1:397:aliases file. This option is experimental and luaotfload-tool.1:439:(\fI\%https://github.com/lualatex/\fP). It is currently maintained by the LaTeX -.-. Remove quotes when there is a printable but no space character between them and the quotes are not for emphasis (markup), for example as an argument to a macro. luaotfload-tool.1:30:.TH "LUAOTFLOAD-TOOL" 1 "2024-12-03" "3.29" "text processing" -.-. Output from "test-groff -mandoc -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=0 -ww -z ": troff:<stdin>:36: warning: register 'an-margin' not defined [-w reg] -.- The register 'an-margin' is an OUTDATED INTERNAL variable in groff's tmac file 'an.tmac'. Generally: Split (sometimes) lines after a punctuation mark; before a conjunction. Adjustment to both margins and hyphenation are unnecessary (and just waste resources) in nroff mode for man pages; add .if n \{\ . nh . nr HY 0 . ad l . ds AD l .\} -.- 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. There is thereby no change in the standard output. --R5azhanZMPOc/q6I Content-Type: text/plain; charset=us-ascii Content-Disposition: attachment; filename=general.bugs 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 ' \\"' -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) -.- --R5azhanZMPOc/q6I Content-Type: message/rfc822 Content-Disposition: attachment; filename=trailing.whitespace Subject: clean files of trailing whitespace 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 '[[:blank:]]$' less with command "/ $" mandoc -T lint default action --R5azhanZMPOc/q6I--