[PATCH 0/2] Documentation fixes for ALSA Co-processor Acceleration API

[PATCH 0/2] Documentation fixes for ALSA Co-processor Acceleration API

[Bagas Sanjaya]

A small (two-patches) series fixing htmldocs warnings on sound tree that
first being noticed in linux-next integration [1].

[1]: https://lore.kernel.org/linux-next/20241028193242.11597640@canb.auug.org.au/

Bagas Sanjaya (2):
  ALSA: docs: compress-accel: Format state machine flowchart as code
    block
  ALSA: docs: Add toctree index entry for co-processor acceleration API

 Documentation/sound/designs/compress-accel.rst | 2 +-
 Documentation/sound/designs/index.rst          | 1 +
 2 files changed, 2 insertions(+), 1 deletion(-)


base-commit: 0216ded72db896b24cbdd8cd6531482571b25cf6
-- 
An old man doll... just what I always wanted! - Clara

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

[Bagas Sanjaya]

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 --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::
 
                                        +----------+
                                        |          |
-- 
An old man doll... just what I always wanted! - Clara

[PATCH 2/2] ALSA: docs: Add toctree index entry for co-processor acceleration API

[Bagas Sanjaya]

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 <bagasdotme@gmail.com>
---
 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 b79db9ad87325a..6b825c5617fc16 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
-- 
An old man doll... just what I always wanted! - Clara

Re: [PATCH 0/2] Documentation fixes for ALSA Co-processor Acceleration API

[Takashi Iwai]

On Mon, 28 Oct 2024 12:16:45 +0100,
Bagas Sanjaya wrote:
> 
> A small (two-patches) series fixing htmldocs warnings on sound tree that
> first being noticed in linux-next integration [1].
> 
> [1]: https://lore.kernel.org/linux-next/20241028193242.11597640@canb.auug.org.au/
> 
> Bagas Sanjaya (2):
>   ALSA: docs: compress-accel: Format state machine flowchart as code
>     block
>   ALSA: docs: Add toctree index entry for co-processor acceleration API

Applied both patches now.  Thanks.


Takashi