[PATCH] Documentation: sound: fix TAS675x doc build warnings

Randy Dunlap posted 1 patch 1 month, 2 weeks ago
Documentation/sound/codecs/index.rst   |    1 +
Documentation/sound/codecs/tas675x.rst |    2 +-
2 files changed, 2 insertions(+), 1 deletion(-)
[PATCH] Documentation: sound: fix TAS675x doc build warnings
Posted by Randy Dunlap 1 month, 2 weeks ago
Add tas675x.rst to the index file and extend the heading underline
to avoid build warnings:

Documentation/sound/codecs/tas675x.rst: WARNING: document isn't included in any toctree [toc.not_included]
Documentation/sound/codecs/tas675x.rst:659: WARNING: Title underline too short.
Overtemperature Shutdown (0x87)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ [docutils]

Fixes: ba46edca354e ("Documentation: sound: Add TAS675x codec mixer controls documentation")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Sen Wang <sen@ti.com>
Cc: Mark Brown <broonie@kernel.org>
Cc: Liam Girdwood <lgirdwood@gmail.com>
Cc: Jaroslav Kysela <perex@perex.cz>
Cc: Takashi Iwai <tiwai@suse.com>
Cc: linux-sound@vger.kernel.org

 Documentation/sound/codecs/index.rst   |    1 +
 Documentation/sound/codecs/tas675x.rst |    2 +-
 2 files changed, 2 insertions(+), 1 deletion(-)

--- linux-next-20260429.orig/Documentation/sound/codecs/index.rst
+++ linux-next-20260429/Documentation/sound/codecs/index.rst
@@ -7,3 +7,4 @@ Codec-Specific Information
    :maxdepth: 2
 
    cs35l56
+   tas675x
--- linux-next-20260429.orig/Documentation/sound/codecs/tas675x.rst
+++ linux-next-20260429/Documentation/sound/codecs/tas675x.rst
@@ -656,7 +656,7 @@ These faults place affected channels int
 issues fault clear (register 0x01 bit 3) to allow recovery.
 
 Overtemperature Shutdown (0x87)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
   ========  ==========================================
   Bits      Description
Re: [PATCH] Documentation: sound: fix TAS675x doc build warnings
Posted by Wang, Sen 1 month, 2 weeks ago
On 4/29/2026 5:57 PM, Randy Dunlap wrote:
> Add tas675x.rst to the index file and extend the heading underline
> to avoid build warnings:
> 
> Documentation/sound/codecs/tas675x.rst: WARNING: document isn't included in any toctree [toc.not_included]
> Documentation/sound/codecs/tas675x.rst:659: WARNING: Title underline too short.
> Overtemperature Shutdown (0x87)
> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ [docutils]
> 
> Fixes: ba46edca354e ("Documentation: sound: Add TAS675x codec mixer controls documentation")
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>

Thanks for catching and fixing this Randy, really appreciate the patch!

(Already merged so no need to but...)
Acked-by: Sen Wang <sen@ti.com>

Best,
Sen Wang

> ---
> Cc: Sen Wang <sen@ti.com>
> Cc: Mark Brown <broonie@kernel.org>
> Cc: Liam Girdwood <lgirdwood@gmail.com>
> Cc: Jaroslav Kysela <perex@perex.cz>
> Cc: Takashi Iwai <tiwai@suse.com>
> Cc: linux-sound@vger.kernel.org
> 
>   Documentation/sound/codecs/index.rst   |    1 +
>   Documentation/sound/codecs/tas675x.rst |    2 +-
>   2 files changed, 2 insertions(+), 1 deletion(-)
> 
> --- linux-next-20260429.orig/Documentation/sound/codecs/index.rst
> +++ linux-next-20260429/Documentation/sound/codecs/index.rst
> @@ -7,3 +7,4 @@ Codec-Specific Information
>      :maxdepth: 2
>   
>      cs35l56
> +   tas675x
> --- linux-next-20260429.orig/Documentation/sound/codecs/tas675x.rst
> +++ linux-next-20260429/Documentation/sound/codecs/tas675x.rst
> @@ -656,7 +656,7 @@ These faults place affected channels int
>   issues fault clear (register 0x01 bit 3) to allow recovery.
>   
>   Overtemperature Shutdown (0x87)
> -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>   
>     ========  ==========================================
>     Bits      Description
Re: [PATCH] Documentation: sound: fix TAS675x doc build warnings
Posted by Mark Brown 1 month, 2 weeks ago
On Wed, 29 Apr 2026 15:57:51 -0700, Randy Dunlap wrote:
> Documentation: sound: fix TAS675x doc build warnings

Applied to

   https://git.kernel.org/pub/scm/linux/kernel/git/broonie/sound.git for-7.2

Thanks!

[1/1] Documentation: sound: fix TAS675x doc build warnings
      https://git.kernel.org/broonie/sound/c/e82c19d6a508

All being well this means that it will be integrated into the linux-next
tree (usually sometime in the next 24 hours) and sent to Linus during
the next merge window (or sooner if it is a bug fix), however if
problems are discovered then the patch may be dropped or reverted.

You may get further e-mails resulting from automated or manual testing
and review of the tree, please engage with people reporting problems and
send followup patches addressing any issues that are reported if needed.

If any updates are required or you are submitting further changes they
should be sent as incremental updates against current git, existing
patches will not be replaced.

Please add any relevant lists and maintainers to the CCs when replying
to this mail.

Thanks,
Mark