kernel.git/Documentation/sound/index.rst, branch master

Documentation: use a source-read extension for the index link boilerplate

2026-01-23T18:59:34Z

The root document usually has a special :ref:`genindex` link to the generated index. This is also the case for Documentation/index.rst. The other index.rst files deeper in the directory hierarchy usually don't. For SPHINXDIRS builds, the root document isn't Documentation/index.rst, but some other index.rst in the hierarchy. Currently they have a ".. only::" block to add the index link when doing SPHINXDIRS html builds. This is obviously very tedious and repetitive. The link is also added to all index.rst files in the hierarchy for SPHINXDIRS builds, not just the root document. Put the boilerplate in a sphinx-includes/subproject-index.rst file, and include it at the end of the root document for subproject builds in an ad-hoc source-read extension defined in conf.py. For now, keep having the boilerplate in translations, because this approach currently doesn't cover translated index link headers. Cc: Jonathan Corbet Cc: Mauro Carvalho Chehab Cc: Randy Dunlap Signed-off-by: Jani Nikula Tested-by: Mauro Carvalho Chehab Reviewed-by: Mauro Carvalho Chehab [jc: did s/doctree/kern_doc_dir/ ] Signed-off-by: Jonathan Corbet Message-ID: <20260123143149.2024303-1-jani.nikula@intel.com>

ALSA: doc: Add codecs/index.rst to top-level index

2025-01-09T11:15:56Z

commit 088fb4ee17fc ("ALSA: doc: cs35l56: Add information about Cirrus Logic CS35L54/56/57") added a new subdirectory with an index file, so this file must be added to the top-level index. Fixes: 088fb4ee17fc ("ALSA: doc: cs35l56: Add information about Cirrus Logic CS35L54/56/57") Signed-off-by: Richard Fitzgerald Link: https://patch.msgid.link/20250109105657.96860-1-rf@opensource.cirrus.com Signed-off-by: Mark Brown

Docs/sound: Add documentation for userspace-driven ALSA timers

2024-08-18T07:55:54Z

Add the documentation which describes the new userspace-driven timers API introduced in this patch series. The documentation contains: - Description of userspace-driven ALSA timers, what they are for - Description of the timers API - Example of how the timers can be created and triggered - How the timers can be used as a timer sources for snd-aloop module Suggested-by: Axel Holzinger Signed-off-by: Ivan Orlov Signed-off-by: Takashi Iwai Link: https://patch.msgid.link/20240813120701.171743-3-ivan.orlov0322@gmail.com

Docs/sound/index: Add missing SPDX License Identifier

2023-01-24T22:28:52Z

Add missing SPDX License Identifier for sound documentation index file. Signed-off-by: SeongJae Park Acked-by: Takashi Iwai Link: https://lore.kernel.org/r/20230122213650.187710-9-sj@kernel.org Signed-off-by: Jonathan Corbet

Docs/subsystem-apis: Remove '[The ]Linux' prefixes from titles of listed documents

2023-01-24T22:27:08Z

Some documents that listed on subsystem-apis have 'Linux' or 'The Linux' title prefixes. It's duplicated information, and makes finding the document of interest with human eyes not easy. Remove the prefixes from the titles. Signed-off-by: SeongJae Park Acked-by: Iwona Winiarska Acked-by: Bjorn Helgaas Link: https://lore.kernel.org/r/20230122184834.181977-1-sj@kernel.org Signed-off-by: Jonathan Corbet

docs: index.rst: don't use genindex for pdf output

2019-07-31T19:31:16Z

The genindex logic is meant to be used only for html output, as pdf build has its own way to generate indexes. Signed-off-by: Mauro Carvalho Chehab Acked-by: Vinod Koul # dmaengine and soundwire Signed-off-by: Jonathan Corbet

ASoC: doc: ReSTize overview.txt

2016-11-11T16:32:48Z

A simple conversion from a plain text file. Created a new subdirectory, Documentation/sound/soc, for this and other ASoC documents. Since the index page contains the TOC, so "Documentation" section got removed from overview. Acked-by: Mark Brown Signed-off-by: Takashi Iwai

ALSA: doc: ReSTize Joystick document

2016-11-10T17:10:03Z

A conversion from a simple text file. A new subdirectory, cards, was created to contain the card-specific information like this one. Signed-off-by: Takashi Iwai

ALSA: doc: ReSTize Procfile document

2016-11-10T17:09:21Z

A simple conversion from a text file. A new subidrectory, Documentation/sound/designs, was created to put this document. The other API design and implementation docuemnts will be put to that directory in later commits. Signed-off-by: Takashi Iwai

ALSA: doc: ReSTize ALSA-Configuration document

2016-11-10T17:08:44Z

A simple conversion from the text file. Since this is the only document specific to the configurations, it's put to the root sound subdirectory. A section describing the obsoleted configure stuff of old alsa-driver tarball got removed. Signed-off-by: Takashi Iwai