[00/12] ASoC: doc: dapm: various improvements

Message

Luca Ceresoli April 16, 2024, 5:56 a.m. UTC

This series applies various improvements to the DAPM documentation: a
rewrite of a few sections for clarity, style improvements and typo fixes.

Signed-off-by: Luca Ceresoli <[e-mail]>
---
Luca Ceresoli (12):
      ASoC: doc: dapm: fix typos
      ASoC: doc: dapm: fix struct name
      ASoC: doc: dapm: minor rewording
      ASoC: doc: dapm: remove dash after colon
      ASoC: doc: dapm: clarify it's an internal API
      ASoC: doc: dapm: replace "map" with "graph"
      ASoC: doc: dapm: extend initial descrption
      ASoC: doc: dapm: describe how widgets and routes are registered
      ASoC: doc: dapm: fix and improve section "Registering DAPM controls"
      ASoC: doc: dapm: improve section "Codec/DSP Widget Interconnections"
      ASoC: doc: dapm: update section "DAPM Widget Events"
      ASoC: doc: dapm: update event types

 Documentation/sound/soc/dapm-graph.svg | 375 +++++++++++++++++++++++++++++++++
 Documentation/sound/soc/dapm.rst       | 178 ++++++++++------
 2 files changed, 494 insertions(+), 59 deletions(-)
---
base-commit: 8f2c057754b25075aa3da132cd4fd4478cdab854
change-id: 20240315-dapm-docs-79bd51f267db

Best regards,

Comments

Alexandre Belloni April 16, 2024, 9:23 p.m. UTC | #1

On 16/04/2024 07:56:06+0200, Luca Ceresoli wrote:
> This series applies various improvements to the DAPM documentation: a
> rewrite of a few sections for clarity, style improvements and typo fixes.
> 
> Signed-off-by: Luca Ceresoli <[e-mail]>

Reviewed-by: Alexandre Belloni <[e-mail]>

> ---
> Luca Ceresoli (12):
>       ASoC: doc: dapm: fix typos
>       ASoC: doc: dapm: fix struct name
>       ASoC: doc: dapm: minor rewording

I'm wondering whether you could improve this patch by not rewrapping the
whole paragraph.

>       ASoC: doc: dapm: remove dash after colon
>       ASoC: doc: dapm: clarify it's an internal API
>       ASoC: doc: dapm: replace "map" with "graph"
>       ASoC: doc: dapm: extend initial descrption
>       ASoC: doc: dapm: describe how widgets and routes are registered
>       ASoC: doc: dapm: fix and improve section "Registering DAPM controls"
>       ASoC: doc: dapm: improve section "Codec/DSP Widget Interconnections"
>       ASoC: doc: dapm: update section "DAPM Widget Events"
>       ASoC: doc: dapm: update event types
> 
>  Documentation/sound/soc/dapm-graph.svg | 375 +++++++++++++++++++++++++++++++++
>  Documentation/sound/soc/dapm.rst       | 178 ++++++++++------
>  2 files changed, 494 insertions(+), 59 deletions(-)
> ---
> base-commit: 8f2c057754b25075aa3da132cd4fd4478cdab854
> change-id: 20240315-dapm-docs-79bd51f267db
> 
> Best regards,
> -- 
> Luca Ceresoli <[e-mail]>
>

Luca Ceresoli April 17, 2024, 5:07 a.m. UTC | #2

Hi Alex,

thanks for the review!

On Tue, 16 Apr 2024 23:23:49 +0200
Alexandre Belloni <[e-mail]> wrote:

> On 16/04/2024 07:56:06+0200, Luca Ceresoli wrote:
> > This series applies various improvements to the DAPM documentation: a
> > rewrite of a few sections for clarity, style improvements and typo fixes.
> > 
> > Signed-off-by: Luca Ceresoli <[e-mail]>  
> 
> Reviewed-by: Alexandre Belloni <[e-mail]>
> 
> > ---
> > Luca Ceresoli (12):
> >       ASoC: doc: dapm: fix typos
> >       ASoC: doc: dapm: fix struct name
> >       ASoC: doc: dapm: minor rewording  
> 
> I'm wondering whether you could improve this patch by not rewrapping the
> whole paragraph.

Sure. I'm waiting a few more days for any additional comments and then
send a v2 with this change.

Luca

Luca Ceresoli April 17, 2024, 11:30 p.m. UTC | #3

Hi Alex,

On Tue, 16 Apr 2024 23:23:49 +0200
Alexandre Belloni <[e-mail]> wrote:

> On 16/04/2024 07:56:06+0200, Luca Ceresoli wrote:
> > This series applies various improvements to the DAPM documentation: a
> > rewrite of a few sections for clarity, style improvements and typo fixes.
> > 
> > Signed-off-by: Luca Ceresoli <[e-mail]>  
> 
> Reviewed-by: Alexandre Belloni <[e-mail]>

Thanks for reviewing.

> > ---
> > Luca Ceresoli (12):
> >       ASoC: doc: dapm: fix typos
> >       ASoC: doc: dapm: fix struct name
> >       ASoC: doc: dapm: minor rewording  
> 
> I'm wondering whether you could improve this patch by not rewrapping the
> whole paragraph.

Yes, sure. Will do in v2.

Luca