[PATCH] fs: vboxsf: fix a kernel-doc warning

[PATCH] fs: vboxsf: fix a kernel-doc warning

[Randy Dunlap]

Fix function parameters to prevent kernel-doc warnings.

vboxsf_wrappers.c:132: warning: Function parameter or member 'create_parms' not described in 'vboxsf_create'
vboxsf_wrappers.c:132: warning: Excess function parameter 'param' description in 'vboxsf_create'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Hans de Goede <hdegoede@redhat.com>
Cc: Alexander Viro <viro@zeniv.linux.org.uk>
Cc: Christian Brauner <brauner@kernel.org>
---
 fs/vboxsf/vboxsf_wrappers.c |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff -- a/fs/vboxsf/vboxsf_wrappers.c b/fs/vboxsf/vboxsf_wrappers.c
--- a/fs/vboxsf/vboxsf_wrappers.c
+++ b/fs/vboxsf/vboxsf_wrappers.c
@@ -114,7 +114,7 @@ int vboxsf_unmap_folder(u32 root)
  * vboxsf_create - Create a new file or folder
  * @root:         Root of the shared folder in which to create the file
  * @parsed_path:  The path of the file or folder relative to the shared folder
- * @param:        create_parms Parameters for file/folder creation.
+ * @create_parms: Parameters for file/folder creation.
  *
  * Create a new file or folder or open an existing one in a shared folder.
  * Note this function always returns 0 / success unless an exceptional condition

Re: [PATCH] fs: vboxsf: fix a kernel-doc warning

[Hans de Goede]

Hi Randy,

On 12/6/23 03:53, Randy Dunlap wrote:
> Fix function parameters to prevent kernel-doc warnings.
> 
> vboxsf_wrappers.c:132: warning: Function parameter or member 'create_parms' not described in 'vboxsf_create'
> vboxsf_wrappers.c:132: warning: Excess function parameter 'param' description in 'vboxsf_create'
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Hans de Goede <hdegoede@redhat.com>
> Cc: Alexander Viro <viro@zeniv.linux.org.uk>
> Cc: Christian Brauner <brauner@kernel.org>

Thanks, patch looks good to me:

Reviewed-by: Hans de Goede <hdegoede@redhat.com>

vboxsf is not really undergoing any active development,
can this be merged through the Documentation tree?

Regards,

Hans





> ---
>  fs/vboxsf/vboxsf_wrappers.c |    2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff -- a/fs/vboxsf/vboxsf_wrappers.c b/fs/vboxsf/vboxsf_wrappers.c
> --- a/fs/vboxsf/vboxsf_wrappers.c
> +++ b/fs/vboxsf/vboxsf_wrappers.c
> @@ -114,7 +114,7 @@ int vboxsf_unmap_folder(u32 root)
>   * vboxsf_create - Create a new file or folder
>   * @root:         Root of the shared folder in which to create the file
>   * @parsed_path:  The path of the file or folder relative to the shared folder
> - * @param:        create_parms Parameters for file/folder creation.
> + * @create_parms: Parameters for file/folder creation.
>   *
>   * Create a new file or folder or open an existing one in a shared folder.
>   * Note this function always returns 0 / success unless an exceptional condition
> 

Re: [PATCH] fs: vboxsf: fix a kernel-doc warning

[Randy Dunlap]

On 12/6/23 06:57, Hans de Goede wrote:
> Hi Randy,
> 
> On 12/6/23 03:53, Randy Dunlap wrote:
>> Fix function parameters to prevent kernel-doc warnings.
>>
>> vboxsf_wrappers.c:132: warning: Function parameter or member 'create_parms' not described in 'vboxsf_create'
>> vboxsf_wrappers.c:132: warning: Excess function parameter 'param' description in 'vboxsf_create'
>>
>> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
>> Cc: Hans de Goede <hdegoede@redhat.com>
>> Cc: Alexander Viro <viro@zeniv.linux.org.uk>
>> Cc: Christian Brauner <brauner@kernel.org>
> 
> Thanks, patch looks good to me:
> 
> Reviewed-by: Hans de Goede <hdegoede@redhat.com>
> 
> vboxsf is not really undergoing any active development,
> can this be merged through the Documentation tree?
> 
> Regards,
> 
> Hans

I have no idea, but we can ask Jon.

Jon, can you merge this patch thru the Documentation tree?


>> ---
>>  fs/vboxsf/vboxsf_wrappers.c |    2 +-
>>  1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> diff -- a/fs/vboxsf/vboxsf_wrappers.c b/fs/vboxsf/vboxsf_wrappers.c
>> --- a/fs/vboxsf/vboxsf_wrappers.c
>> +++ b/fs/vboxsf/vboxsf_wrappers.c
>> @@ -114,7 +114,7 @@ int vboxsf_unmap_folder(u32 root)
>>   * vboxsf_create - Create a new file or folder
>>   * @root:         Root of the shared folder in which to create the file
>>   * @parsed_path:  The path of the file or folder relative to the shared folder
>> - * @param:        create_parms Parameters for file/folder creation.
>> + * @create_parms: Parameters for file/folder creation.
>>   *
>>   * Create a new file or folder or open an existing one in a shared folder.
>>   * Note this function always returns 0 / success unless an exceptional condition
>>
> 

Thanks.
-- 
~Randy

Re: [PATCH] fs: vboxsf: fix a kernel-doc warning

[Jonathan Corbet]

Randy Dunlap <rdunlap@infradead.org> writes:

> On 12/6/23 06:57, Hans de Goede wrote:
>> Hi Randy,
>> 
>> On 12/6/23 03:53, Randy Dunlap wrote:
>>> Fix function parameters to prevent kernel-doc warnings.
>>>
>>> vboxsf_wrappers.c:132: warning: Function parameter or member 'create_parms' not described in 'vboxsf_create'
>>> vboxsf_wrappers.c:132: warning: Excess function parameter 'param' description in 'vboxsf_create'
>>>
>>> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
>>> Cc: Hans de Goede <hdegoede@redhat.com>
>>> Cc: Alexander Viro <viro@zeniv.linux.org.uk>
>>> Cc: Christian Brauner <brauner@kernel.org>
>> 
>> Thanks, patch looks good to me:
>> 
>> Reviewed-by: Hans de Goede <hdegoede@redhat.com>
>> 
>> vboxsf is not really undergoing any active development,
>> can this be merged through the Documentation tree?
>> 
>> Regards,
>> 
>> Hans
>
> I have no idea, but we can ask Jon.
>
> Jon, can you merge this patch thru the Documentation tree?

I've not actually seen the patch but, yes, I should be able to do that.
Will go dig it out in a bit.

Thanks,

jon