test_firmware: use kernel-doc struct notation

Message ID 20230102211554.25629-1-rdunlap@infradead.org
State New
Headers
Series test_firmware: use kernel-doc struct notation |

Commit Message

Randy Dunlap Jan. 2, 2023, 9:15 p.m. UTC
  Add "struct" to the kernel-doc notation to prevent a warning:

lib/test_firmware.c:98: warning: cannot understand function prototype: 'struct test_config '

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Luis Chamberlain <mcgrof@kernel.org>
Cc: Russ Weight <russell.h.weight@intel.com>
Cc: Kees Cook <keescook@chromium.org>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
---
 lib/test_firmware.c |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
  

Comments

Luis Chamberlain Jan. 3, 2023, 4:44 p.m. UTC | #1
On Mon, Jan 02, 2023 at 01:15:54PM -0800, Randy Dunlap wrote:
> Add "struct" to the kernel-doc notation to prevent a warning:
> 
> lib/test_firmware.c:98: warning: cannot understand function prototype: 'struct test_config '
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Luis Chamberlain <mcgrof@kernel.org>
> Cc: Russ Weight <russell.h.weight@intel.com>
> Cc: Kees Cook <keescook@chromium.org>
> Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

Acked-by: Luis Chamberlain <mcgrof@kernel.org>

 Luis
  

Patch

diff -- a/lib/test_firmware.c b/lib/test_firmware.c
--- a/lib/test_firmware.c
+++ b/lib/test_firmware.c
@@ -50,7 +50,7 @@  struct test_batched_req {
 };
 
 /**
- * test_config - represents configuration for the test for different triggers
+ * struct test_config - represents configuration for the test for different triggers
  *
  * @name: the name of the firmware file to look for
  * @into_buf: when the into_buf is used if this is true