2022-05-03 01:18:29

by Bagas Sanjaya

[permalink] [raw]
Subject: [PATCH] firmware_loader: describe 'module' parameter of firmware_upload_register()

Stephen Rothwell reported kernel-doc warning:

drivers/base/firmware_loader/sysfs_upload.c:285: warning: Function parameter or member 'module' not described in 'firmware_upload_register'

Fix the warning by describing the 'module' parameter.

Fixes: 97730bbb242cde ("firmware_loader: Add firmware-upload support")
Link: https://lore.kernel.org/linux-next/[email protected]/
Cc: Stephen Rothwell <[email protected]>
Cc: Russ Weight <[email protected]>
Cc: Luis Chamberlain <[email protected]>
Cc: Greg Kroah-Hartman <[email protected]>
Cc: "Rafael J. Wysocki" <[email protected]>
Cc: Linux Kernel Mailing List <[email protected]>
Cc: Linux Next Mailing List <[email protected]>
Signed-off-by: Bagas Sanjaya <[email protected]>
---
This patch is based on driver-core-next tree.

drivers/base/firmware_loader/sysfs_upload.c | 1 +
1 file changed, 1 insertion(+)

diff --git a/drivers/base/firmware_loader/sysfs_upload.c b/drivers/base/firmware_loader/sysfs_upload.c
index 8cdcf3516c7e94..87044d52322aa2 100644
--- a/drivers/base/firmware_loader/sysfs_upload.c
+++ b/drivers/base/firmware_loader/sysfs_upload.c
@@ -266,6 +266,7 @@ int fw_upload_start(struct fw_sysfs *fw_sysfs)

/**
* firmware_upload_register() - register for the firmware upload sysfs API
+ * @module: kernel module of this device
* @parent: parent device instantiating firmware upload
* @name: firmware name to be associated with this device
* @ops: pointer to structure of firmware upload ops

base-commit: f8ae07f4b8bfde0f33761e1a1aaee45a4e85e9d6
--
An old man doll... just what I always wanted! - Clara


2022-05-03 12:27:01

by Greg KH

[permalink] [raw]
Subject: Re: [PATCH] firmware_loader: describe 'module' parameter of firmware_upload_register()

On Mon, May 02, 2022 at 12:14:56PM +0700, Bagas Sanjaya wrote:
> Stephen Rothwell reported kernel-doc warning:
>
> drivers/base/firmware_loader/sysfs_upload.c:285: warning: Function parameter or member 'module' not described in 'firmware_upload_register'
>
> Fix the warning by describing the 'module' parameter.
>
> Fixes: 97730bbb242cde ("firmware_loader: Add firmware-upload support")
> Link: https://lore.kernel.org/linux-next/[email protected]/
> Cc: Stephen Rothwell <[email protected]>

This should be "Reported-by:" I'll fix it up when I apply it to my tree
now, thanks.

greg k-h

2022-05-04 08:53:03

by Luis Chamberlain

[permalink] [raw]
Subject: Re: [PATCH] firmware_loader: describe 'module' parameter of firmware_upload_register()

On Mon, May 02, 2022 at 12:14:56PM +0700, Bagas Sanjaya wrote:
> Stephen Rothwell reported kernel-doc warning:
>
> drivers/base/firmware_loader/sysfs_upload.c:285: warning: Function parameter or member 'module' not described in 'firmware_upload_register'
>
> Fix the warning by describing the 'module' parameter.
>
> Fixes: 97730bbb242cde ("firmware_loader: Add firmware-upload support")
> Link: https://lore.kernel.org/linux-next/[email protected]/
> Cc: Stephen Rothwell <[email protected]>
> Cc: Russ Weight <[email protected]>
> Cc: Luis Chamberlain <[email protected]>
> Cc: Greg Kroah-Hartman <[email protected]>
> Cc: "Rafael J. Wysocki" <[email protected]>
> Cc: Linux Kernel Mailing List <[email protected]>
> Cc: Linux Next Mailing List <[email protected]>
> Signed-off-by: Bagas Sanjaya <[email protected]>

Acked-by: Luis Chamberlain <[email protected]>

Luis