mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
* [PATCH] kunit: Fix some comments which were mistakenly kerneldoc
@ 2023-12-23  4:18 David Gow
  2023-12-23  4:23 ` Randy Dunlap
  0 siblings, 1 reply; 2+ messages in thread
From: David Gow @ 2023-12-23  4:18 UTC (permalink / raw)
  To: Shuah Khan, Rae Moar
  Cc: kunit-dev, linux-kselftest, linux-kernel, Brendan Higgins,
	David Gow, kernel test robot

The KUnit device helpers are documented with kerneldoc in their header
file, but also have short comments over their implementation. These were
mistakenly formatted as kerneldoc comments, even though they're not
valid kerneldoc. It shouldn't cause any serious problems -- this file
isn't included in the docs -- but it could be confusing, and causes
warnings.

Remove the extra '*' so that these aren't treated as kerneldoc.

Fixes: d03c720e03bd ("kunit: Add APIs for managing devices")
Reported-by: kernel test robot <lkp@intel.com>
Closes: https://lore.kernel.org/oe-kbuild-all/202312181920.H4EPAH20-lkp@intel.com/
Signed-off-by: David Gow <davidgow@google.com>
---
 lib/kunit/device.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/lib/kunit/device.c b/lib/kunit/device.c
index 1db4305b615a..f5371287b375 100644
--- a/lib/kunit/device.c
+++ b/lib/kunit/device.c
@@ -60,7 +60,7 @@ static void kunit_device_release(struct device *d)
 	kfree(to_kunit_device(d));
 }
 
-/**
+/*
  * Create and register a KUnit-managed struct device_driver on the kunit_bus.
  * Returns an error pointer on failure.
  */
@@ -124,7 +124,7 @@ static struct kunit_device *kunit_device_register_internal(struct kunit *test,
 	return kunit_dev;
 }
 
-/**
+/*
  * Create and register a new KUnit-managed device, using the user-supplied device_driver.
  * On failure, returns an error pointer.
  */
@@ -141,7 +141,7 @@ struct device *kunit_device_register_with_driver(struct kunit *test,
 }
 EXPORT_SYMBOL_GPL(kunit_device_register_with_driver);
 
-/**
+/*
  * Create and register a new KUnit-managed device, including a matching device_driver.
  * On failure, returns an error pointer.
  */
-- 
2.43.0.472.g3155946c3a-goog


^ permalink raw reply	[flat|nested] 2+ messages in thread

* Re: [PATCH] kunit: Fix some comments which were mistakenly kerneldoc
  2023-12-23  4:18 [PATCH] kunit: Fix some comments which were mistakenly kerneldoc David Gow
@ 2023-12-23  4:23 ` Randy Dunlap
  0 siblings, 0 replies; 2+ messages in thread
From: Randy Dunlap @ 2023-12-23  4:23 UTC (permalink / raw)
  To: David Gow, Shuah Khan, Rae Moar
  Cc: kunit-dev, linux-kselftest, linux-kernel, Brendan Higgins,
	kernel test robot



On 12/22/23 20:18, David Gow wrote:
> The KUnit device helpers are documented with kerneldoc in their header
> file, but also have short comments over their implementation. These were
> mistakenly formatted as kerneldoc comments, even though they're not
> valid kerneldoc. It shouldn't cause any serious problems -- this file
> isn't included in the docs -- but it could be confusing, and causes
> warnings.
> 
> Remove the extra '*' so that these aren't treated as kerneldoc.
> 
> Fixes: d03c720e03bd ("kunit: Add APIs for managing devices")
> Reported-by: kernel test robot <lkp@intel.com>
> Closes: https://lore.kernel.org/oe-kbuild-all/202312181920.H4EPAH20-lkp@intel.com/
> Signed-off-by: David Gow <davidgow@google.com>

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>

Thanks.

> ---
>  lib/kunit/device.c | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/lib/kunit/device.c b/lib/kunit/device.c
> index 1db4305b615a..f5371287b375 100644
> --- a/lib/kunit/device.c
> +++ b/lib/kunit/device.c
> @@ -60,7 +60,7 @@ static void kunit_device_release(struct device *d)
>  	kfree(to_kunit_device(d));
>  }
>  
> -/**
> +/*
>   * Create and register a KUnit-managed struct device_driver on the kunit_bus.
>   * Returns an error pointer on failure.
>   */
> @@ -124,7 +124,7 @@ static struct kunit_device *kunit_device_register_internal(struct kunit *test,
>  	return kunit_dev;
>  }
>  
> -/**
> +/*
>   * Create and register a new KUnit-managed device, using the user-supplied device_driver.
>   * On failure, returns an error pointer.
>   */
> @@ -141,7 +141,7 @@ struct device *kunit_device_register_with_driver(struct kunit *test,
>  }
>  EXPORT_SYMBOL_GPL(kunit_device_register_with_driver);
>  
> -/**
> +/*
>   * Create and register a new KUnit-managed device, including a matching device_driver.
>   * On failure, returns an error pointer.
>   */

-- 
#Randy
https://people.kernel.org/tglx/notes-about-netiquette
https://subspace.kernel.org/etiquette.html

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2023-12-23  4:23 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-12-23  4:18 [PATCH] kunit: Fix some comments which were mistakenly kerneldoc David Gow
2023-12-23  4:23 ` Randy Dunlap

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®