linux-kernel - Re: [PATCH] include/linux/dcache.h: fix warning in doc comment

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]

Date:   Tue, 26 Sep 2023 13:34:08 -0700
From:   Randy Dunlap <rdunlap@...radead.org>
To:     Nik Bune <n2h9z4@...il.com>,
        Andrew Morton <akpm@...ux-foundation.org>,
        Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
        skhan@...uxfoundation.org, Jakub Kicinski <kuba@...nel.org>,
        Jens Axboe <axboe@...nel.dk>,
        Alexander Viro <viro@...iv.linux.org.uk>,
        Christian Brauner <brauner@...nel.org>
Cc:     linux-kernel@...r.kernel.org
Subject: Re: [PATCH] include/linux/dcache.h: fix warning in doc comment

Hi,

[adding VFS folks]

On 9/26/23 09:36, Nik Bune wrote:
> When run make htmldocs there is a warning appears
> ./include/linux/dcache.h:311: warning: expecting prototype for dget, dget_dlock(). Prototype was for dget_dlock() instead
> 
> The comment over the dget_dlock function describes both dget_dlock and dget functions. dget goes right after dget_dlock.
> 
> Removed "dget" from dget_dlock function comment.
> Copied the same block to the dget function below.
> 
> 
> Signed-off-by: Nik Bune <n2h9z4@...il.com>

I was working on this one also, but yours is good as far as it goes.

I was trying to differentiate between dget() and dget_dlock().
Something simple and short, like:

in get():

	dget() is used for the initial lockref on a dentry.

and in dget_dlock():

	dget_dlock() is used to increment the lockref count
	after the initial lockref is made.

but I don't know how correct those comments are or how they
should be improved.  :(

> ---
>  include/linux/dcache.h | 10 +++++++++-
>  1 file changed, 9 insertions(+), 1 deletion(-)
> 
> diff --git a/include/linux/dcache.h b/include/linux/dcache.h
> index 6b351e009f59..47adb8dda4a9 100644
> --- a/include/linux/dcache.h
> +++ b/include/linux/dcache.h
> @@ -300,7 +300,7 @@ extern char *dentry_path(const struct dentry *, char *, int);
>  /* Allocation counts.. */
>  
>  /**
> - *	dget, dget_dlock -	get a reference to a dentry
> + *	dget_dlock -	get a reference to a dentry
>   *	@dentry: dentry to get a reference to
>   *
>   *	Given a dentry or %NULL pointer increment the reference count
> @@ -314,6 +314,14 @@ static inline struct dentry *dget_dlock(struct dentry *dentry)
>  	return dentry;
>  }
>  
> +/**
> + *	dget -	get a reference to a dentry
> + *	@dentry: dentry to get a reference to
> + *
> + *	Given a dentry or %NULL pointer increment the reference count
> + *	if appropriate and return the dentry. A dentry will not be 
> + *	destroyed when it has references.
> + */
>  static inline struct dentry *dget(struct dentry *dentry)
>  {
>  	if (dentry)

-- 
~Randy