linux-kernel - Re: [PATCH] kernfs: fix all kernel-doc warnings and multiple typos

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <Y31bE3Z1TL4s09Mq@slm.duckdns.org>
Date:   Tue, 22 Nov 2022 13:28:19 -1000
From:   Tejun Heo <tj@...nel.org>
To:     Randy Dunlap <rdunlap@...radead.org>
Cc:     linux-kernel@...r.kernel.org,
        Greg Kroah-Hartman <gregkh@...uxfoundation.org>
Subject: Re: [PATCH] kernfs: fix all kernel-doc warnings and multiple typos

On Fri, Nov 11, 2022 at 07:14:56PM -0800, Randy Dunlap wrote:
> Fix kernel-doc warnings. Many of these are about a function's
> return value, so use the kernel-doc Return: format to fix those
> 
> Use % prefix on numeric constant values.
> 
> dir.c: fix typos/spellos
> file.c fix typo: s/taret/target/
> 
> Fix all of these kernel-doc warnings:
> 
> dir.c:305: warning: missing initial short description on line:
>  *      kernfs_name_hash
> 
> dir.c:137: warning: No description found for return value of 'kernfs_path_from_node_locked'
> dir.c:196: warning: No description found for return value of 'kernfs_name'
> dir.c:224: warning: No description found for return value of 'kernfs_path_from_node'
> dir.c:292: warning: No description found for return value of 'kernfs_get_parent'
> dir.c:312: warning: No description found for return value of 'kernfs_name_hash'
> dir.c:404: warning: No description found for return value of 'kernfs_unlink_sibling'
> dir.c:588: warning: No description found for return value of 'kernfs_node_from_dentry'
> dir.c:806: warning: No description found for return value of 'kernfs_find_ns'
> dir.c:879: warning: No description found for return value of 'kernfs_find_and_get_ns'
> dir.c:904: warning: No description found for return value of 'kernfs_walk_and_get_ns'
> dir.c:927: warning: No description found for return value of 'kernfs_create_root'
> dir.c:996: warning: No description found for return value of 'kernfs_root_to_node'
> dir.c:1016: warning: No description found for return value of 'kernfs_create_dir_ns'
> dir.c:1048: warning: No description found for return value of 'kernfs_create_empty_dir'
> dir.c:1306: warning: No description found for return value of 'kernfs_next_descendant_post'
> dir.c:1568: warning: No description found for return value of 'kernfs_remove_self'
> dir.c:1630: warning: No description found for return value of 'kernfs_remove_by_name_ns'
> dir.c:1667: warning: No description found for return value of 'kernfs_rename_ns'
> 
> file.c:66: warning: No description found for return value of 'of_on'
> file.c:88: warning: No description found for return value of 'kernfs_deref_open_node_locked'
> file.c:1036: warning: No description found for return value of '__kernfs_create_file'
> 
> inode.c:100: warning: No description found for return value of 'kernfs_setattr'
> 
> mount.c:160: warning: No description found for return value of 'kernfs_root_from_sb'
> mount.c:198: warning: No description found for return value of 'kernfs_node_dentry'
> mount.c:302: warning: No description found for return value of 'kernfs_super_ns'
> mount.c:318: warning: No description found for return value of 'kernfs_get_tree'
> 
> symlink.c:28: warning: No description found for return value of 'kernfs_create_link'
> 
> Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
> Cc: Greg Kroah-Hartman <gregkh@...uxfoundation.org>
> Cc: Tejun Heo <tj@...nel.org>

Acked-by: Tejun Heo <tj@...nel.org>

Thanks.

-- 
tejun