Re: [PATCH] ALSA: machine: update documentation

[anish kumar <yesanishhere@xxxxxxxxx>]

Mark,

Do you have any comments, or should I
go ahead and respin the patch to address
the review comments?

On Sat, Nov 2, 2024 at 9:30 PM Bagas Sanjaya <bagasdotme@xxxxxxxxx> wrote:
>
> On Sat, Nov 02, 2024 at 12:37:18AM -0700, anish kumar wrote:
> > +Additionaly below example macro can be used to register cpu, codec and
> > +platform dai.
> > +
> > +SND_SOC_DAILINK_DEFS(wm2200_cpu_dsp,
> > +     DAILINK_COMP_ARRAY(COMP_CPU("samsung-i2s.0")),
> > +     DAILINK_COMP_ARRAY(COMP_CODEC("spi0.0", "wm0010-sdi1")),
> > +     DAILINK_COMP_ARRAY(COMP_PLATFORM("samsung-i2s.0")));
> > +
>
> Make the macro usage a literal code block:
>
> ---- >8 ----
> diff --git a/Documentation/sound/soc/machine.rst b/Documentation/sound/soc/machine.rst
> index af7bad7ba13455..8788953cd160f5 100644
> --- a/Documentation/sound/soc/machine.rst
> +++ b/Documentation/sound/soc/machine.rst
> @@ -76,9 +76,9 @@ either dai name or device tree node but not both. Also, names used here
>  for cpu/codec/platform dais should be globally unique.
>
>  Additionaly below example macro can be used to register cpu, codec and
> -platform dai.
> +platform dai::
>
> -SND_SOC_DAILINK_DEFS(wm2200_cpu_dsp,
> +  SND_SOC_DAILINK_DEFS(wm2200_cpu_dsp,
>         DAILINK_COMP_ARRAY(COMP_CPU("samsung-i2s.0")),
>         DAILINK_COMP_ARRAY(COMP_CODEC("spi0.0", "wm0010-sdi1")),
>         DAILINK_COMP_ARRAY(COMP_PLATFORM("samsung-i2s.0")));
>
> >  Machine Power Map
> > ------------------
> > +---------------------------
>
> Keep the section underline length as-is.
>
> >  Machine Controls
> > -----------------
> > +-----------------------
>
> Likewise.
>
> > +Clocking Controls:
> > +—-----------------
> > +
>
> Fix the underline to render the section name as a heading:
>
> ---- >8 ----
> diff --git a/Documentation/sound/soc/machine.rst b/Documentation/sound/soc/machine.rst
> index 8788953cd160f5..bdb9dfc5d88e45 100644
> --- a/Documentation/sound/soc/machine.rst
> +++ b/Documentation/sound/soc/machine.rst
> @@ -113,8 +113,8 @@ Machine Controls
>  Machine specific audio mixer controls can be added in the DAI init function.
>
>
> -Clocking Controls:
> -—-----------------
> +Clocking Controls
> +-----------------
>
>  As previously noted, clock configuration is handled within the machine driver.
>  For details on the clock APIs that the machine driver can utilize for
>
> Thanks.
>
> --
> An old man doll... just what I always wanted! - Clara