Re: [PATCH v19 41/41] ASoC: doc: Add documentation for SOC USB

[Wesley Cheng]

Hi Bagas,

On 4/22/2024 6:43 PM, Bagas Sanjaya wrote:
> On Mon, Apr 22, 2024 at 03:49:06PM -0700, Wesley Cheng wrote:
> > +.. code-block:: rst
> > +
> > +int snd_soc_usb_setup_offload_jack(struct snd_soc_component *component,
> > +					struct snd_soc_jack *jack)
> > +..
>
> You forget to indent snd_soc_usb_setup_offload_jack() prototype:
>
> ---- >8 ----
> diff --git a/Documentation/sound/soc/usb.rst b/Documentation/sound/soc/usb.rst
> index 3f7c3ef6a0c03c..0b6da0be9f317f 100644
> --- a/Documentation/sound/soc/usb.rst
> +++ b/Documentation/sound/soc/usb.rst
> @@ -218,8 +218,8 @@ state.
>   
>   .. code-block:: rst
>   
> -int snd_soc_usb_setup_offload_jack(struct snd_soc_component *component,
> -					struct snd_soc_jack *jack)
> +        int snd_soc_usb_setup_offload_jack(struct snd_soc_component *component,
> +        					struct snd_soc_jack *jack)
>   ..
>   
>     - ``component``: ASoC component to add the jack
>
> > +USB Offload Playback Route Select Kcontrol
> > +-----------------------------------
>
> USB offload playback heading underlines are not long enough to cover heading
> titles, so I have to extend them:
>
> ---- >8 ----
> diff --git a/Documentation/sound/soc/usb.rst b/Documentation/sound/soc/usb.rst
> index 0b6da0be9f317f..5e0e9fad131b24 100644
> --- a/Documentation/sound/soc/usb.rst
> +++ b/Documentation/sound/soc/usb.rst
> @@ -482,7 +482,7 @@ into the physical USB port and enumerated.  The kcontrols are defined as:
>       kcontrol exposed by the platform card.
>   
>   USB Offload Playback Route Select Kcontrol
> ------------------------------------
> +------------------------------------------
>   In order to allow for vendor specific implementations on audio offloading device
>   selection, the SOC USB layer exposes the following:
>   
> @@ -545,7 +545,7 @@ along to the external DSP.
>   
>   
>   USB Offload Playback Route Status
> --------------------
> +---------------------------------
>   SOC USB exposes APIs for keeping track of the offloading state, and expects this
>   to be maintained by the BE DAI link that created/added the SOC USB device.
>   
> @@ -573,7 +573,7 @@ When executing the kcontrol get callback, it will loop across the active_list ar
>   and report to the application for active USB sound card and USB PCM device indexes.
>   
>   USB Offload Playback Capable Card
> --------------------------------
> +---------------------------------
>   USB sound also creates a kcontrol for applications to help determine which platform
>   sound card USB offloading is linked to.  This will allow applications to further
>   query the platform sound card for specific information about the current USB offload
>
> Thanks.

Thanks for the review.  Will fix these all in the next revision.

Thanks
Wesley Cheng