[PATCH] Doc fix for dget_dlock

Anup K Parikh posted 1 patch 3 years, 8 months ago
include/linux/dcache.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
[PATCH] Doc fix for dget_dlock
Posted by Anup K Parikh 3 years, 8 months ago
Removes the warning for dget_dlock in include/linux/dcache.h and
enables generation of its API documentation

Signed-off-by: Anup K Parikh <parikhanupk.foss@gmail.com>
---
 include/linux/dcache.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/linux/dcache.h b/include/linux/dcache.h
index f5bba5148..ce0b36f72 100644
--- a/include/linux/dcache.h
+++ b/include/linux/dcache.h
@@ -297,7 +297,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
-- 
2.35.1
Re: [PATCH] Doc fix for dget_dlock
Posted by Randy Dunlap 3 years, 8 months ago
Hi--

On 8/5/22 09:39, Anup K Parikh wrote:
> Removes the warning for dget_dlock in include/linux/dcache.h and
> enables generation of its API documentation
> 
> Signed-off-by: Anup K Parikh <parikhanupk.foss@gmail.com>
> ---
>  include/linux/dcache.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/include/linux/dcache.h b/include/linux/dcache.h
> index f5bba5148..ce0b36f72 100644
> --- a/include/linux/dcache.h
> +++ b/include/linux/dcache.h
> @@ -297,7 +297,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

Someone was trying to document both dget() and get_dlock() with the same
kernel-doc comment block.
I suppose that you could duplicate the comments for dget() also.

It would be nice to know the difference(s) in the functions as well.

thanks.
-- 
~Randy
Re: [PATCH] Doc fix for dget_dlock
Posted by Shuah Khan 3 years, 8 months ago
On 8/5/22 10:39 AM, Anup K Parikh wrote:
> Removes the warning for dget_dlock in include/linux/dcache.h and
> enables generation of its API documentation
> 
> Signed-off-by: Anup K Parikh <parikhanupk.foss@gmail.com>
> ---
>   include/linux/dcache.h | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/include/linux/dcache.h b/include/linux/dcache.h
> index f5bba5148..ce0b36f72 100644
> --- a/include/linux/dcache.h
> +++ b/include/linux/dcache.h
> @@ -297,7 +297,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
> 

Please include all the maintainers - run get_maintainers.pl for a
complete list.

thanks,
-- Shuah