Doc fix for dget_dlock
PATCH 1/1 Doc fix for dget_dlock
Removes the warning for dget_dlock in include/linux/dcache.h and enables generation of its API documentation
--- include/linux/dcache.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
include/linux/dcache.h +1 -1
@@ -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
Signature · 1 line
2.35.1
Quoted 14 lines · Anup K Parikh
Removes the warning for
dget_dlockininclude/linux/dcache.hand enables generation of its API documentationSigned-off-by Anup K Parikh <[email protected]>--- include/linux/dcache.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)include/linux/dcache.h +0
-0
include/linux/dcache.h extern char *dentry_path(const struct dentry *, char *, int); · line 303
Quoted 8 lines
include/linux/dcache.h +1
-1@@ -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
Hi--
Quoted 13 lines · Anup K Parikh
Removes the warning for
dget_dlockininclude/linux/dcache.hand enables generation of its API documentationSigned-off-by Anup K Parikh <[email protected]>--- include/linux/dcache.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)include/linux/dcache.h +0
-0
include/linux/dcache.h extern char *dentry_path(const struct dentry *, char *, int); · line 303
Quoted 8 lines
include/linux/dcache.h +1
-1@@ -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.
Signature · 1 line
~Randy
A message that is not in the archive (sent off-list or not yet received): CAH6MFJGuHptQ8peBb8myLR8fgtLtAXwvUePcs7dbzYszF9Yyyw@mail.gmail.com
Hi--
Quoted 8 lines · Anup Parikh
Hello Mr. Randy Dunlap,
I checked
include/linux/dcache.h(dget()anddget_dlock()),include/linux/lockref.handlinux/lib/lockref.c.
My current knowledge is limited but I think:
1)dget_dlock()directly increments the count variable without any atomicity guards.
2)dget()does the same but with atomicity guarantee - even across multiple-cores on a multi-core system (according to https://stackoverflow.com/questions/36964478/understanding-synchronization-with-multiple-processors <https://stackoverflow.com/questions/36964478/understanding-synchronization-with-multiple-processors> and code inlinux/lib/lockref.c).Please let me know if I should write the corresponding documentation and send a new patch.
Yes, please.
Thanks.
Quoted 41 lines
Thanks and Regards,
Anup K Parikh.On Tue, Aug 9, 2022 at 11:58 PM Randy Dunlap <[email protected] <mailto:[email protected]>> wrote:
Hi--
On 8/5/22 09:39, Anup K Parikh wrote:
> Removes the warning fordget_dlockininclude/linux/dcache.hand
> enables generation of its API documentation
>
> Signed-off-by: Anup K Parikh <[email protected] <mailto:[email protected]>> > ---
>include/linux/dcache.h| 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --gita/include/linux/dcache.hb/include/linux/dcache.h
> indexf5bba5148..ce0b36f72100644
> ---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 countSomeone was trying to document both
dget()andget_dlock()with the same kernel-doc comment block.
I suppose that you could duplicate the comments fordget()also.It would be nice to know the difference(s) in the functions as well.
thanks.
--
~Randy
Signature · 1 line
~Randy
Quoted 10 lines · Randy Dunlap
Hi--
Quoted 7 lines · Anup Parikh
Hello Mr. Randy Dunlap,
I checked
include/linux/dcache.h(dget()anddget_dlock()),include/linux/lockref.handlinux/lib/lockref.c.
My current knowledge is limited but I think:
1)dget_dlock()directly increments the count variable without any atomicity guards.
2)dget()does the same but with atomicity guarantee - even across multiple-cores on a multi-core system (according to https://stackoverflow.com/questions/36964478/understanding-synchronization-with-multiple-processors <https://stackoverflow.com/questions/36964478/understanding-synchronization-with-multiple-processors> and code inlinux/lib/lockref.c).
Quoted 4 lines
Quoted 1 line
Please let me know if I should write the corresponding documentation and send a new patch.
Yes, please.
Thanks.
also send the patch to [email protected] since it touches filesystem code.
Quoted 43 lines
Quoted 42 lines
Thanks and Regards,
Anup K Parikh.On Tue, Aug 9, 2022 at 11:58 PM Randy Dunlap <[email protected] <mailto:[email protected]>> wrote:
Hi--
On 8/5/22 09:39, Anup K Parikh wrote:
> Removes the warning fordget_dlockininclude/linux/dcache.hand
> enables generation of its API documentation
>
> Signed-off-by: Anup K Parikh <[email protected] <mailto:[email protected]>> > ---
>include/linux/dcache.h| 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --gita/include/linux/dcache.hb/include/linux/dcache.h
> indexf5bba5148..ce0b36f72100644
> ---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 countSomeone was trying to document both
dget()andget_dlock()with the same kernel-doc comment block.
I suppose that you could duplicate the comments fordget()also.It would be nice to know the difference(s) in the functions as well.
thanks.
--
~Randy
Signature · 1 line
~Randy