Linux Sound subsystem development
 help / color / mirror / Atom feed
* [PATCH] Documentation: sound: fix TAS675x doc build warnings
@ 2026-04-29 22:57 Randy Dunlap
  2026-04-30  6:05 ` Mark Brown
  2026-05-01 19:09 ` Wang, Sen
  0 siblings, 2 replies; 3+ messages in thread
From: Randy Dunlap @ 2026-04-29 22:57 UTC (permalink / raw)
  To: linux-kernel
  Cc: Randy Dunlap, Sen Wang, Mark Brown, Liam Girdwood,
	Jaroslav Kysela, Takashi Iwai, linux-sound

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

^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCH] Documentation: sound: fix TAS675x doc build warnings
  2026-04-29 22:57 [PATCH] Documentation: sound: fix TAS675x doc build warnings Randy Dunlap
@ 2026-04-30  6:05 ` Mark Brown
  2026-05-01 19:09 ` Wang, Sen
  1 sibling, 0 replies; 3+ messages in thread
From: Mark Brown @ 2026-04-30  6:05 UTC (permalink / raw)
  To: linux-kernel, Randy Dunlap
  Cc: Sen Wang, Liam Girdwood, Jaroslav Kysela, Takashi Iwai,
	linux-sound

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


^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCH] Documentation: sound: fix TAS675x doc build warnings
  2026-04-29 22:57 [PATCH] Documentation: sound: fix TAS675x doc build warnings Randy Dunlap
  2026-04-30  6:05 ` Mark Brown
@ 2026-05-01 19:09 ` Wang, Sen
  1 sibling, 0 replies; 3+ messages in thread
From: Wang, Sen @ 2026-05-01 19:09 UTC (permalink / raw)
  To: Randy Dunlap, linux-kernel
  Cc: Mark Brown, Liam Girdwood, Jaroslav Kysela, Takashi Iwai,
	linux-sound

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


^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2026-05-01 19:09 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-04-29 22:57 [PATCH] Documentation: sound: fix TAS675x doc build warnings Randy Dunlap
2026-04-30  6:05 ` Mark Brown
2026-05-01 19:09 ` Wang, Sen

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox