Subject: alsatplg.1: Some remarks and a patch with editorial changes for this man page

From: Bjarni Ingi Gislason <[email-masked]>
Date: Sat, 1 Mar 2025 14:17:39 +0000

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
--- 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 <[email-masked]>