From f42eb4930923af90784339c313654c45b24c1d8f Mon Sep 17 00:00:00 2001 From: Bagas Sanjaya Date: Mon, 28 Oct 2024 18:16:46 +0700 Subject: [PATCH 1/2] ALSA: docs: compress-accel: Format state machine flowchart as code block 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 Closes: https://lore.kernel.org/linux-next/20241028193242.11597640@canb.auug.org.au/ Signed-off-by: Bagas Sanjaya Link: https://patch.msgid.link/20241028111647.17378-2-bagasdotme@gmail.com Signed-off-by: Takashi Iwai --- Documentation/sound/designs/compress-accel.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/sound/designs/compress-accel.rst b/Documentation/sound/designs/compress-accel.rst index abf1f76a8778..c9c1744b94c2 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:: +----------+ | | From 9a0f6091060882881f2cefd1efbda658f207ee5c Mon Sep 17 00:00:00 2001 From: Bagas Sanjaya Date: Mon, 28 Oct 2024 18:16:47 +0700 Subject: [PATCH 2/2] ALSA: docs: Add toctree index entry for co-processor acceleration API Sphinx reports missing toctree entry warning for co-processor acceleration API docs: Documentation/sound/designs/compress-accel.rst: WARNING: document isn't included in any toctree Add the missing entry to fix the warning. Fixes: 04177158cf98 ("ALSA: compress_offload: introduce accel operation mode") Signed-off-by: Bagas Sanjaya Link: https://patch.msgid.link/20241028111647.17378-3-bagasdotme@gmail.com Signed-off-by: Takashi Iwai --- Documentation/sound/designs/index.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/Documentation/sound/designs/index.rst b/Documentation/sound/designs/index.rst index b79db9ad8732..6b825c5617fc 100644 --- a/Documentation/sound/designs/index.rst +++ b/Documentation/sound/designs/index.rst @@ -6,6 +6,7 @@ Designs and Implementations control-names channel-mapping-api + compress-accel compress-offload timestamping jack-controls