Re: [PATCH] Docs/sound: Update codec-to-codec documentation

[Bagas Sanjaya <bagasdotme@gmail.com>]

[-- Attachment #1: Type: text/plain, Size: 3571 bytes --]

On Thu, Oct 17, 2024 at 12:33:31AM -0700, anish kumar wrote:
> Updated documentation to provide more details
> for codec-to-codec connection.

What are these?

> +Audio Data Flow Paths
> +----------------------
> +
> +In a typical configuration, audio flow can be visualized as follows:
>  
>     ---------          ---------
>    |         |  dai   |         |
> @@ -12,104 +33,163 @@ will look as below:
>    |         |        |         |
>     ---------          ---------
>  
> -In case your system looks as below:
> -::
> +In more intricate setups, the system may not involve the CPU but
> +instead utilizes multiple codecs as shown below. For instance,
> +Codec-2 acts as a cellular modem, while Codec-3 connects to a
> +speaker. Audio data can be received by Codec-2 and transmitted to
> +Codec-3 without CPU intervention, demonstrating the ideal conditions
> +for establishing a codec-to-codec DAI connection.
>  
>                         ---------
>                        |         |
> -                        codec-2
> +                        codec-1 <---cellular modem
>                        |         |
>                        ---------
>                             |
> -                         dai-2
> -                           |
> +                         dai-1
> +                           ↓
>     ----------          ---------
> -  |          |  dai-1 |         |
> -      CPU     ------->  codec-1
> +  |          |cpu_dai |         |
> +   dummy CPU  ------->  codec-2
>    |          |        |         |
>     ----------          ---------
>                             |
>                           dai-3
> -                           |
> +                           ↓
>                         ---------
>                        |         |
> -                        codec-3
> +                        codec-3 ---->speaker
>                        |         |
>                         ---------
>  

Sphinx reports htmldocs build errors:

Documentation/sound/soc/codec-to-codec.rst:31: WARNING: Block quote ends without a blank line; unexpected unindent.
Documentation/sound/soc/codec-to-codec.rst:43: CRITICAL: Unexpected section title or transition.

---------

reST markup error:
Documentation/sound/soc/codec-to-codec.rst:43: (SEVERE/4) Unexpected section title or transition.

---------

I have to wrap audio data flow diagrams as literal code blocks:

---- >8 ----
diff --git a/Documentation/sound/soc/codec-to-codec.rst b/Documentation/sound/soc/codec-to-codec.rst
index d77de03cace6b8..23b7df0c89cf18 100644
--- a/Documentation/sound/soc/codec-to-codec.rst
+++ b/Documentation/sound/soc/codec-to-codec.rst
@@ -25,7 +25,7 @@ functionalities.
 Audio Data Flow Paths
 ----------------------
 
-In a typical configuration, audio flow can be visualized as follows:
+In a typical configuration, audio flow can be visualized as follows::
 
    ---------          ---------
   |         |  dai   |         |
@@ -38,7 +38,7 @@ instead utilizes multiple codecs as shown below. For instance,
 Codec-2 acts as a cellular modem, while Codec-3 connects to a
 speaker. Audio data can be received by Codec-2 and transmitted to
 Codec-3 without CPU intervention, demonstrating the ideal conditions
-for establishing a codec-to-codec DAI connection.
+for establishing a codec-to-codec DAI connection::
 
                        ---------
                       |         |

Thanks.

-- 
An old man doll... just what I always wanted! - Clara

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]