Package: alsa-utils
Version: 1.2.13-1
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 ' $' -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>:30: style: .TH missing fourth argument; consider package/project name and version (e.g., "groff 1.23.0")
an.tmac:<stdin>:108: style: 1 leading space(s) on input line
troff:<stdin>:108: warning: trailing space in the line
troff:<stdin>:112: 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.12-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 alsa-utils depends on:
ii kmod 33+20240816-2
ii libasound2t64 1.2.13-1+b1
ii libatopology2t64 1.2.13-1+b1
ii libc6 2.40-7
ii libfftw3-single3 3.3.10-2+b1
ii libncursesw6 6.5+20250216-1
ii libsamplerate0 0.2.2-4+b2
ii libtinfo6 6.5+20250216-1
alsa-utils recommends no packages.
Versions of packages alsa-utils suggests:
pn dialog <none>
-- no debconf information
Input file is alsatplg.1
Output from "mandoc -T lint alsatplg.1": (shortened list)
1 input text line longer than 80 bytes: Topology Interface: ...
5 skipping paragraph macro: sp after SH
2 whitespace at end of input line
Remove trailing space with: sed -e 's/ *$//'
-.-.
Output from "test-groff -mandoc -t -ww -z alsatplg.1": (shortened list)
2 trailing space in the line
Remove trailing space with: sed -e 's/ *$//'
-.-.
Show if generated from reStructuredText
Who is actually generating this man page? Debian or upstream?
Is the generating software out of date?
1:.\" Man page generated from reStructuredText.
-.-.
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
2
-.-.
Remove space in the first column, if not indented.
Use ".in +<number>n" and ".in" to end it; ".nf" and ".fi" to end
it, for an extra indention.
alsatplg.1:108: <http://git.alsa\-project.org/?p=alsa\-lib.git;a=blob;f=src/topology/parser.c>
-.-.
Strings longer than 3/4 of a standard line length (80)
Use "\:" to split the string at the end of an output line, for example a
long URL (web address)
108 <http://git.alsa\-project.org/?p=alsa\-lib.git;a=blob;f=src/topology/parser.c>
112 Topology Interface: <http://www.alsa\-project.org/alsa\-doc/alsa\-lib/group__topology.html>
-.-.
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 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.
N.B.
The number of lines affected can be too large to be in a patch.
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"
44:a driver to work on a different devices. The driver is also
53:from the file system. Firmware updates can be pushed without
54:having to update the drivers. The new firmware just needs
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
alsatplg.1:38:alsatplg (ALSA Topology compiler) is a program to compile topology
alsatplg.1:88:sort the configuration identifiers (set for normalization)
alsatplg.1:94:do not sort DAPM graph items (like in version 1.2.1\-)
-.-.
No need for '\&' to be in front of a period (.),
if there is a character in front of it.
Remove with "sed -e 's/\\&\././g'".
101:\fB/usr/share/alsa/topology\fP\&.
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z ":
an.tmac:<stdin>:30: style: .TH missing fourth argument; consider package/project name and version (e.g., "groff 1.23.0")
an.tmac:<stdin>:108: style: 1 leading space(s) on input line
troff:<stdin>:108: warning: trailing space in the line
troff:<stdin>:112: warning: trailing space in the line
-.-.
Generally:
Split (sometimes) lines after a punctuation mark; before a conjunction.
--- alsatplg.1 2025-03-01 12:35:10.985000507 +0000
+++ alsatplg.1.new 2025-03-01 14:06:41.961075582 +0000
@@ -31,17 +31,20 @@ level margin: \\n[rst2man-indent\\n[rst2
.SH NAME
alsatplg \- ALSA Topology Compiler
.SH SYNOPSIS
-.sp
-\fIalsatplg\fP <options> [command]
+.BI alsatplg " <options>"
+.RI [ command ]
.SH DESCRIPTION
-.sp
-alsatplg (ALSA Topology compiler) is a program to compile topology
+alsatplg
+(ALSA Topology compiler)
+is a program to compile topology
configuration file to the binary file for the kernel drivers.
.sp
Current audio drivers typically hard code topology information
-in the driver sources: This tightly couples the audio driver
+in the driver sources:
+This tightly couples the audio driver
to the development board making it time consuming to modify
-a driver to work on a different devices. The driver is also
+a driver to work on a different devices.
+The driver is also
tightly coupled to the DSP firmware version meaning extra care
is needed to keep the driver and firmware version in sync.
New firmware features also mean driver updates.
@@ -50,11 +53,12 @@ The ALSA topology project removes the ne
porting audio drivers to different devices or different firmwares:
Drivers have no hard coded topology data meaning a single driver
can be used on different devices by updating the topology data
-from the file system. Firmware updates can be pushed without
-having to update the drivers. The new firmware just needs
+from the file system.
+Firmware updates can be pushed without
+having to update the drivers.
+The new firmware just needs
to include an updated topology file describing the update.
.SH OPTIONS
-.sp
Available options:
.INDENT 0.0
.INDENT 3.5
@@ -85,34 +89,38 @@ output file
set verbose level
.TP
.B \fB\-s\fP, \fB\-\-sort\fP
-sort the configuration identifiers (set for normalization)
+sort the configuration identifiers
+(set for normalization)
.TP
.B \fB\-x\fP, \fB\-\-nocheck\fP
save the configuration without additional integrity check
.TP
.B \fB\-z\fP, \fB\-\-dapm\-nosort\fP
-do not sort DAPM graph items (like in version 1.2.1\-)
+do not sort DAPM graph items
+(like in version 1.2.1\-)
.UNINDENT
.UNINDENT
.UNINDENT
.SH FILES
-.sp
The master topology files for each supported sound card are in
-\fB/usr/share/alsa/topology\fP\&.
-.sp
-For example, the master use case file for the \fIbroadwell\fP card is in
-\fB/usr/share/alsa/topology/broadwell/broadwell.conf\fP, this file
-describes the audio hardware for the driver.
+\fB/usr/share/alsa/topology\fP.
.sp
-For more details on the syntax of UCM files, see the alsa\-lib source code:
- <http://git.alsa\-project.org/?p=alsa\-lib.git;a=blob;f=src/topology/parser.c>
+For example,
+the master use case file for the \fIbroadwell\fP card is in
+\fB/usr/share/alsa/topology/broadwell/broadwell.conf\fP,
+this file describes the audio hardware for the driver.
+.sp
+For more details on the syntax of UCM files,
+see the alsa\-lib source code:
+<http://git.alsa\-project.org/?p=alsa\-lib.git;a=blob;f=src/\:topology/\:parser.c>
.SH SEE ALSO
.INDENT 0.0
.IP \(bu 2
-Topology Interface: <http://www.alsa\-project.org/alsa\-doc/alsa\-lib/group__topology.html>
+Topology Interface:
+.br
+<http://www.alsa\-project.org/\:alsa\-doc/\:alsa\-lib/\:group__topology.html>
.UNINDENT
.SH BUGS
-.sp
None known.
.SH AUTHOR
Jaroslav Kysela <perex@xxxxxxxx>
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
-.-
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.
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)
-.-
