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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date: Tue, 23 Apr 2024 08:43:23 +0700
From: Bagas Sanjaya <bagasdotme@...il.com>
To: Wesley Cheng <quic_wcheng@...cinc.com>, srinivas.kandagatla@...aro.org,
	mathias.nyman@...el.com, perex@...ex.cz, conor+dt@...nel.org,
	corbet@....net, lgirdwood@...il.com, andersson@...nel.org,
	krzysztof.kozlowski+dt@...aro.org, gregkh@...uxfoundation.org,
	Thinh.Nguyen@...opsys.com, broonie@...nel.org, bgoswami@...cinc.com,
	tiwai@...e.com, robh@...nel.org, konrad.dybcio@...aro.org
Cc: linux-kernel@...r.kernel.org, devicetree@...r.kernel.org,
	linux-sound@...r.kernel.org, linux-usb@...r.kernel.org,
	linux-arm-msm@...r.kernel.org, linux-doc@...r.kernel.org,
	alsa-devel@...a-project.org
Subject: Re: [PATCH v19 41/41] ASoC: doc: Add documentation for SOC USB

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.

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