diff mbox series

test_kmod: stop kernel-doc warnings

Message ID 20230102211605.26058-1-rdunlap@infradead.org
State New
Headers
Series test_kmod: stop kernel-doc warnings |

Commit Message

Randy Dunlap Jan. 2, 2023, 9:16 p.m. UTC 
  Use kernel-doc notation to prevent warnings:

lib/test_kmod.c:58: warning: contents before sections
lib/test_kmod.c:94: warning: cannot understand function prototype: 'struct kmod_test_device_info '
lib/test_kmod.c:119: warning: cannot understand function prototype: 'struct kmod_test_device '

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Luis Chamberlain <mcgrof@kernel.org>
Cc: linux-modules@vger.kernel.org
---
 lib/test_kmod.c |   11 +++++------
 1 file changed, 5 insertions(+), 6 deletions(-)

Comments

Luis Chamberlain Jan. 4, 2023, 7:52 p.m. UTC | #1 
On Mon, Jan 02, 2023 at 01:16:05PM -0800, Randy Dunlap wrote:
> Use kernel-doc notation to prevent warnings:
> 
> lib/test_kmod.c:58: warning: contents before sections
> lib/test_kmod.c:94: warning: cannot understand function prototype: 'struct kmod_test_device_info '
> lib/test_kmod.c:119: warning: cannot understand function prototype: 'struct kmod_test_device '
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Luis Chamberlain <mcgrof@kernel.org>
> Cc: linux-modules@vger.kernel.org

Applied onto modules-next, thanks!

  Luis
diff mbox series

Patch

diff -- a/lib/test_kmod.c b/lib/test_kmod.c
--- a/lib/test_kmod.c
+++ b/lib/test_kmod.c
@@ -51,12 +51,11 @@  static int num_test_devs;
 
 /**
  * enum kmod_test_case - linker table test case
- *
- * If you add a  test case, please be sure to review if you need to se
- * @need_mod_put for your tests case.
- *
  * @TEST_KMOD_DRIVER: stress tests request_module()
  * @TEST_KMOD_FS_TYPE: stress tests get_fs_type()
+ *
+ * If you add a  test case, please be sure to review if you need to set
+ * @need_mod_put for your tests case.
  */
 enum kmod_test_case {
 	__TEST_KMOD_INVALID = 0,
@@ -78,7 +77,7 @@  struct test_config {
 struct kmod_test_device;
 
 /**
- * kmod_test_device_info - thread info
+ * struct kmod_test_device_info - thread info
  *
  * @ret_sync: return value if request_module() is used, sync request for
  * 	@TEST_KMOD_DRIVER
@@ -101,7 +100,7 @@  struct kmod_test_device_info {
 };
 
 /**
- * kmod_test_device - test device to help test kmod
+ * struct kmod_test_device - test device to help test kmod
  *
  * @dev_idx: unique ID for test device
  * @config: configuration for the test