ASoC: soc-dapm.h: fixup comment for snd_soc_dapm_widget_for_each_path()
authorKuninori Morimoto <kuninori.morimoto.gx@renesas.com>
Wed, 19 Oct 2022 00:37:20 +0000 (00:37 +0000)
committerMark Brown <broonie@kernel.org>
Wed, 19 Oct 2022 12:05:33 +0000 (13:05 +0100)
The comment of snd_soc_dapm_widget_for_each_path() (= X) has
"_sink_" (= s), but this is typo.
With "_sink_" is already exist at (A). This patch fixup it.

/**
(s)  * snd_soc_dapm_widget_for_each_sink_path - ...
 *                              ****
 */
(X) #define snd_soc_dapm_widget_for_each_path(w, dir, p)

/**
(s)  * snd_soc_dapm_widget_for_each_sink_path_safe - ...
 *                              ****
 */
(X) #define snd_soc_dapm_widget_for_each_path_safe(w, dir, p, next_p)

(A) #define snd_soc_dapm_widget_for_each_sink_path(w, p)
                                     ****

Signed-off-by: Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
Reviewed-by: Amadeusz Sławiński <amadeuszx.slawinski@linux.intel.com>
Link: https://lore.kernel.org/r/87wn8wsl6n.wl-kuninori.morimoto.gx@renesas.com
Signed-off-by: Mark Brown <broonie@kernel.org>
include/sound/soc-dapm.h

index 44597e6..77495e5 100644 (file)
@@ -735,7 +735,7 @@ enum snd_soc_dapm_direction {
 #define SND_SOC_DAPM_EP_SINK   SND_SOC_DAPM_DIR_TO_EP(SND_SOC_DAPM_DIR_OUT)
 
 /**
- * snd_soc_dapm_widget_for_each_sink_path - Iterates over all paths in the
+ * snd_soc_dapm_widget_for_each_path - Iterates over all paths in the
  *   specified direction of a widget
  * @w: The widget
  * @dir: Whether to iterate over the paths where the specified widget is the
@@ -746,7 +746,7 @@ enum snd_soc_dapm_direction {
        list_for_each_entry(p, &w->edges[dir], list_node[dir])
 
 /**
- * snd_soc_dapm_widget_for_each_sink_path_safe - Iterates over all paths in the
+ * snd_soc_dapm_widget_for_each_path_safe - Iterates over all paths in the
  *   specified direction of a widget
  * @w: The widget
  * @dir: Whether to iterate over the paths where the specified widget is the
@@ -754,7 +754,7 @@ enum snd_soc_dapm_direction {
  * @p: The path iterator variable
  * @next_p: Temporary storage for the next path
  *
- *  This function works like snd_soc_dapm_widget_for_each_sink_path, expect that
+ *  This function works like snd_soc_dapm_widget_for_each_path, expect that
  *  it is safe to remove the current path from the list while iterating
  */
 #define snd_soc_dapm_widget_for_each_path_safe(w, dir, p, next_p) \