| Summary: | groff warning when processing squeue(1) man page | ||
|---|---|---|---|
| Product: | Slurm | Reporter: | Gennaro Oliva <gennaro.oliva> |
| Component: | Documentation | Assignee: | Ben Roberts <bproberts> |
| Status: | OPEN --- | QA Contact: | |
| Severity: | C - Contributions | ||
| Priority: | --- | ||
| Version: | 26.05.1 | ||
| Hardware: | Linux | ||
| OS: | Linux | ||
| Site: | -Other- | Slinky Site: | --- |
| Alineos Sites: | --- | Atos/Eviden Sites: | --- |
| Confidential Site: | --- | Coreweave sites: | --- |
| Cray Sites: | --- | DS9 clusters: | --- |
| Google sites: | --- | HPCnow Sites: | --- |
| HPE Sites: | --- | IBM Sites: | --- |
| NOAA SIte: | --- | NoveTech Sites: | --- |
| Nvidia HWinf-CS Sites: | --- | OCF Sites: | --- |
| Recursion Pharma Sites: | --- | SFW Sites: | --- |
| SNIC sites: | --- | Tzag Elita Sites: | --- |
| Linux Distro: | --- | Machine Name: | |
| CLE Version: | Version Fixed: | ||
| Target Release: | --- | DevPrio: | --- |
| Emory-Cloud Sites: | --- | ||
| Attachments: | Patch to fix invalid roff markup in squeue(1) man page | ||
Hi Gennaro, Thanks for pointing this out. We will look at correcting this in the docs. Thanks, Ben |
Created attachment 45817 [details] Patch to fix invalid roff markup in squeue(1) man page The lintian tool used to check the Debian package reports the following warning: W: slurm-client: groff-message an.tmac:<standard input>:761: warning: cannot nest .TP or .TQ inside .TP; supply a tag [usr/share/man/man1/squeue.1.gz:1] The warning is caused by a stray .TP macro before a .RE directive in the Exclusive field description of the squeue(1) man page: .TP \fBUSER\fR: only one user's jobs may share a node ... .TP .RE The empty .TP directive leaves an incomplete tagged paragraph, which recent versions of groff report as invalid roff markup. The attached patch removes the unnecessary .TP directive before .RE. This fixes the invalid markup and allows the man page to be processed cleanly by groff and lintian.