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

Message

Luca Ceresoli April 26, 2024, 4:56 p.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]>
---
Changes in v2:
- avoid wrapping in patch 3 as suggested by Alex
- Link to v1: https://lore.kernel.org/r/[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       | 174 ++++++++++-----
 2 files changed, 492 insertions(+), 57 deletions(-)
---
base-commit: c942a0cd3603e34dd2d7237e064d9318cb7f9654
change-id: 20240315-dapm-docs-79bd51f267db

Best regards,

Comments

Mark Brown May 1, 2024, 1:43 p.m. UTC | #1

On Fri, 26 Apr 2024 18:56:33 +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.
> 
> 

Applied to

   https://git.kernel.org/pub/scm/linux/kernel/git/broonie/sound.git for-next

Thanks!

[01/12] ASoC: doc: dapm: fix typos
        commit: 534e0cd89baf74c22ca55b442fb4add8d844e272
[02/12] ASoC: doc: dapm: fix struct name
        commit: eaf84bda623e0a034fe03b871addf7dc4f70dfff
[03/12] ASoC: doc: dapm: minor rewording
        commit: 610277caa77f07997857ab2e31a073d8ad7ed090
[04/12] ASoC: doc: dapm: remove dash after colon
        commit: 3233a68fcb216a2d8615862841c1fca7a940fc5c
[06/12] ASoC: doc: dapm: replace "map" with "graph"
        commit: 7d0e76107894377a14f211c85a821a53416d5ab2
[07/12] ASoC: doc: dapm: extend initial descrption
        commit: dd5f36e59134654f9fd7b39d4d66327a1a2db82d
[08/12] ASoC: doc: dapm: describe how widgets and routes are registered
        commit: 36de8c0e26793beeda1d6a7592f44b4551271469
[09/12] ASoC: doc: dapm: fix and improve section "Registering DAPM controls"
        commit: d40e82194423c9d058bdeff863373b7da9f7045b
[10/12] ASoC: doc: dapm: improve section "Codec/DSP Widget Interconnections"
        commit: 057acfb460d6792c7d3ec088f57c411fb0e4d395
[11/12] ASoC: doc: dapm: update section "DAPM Widget Events"
        commit: ce5a4f101cd0dfbda391d4f1815222d82a9d8a5a
[12/12] ASoC: doc: dapm: update event types
        commit: 4155a82f6af8068473cd66b55da56fd379835fb0

All being well this means that it will be integrated into the linux-next
tree (usually sometime in the next 24 hours) and sent to Linus during
the next merge window (or sooner if it is a bug fix), however if
problems are discovered then the patch may be dropped or reverted.

You may get further e-mails resulting from automated or manual testing
and review of the tree, please engage with people reporting problems and
send followup patches addressing any issues that are reported if needed.

If any updates are required or you are submitting further changes they
should be sent as incremental updates against current git, existing
patches will not be replaced.

Please add any relevant lists and maintainers to the CCs when replying
to this mail.

Thanks,
Mark