[-next] ASoC: Documentation: fix reference to renamed source file

Commit Message

Randy Dunlap June 29, 2020, 3:23 a.m. UTC

From: Randy Dunlap <[e-mail]>

sound/soc/soc-io.c was merged into sound/soc/soc-component.c, so fixup
the Documentation to use the updated file name.

Error: Cannot open file ../sound/soc/soc-io.c
WARNING: kernel-doc '../scripts/kernel-doc -rst -enable-lineno ../sound/soc/soc-io.c' failed with return code 1

Signed-off-by: Randy Dunlap <[e-mail]>
Cc: Kuninori Morimoto <[e-mail]>
Cc: Mark Brown <[e-mail]>
---
 Documentation/sound/kernel-api/alsa-driver-api.rst |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Kuninori Morimoto June 29, 2020, 3:58 a.m. UTC | #1

Hi

> From: Randy Dunlap <[e-mail]>
> 
> sound/soc/soc-io.c was merged into sound/soc/soc-component.c, so fixup
> the Documentation to use the updated file name.
> 
> Error: Cannot open file ../sound/soc/soc-io.c
> WARNING: kernel-doc '../scripts/kernel-doc -rst -enable-lineno ../sound/soc/soc-io.c' failed with return code 1
> 
> Signed-off-by: Randy Dunlap <[e-mail]>
> Cc: Kuninori Morimoto <[e-mail]>
> Cc: Mark Brown <[e-mail]>
> ---

We want to have

	Fixes: 460b42d162e3 ("ASoC: soc-component: merge soc-io.c into soc-component.c")

Acked-by: Kuninori Morimoto <[e-mail]>

Thank you for your help !!

Best regards
---
Kuninori Morimoto

Mark Brown June 29, 2020, 6:15 p.m. UTC | #2

On Sun, 28 Jun 2020 20:23:33 -0700, Randy Dunlap wrote:
> sound/soc/soc-io.c was merged into sound/soc/soc-component.c, so fixup
> the Documentation to use the updated file name.
> 
> Error: Cannot open file ../sound/soc/soc-io.c
> WARNING: kernel-doc '../scripts/kernel-doc -rst -enable-lineno ../sound/soc/soc-io.c' failed with return code 1

Applied to

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

Thanks!

[1/1] ASoC: Documentation: fix reference to renamed source file
      commit: 4946cd45ef665d99074796fdd8ce04ba37ce1bdf

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

Patch

--- linux-next-20200626.orig/Documentation/sound/kernel-api/alsa-driver-api.rst
+++ linux-next-20200626/Documentation/sound/kernel-api/alsa-driver-api.rst
@@ -99,7 +99,7 @@  ASoC Core API
 .. kernel-doc:: include/sound/soc.h
 .. kernel-doc:: sound/soc/soc-core.c
 .. kernel-doc:: sound/soc/soc-devres.c
-.. kernel-doc:: sound/soc/soc-io.c
+.. kernel-doc:: sound/soc/soc-component.c
 .. kernel-doc:: sound/soc/soc-pcm.c
 .. kernel-doc:: sound/soc/soc-ops.c
 .. kernel-doc:: sound/soc/soc-compress.c