Re: [PATCH 10/12] ASoC: doc: dapm: improve section "Codec/DSP Widget Interconnections"

From: Bagas Sanjaya
Date: Wed Apr 17 2024 - 00:33:29 EST


On Tue, Apr 16, 2024 at 07:56:16AM +0200, Luca Ceresoli wrote:
> -Each input in this example has a kcontrol associated with it (defined in example
> -above) and is connected to the output mixer via its kcontrol name. We can now
> -connect the destination widget (wrt audio signal) with its source widgets.
> -::
> +Each input in this example has a kcontrol associated with it (defined in
> +the example above) and is connected to the output mixer via its kcontrol
> +name. We can now connect the destination widget (wrt audio signal) with its
> +source widgets. ::
> <snipped>...
> -Interconnections are created with a call to:
> -::
> +Interconnections are created with a call to::
>

Not strictly related to this patch, but for consistency, I'd like
to write remaining literal block markers at the end of previous
paragraph:

---- >8 ----
diff --git a/Documentation/sound/soc/dapm.rst b/Documentation/sound/soc/dapm.rst
index f76fc97dd16219..e4c44d08c8380b 100644
--- a/Documentation/sound/soc/dapm.rst
+++ b/Documentation/sound/soc/dapm.rst
@@ -180,15 +180,13 @@ Path Domain Widgets
-------------------

Path domain widgets have a ability to control or affect the audio signal or
-audio paths within the audio subsystem. They have the following form:
-::
+audio paths within the audio subsystem. They have the following form::

SND_SOC_DAPM_PGA(name, reg, shift, invert, controls, num_controls)

Any widget kcontrols can be set using the controls and num_controls members.

-e.g. Mixer widget (the kcontrols are declared first)
-::
+e.g. Mixer widget (the kcontrols are declared first)::

/* Output Mixer */
static const snd_kcontrol_new_t wm8731_output_mixer_controls[] = {
@@ -244,8 +242,7 @@ Virtual Widgets

Sometimes widgets exist in the codec or machine audio graph that don't have any
corresponding soft power control. In this case it is necessary to create
-a virtual widget - a widget with no control bits e.g.
-::
+a virtual widget - a widget with no control bits e.g::

SND_SOC_DAPM_MIXER("AC97 Mixer", SND_SOC_NOPM, 0, 0, NULL, 0),

@@ -316,7 +313,7 @@ For example the WM8731 output mixer (wm8731.c) has 3 inputs (sources):
Each input in this example has a kcontrol associated with it (defined in
the example above) and is connected to the output mixer via its kcontrol
name. We can now connect the destination widget (wrt audio signal) with its
-source widgets. ::
+source widgets::

/* output mixer */
{"Output Mixer", "Line Bypass Switch", "Line Input"},
@@ -347,8 +344,7 @@ Machine Widget Interconnections
Machine widget interconnections are created in the same way as codec ones and
directly connect the codec pins to machine level widgets.

-e.g. connects the speaker out codec pins to the internal speaker.
-::
+e.g. connects the speaker out codec pins to the internal speaker::

/* ext speaker connected to codec pins LOUT2, ROUT2 */
{"Ext Spk", NULL , "ROUT2"},

Thanks.

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

Attachment: signature.asc
Description: PGP signature