Skip to contentSkip to conversation

Documentation: sound: fix TAS675x doc build warnings

PATCH In review Randy Dunlap 3 participants 3 messages Apr 29 – May 1

Subsystems (3)
lore
Share & tools
lore

Randy Dunlap

author reviewer
#0 lore raw

PATCH 1/1 Documentation: sound: fix TAS675x doc build warnings

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")

---
Cc: Sen Wang <[email protected]>
Cc: Mark Brown <[email protected]>
Cc: Liam Girdwood <[email protected]>
Cc: Jaroslav Kysela <[email protected]>
Cc: Takashi Iwai <[email protected]>
Cc: [email protected]

 Documentation/sound/codecs/index.rst   |    1 +
 Documentation/sound/codecs/tas675x.rst |    2 +-
 2 files changed, 2 insertions(+), 1 deletion(-)
Documentation/sound/codecs/index.rst +1 -0
@@ -7,3 +7,4 @@ Codec-Specific Information
    :maxdepth: 2
 
    cs35l56
+   tas675x
Documentation/sound/codecs/tas675x.rst +1 -1
@@ -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
#1 lore raw
Quoted 1 line · Randy Dunlap

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

maintainer Acked-by on v1 1/1
#2 lore raw
In reply to Randy Dunlap
Quoted 10 lines · Randy Dunlap

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")

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

(Already merged so no need to but...)

Best,
Sen Wang

Quoted 30 lines

---
Cc: Sen Wang <[email protected]>
Cc: Mark Brown <[email protected]>
Cc: Liam Girdwood <[email protected]>
Cc: Jaroslav Kysela <[email protected]>
Cc: Takashi Iwai <[email protected]>
Cc: [email protected]

  Documentation/sound/codecs/index.rst   |    1 +
  Documentation/sound/codecs/tas675x.rst |    2 +-
  2 files changed, 2 insertions(+), 1 deletion(-)
Documentation/sound/codecs/index.rst +1 -0
@@ -7,3 +7,4 @@ Codec-Specific Information
     :maxdepth: 2
 
     cs35l56
+   tas675x
Documentation/sound/codecs/tas675x.rst +1 -1
@@ -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