[PATCH] ASoC: soc-ac97: Fix the incorrect description

[PATCH] ASoC: soc-ac97: Fix the incorrect description

[Tang Bin]

In the function snd_soc_alloc_ac97_component &
snd_soc_new_ac97_component, the error return is
ERR_PTR, so fix the incorrect description.

Fixes: 47e039413cac ("ASoC: soc-ac97: Return correct error codes")
Signed-off-by: Tang Bin <tangbin@cmss.chinamobile.com>
---
 sound/soc/soc-ac97.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/sound/soc/soc-ac97.c b/sound/soc/soc-ac97.c
index 4e4fe29ad..079e4ff5a 100644
--- a/sound/soc/soc-ac97.c
+++ b/sound/soc/soc-ac97.c
@@ -168,7 +168,7 @@ static void snd_soc_ac97_free_gpio(struct snd_ac97 *ac97)
  * it. The caller is responsible to either call device_add(&ac97->dev) to
  * register the device, or to call put_device(&ac97->dev) to free the device.
  *
- * Returns: A snd_ac97 device or a PTR_ERR in case of an error.
+ * Returns: A snd_ac97 device or an ERR_PTR in case of an error.
  */
 struct snd_ac97 *snd_soc_alloc_ac97_component(struct snd_soc_component *component)
 {
@@ -207,7 +207,7 @@ EXPORT_SYMBOL(snd_soc_alloc_ac97_component);
  * the device and check if it matches the expected ID. If it doesn't match an
  * error will be returned and device will not be registered.
  *
- * Returns: A PTR_ERR() on failure or a valid snd_ac97 struct on success.
+ * Returns: An ERR_PTR on failure or a valid snd_ac97 struct on success.
  */
 struct snd_ac97 *snd_soc_new_ac97_component(struct snd_soc_component *component,
 	unsigned int id, unsigned int id_mask)
-- 
2.33.0

Re: [PATCH] ASoC: soc-ac97: Fix the incorrect description

[Markus Elfring]

> In the function snd_soc_alloc_ac97_component &
> snd_soc_new_ac97_component, the error return is
> ERR_PTR, so fix the incorrect description.

1. You may occasionally put more than 47 characters into text lines
   of such a change description.

2. How do you think about to use the term “error pointer” here
   (instead of the mentioned inline function name)?
   https://elixir.bootlin.com/linux/v6.11-rc6/source/include/linux/err.h#L31


Regards,
Markus

Re: [PATCH] ASoC: soc-ac97: Fix the incorrect description

[Mark Brown]

[-- Attachment #1: Type: text/plain, Size: 579 bytes --]

On Sun, Sep 08, 2024 at 08:41:23PM +0800, Tang Bin wrote:
> In the function snd_soc_alloc_ac97_component &
> snd_soc_new_ac97_component, the error return is
> ERR_PTR, so fix the incorrect description.
> 
> Fixes: 47e039413cac ("ASoC: soc-ac97: Return correct error codes")
> Signed-off-by: Tang Bin <tangbin@cmss.chinamobile.com>

That commit hash corresponds to "ASoC: Add support for allocating AC'97
device before registering it" which is not what your Fixes tag says,
there is a commit with that title but it's got hash
76f5aaabce492aa6991c28c96bb78b00b05d06c5.

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

Re: [PATCH] ASoC: soc-ac97: Fix the incorrect description

[Mark Brown]

On Sun, 08 Sep 2024 20:41:23 +0800, Tang Bin wrote:
> In the function snd_soc_alloc_ac97_component &
> snd_soc_new_ac97_component, the error return is
> ERR_PTR, so fix the incorrect description.
> 
> 

Applied to

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

Thanks!

[1/1] ASoC: soc-ac97: Fix the incorrect description
      commit: 86a7f453e99c3c202ac1623557e4f57bd73fc88c

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