diff mbox series

[1/2] ALSA: docs: compress-accel: Format state machine flowchart as code block

Message ID 20241028111647.17378-2-bagasdotme@gmail.com (mailing list archive)
State New
Headers show
Series Documentation fixes for ALSA Co-processor Acceleration API | expand

Commit Message

Bagas Sanjaya Oct. 28, 2024, 11:16 a.m. UTC 
Stephen Rothwell reports multiple htmldocs indentation warnings when
merging sound tree for linux-next:

Documentation/sound/designs/compress-accel.rst:67: ERROR: Unexpected indentation.
Documentation/sound/designs/compress-accel.rst:67: WARNING: Blank line required after table.
Documentation/sound/designs/compress-accel.rst:68: WARNING: Line block ends without a blank line.
Documentation/sound/designs/compress-accel.rst:72: WARNING: Block quote ends without a blank line; unexpected unindent.
Documentation/sound/designs/compress-accel.rst:73: WARNING: Block quote ends without a blank line; unexpected unindent.

Fix these above by wrapping passthrough audio stream state machine
flowchart in a literal code block.

Fixes: 04177158cf98 ("ALSA: compress_offload: introduce accel operation mode")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Closes: https://lore.kernel.org/linux-next/20241028193242.11597640@canb.auug.org.au/
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/sound/designs/compress-accel.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
diff mbox series

Patch

diff --git a/Documentation/sound/designs/compress-accel.rst b/Documentation/sound/designs/compress-accel.rst
index abf1f76a87785c..c9c1744b94c2c0 100644
--- a/Documentation/sound/designs/compress-accel.rst
+++ b/Documentation/sound/designs/compress-accel.rst
@@ -57,7 +57,7 @@  from the input buffer size).
 State Machine
 =============
 
-The passthrough audio stream state machine is described below :
+The passthrough audio stream state machine is described below::
 
                                        +----------+
                                        |          |