[PATCH] ASoC: doc: dapm: Add location information for dapm-graph tool

[PATCH] ASoC: doc: dapm: Add location information for dapm-graph tool

[anish kumar]

To help developers debug DAPM issues and visualize widget connectivity,
the dapm-graph tool provides a graphical representation of how widgets
and routes are connected. This commit adds the location information for
the tool to the documentation, making it easier for users to find and
use it for troubleshooting DAPM-related problems.

Signed-off-by: anish kumar <yesanishhere@gmail.com>
---
This patch was generated as a result of recent problem I was
debugging with dapm widgets, where I was looking for a way
to visualize as was shown in the documentation, I had to
do a lot of google searches to figure out this tool. So,
just adding the information here so that future developers
doesn't need to look around.

 Documentation/sound/soc/dapm.rst | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/Documentation/sound/soc/dapm.rst b/Documentation/sound/soc/dapm.rst
index 14c4dc026e6b..73a42d5a9f30 100644
--- a/Documentation/sound/soc/dapm.rst
+++ b/Documentation/sound/soc/dapm.rst
@@ -35,6 +35,9 @@ The graph for the STM32MP1-DK1 sound card is shown in picture:
     :alt:   Example DAPM graph
     :align: center
 
+You can also generate compatible graph for your sound card using
+`tools/sound/dapm-graph` utility.
+
 DAPM power domains
 ==================
 
-- 
2.39.5 (Apple Git-154)

Re: [PATCH] ASoC: doc: dapm: Add location information for dapm-graph tool

[Mark Brown]

On Thu, 21 Nov 2024 15:29:58 -0800, anish kumar wrote:
> To help developers debug DAPM issues and visualize widget connectivity,
> the dapm-graph tool provides a graphical representation of how widgets
> and routes are connected. This commit adds the location information for
> the tool to the documentation, making it easier for users to find and
> use it for troubleshooting DAPM-related problems.
> 
> 
> [...]

Applied to

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

Thanks!

[1/1] ASoC: doc: dapm: Add location information for dapm-graph tool
      commit: 8697ecc3274214c65ff271a58e7abb601216f2a8

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