Re: [PATCH] Doc fix for dget_dlock and dget

[Anup Parikh <parikhanupk.foss@gmail.com>]

Hello Mr. Randy Dunlap,

I sent the patch as suggested. Thanks.

Regards,
Anup K Parikh.

On Sat, Aug 13, 2022 at 7:14 AM Randy Dunlap <rdunlap@infradead.org> wrote:
>
> Hi--
>
> On 8/12/22 02:47, Anup K Parikh wrote:
> > 1. Remove a warning for dget_dlock
> >
> > 2. Add a similar comment for dget and
> >    add difference between dget and dget_dlock
> >    as suggested by Mr. Randy Dunlap
> >
> > Signed-off-by: Anup K Parikh <parikhanupk.foss@gmail.com>
>
> Is Shuah going to merge this patch? I wouldn't expect that,
> so please see Documentation/process/submitting-patches.rst:
> "Select the recipients for your patch" and send the patch to
> the appropriate maintainer(s) as well as the linux-fsdevel
> mailing list.
>
> Thanks.
>
> > ---
> >  include/linux/dcache.h | 24 +++++++++++++++++++-----
> >  1 file changed, 19 insertions(+), 5 deletions(-)
> >
> > diff --git a/include/linux/dcache.h b/include/linux/dcache.h
> > index f5bba5148..c7742006a 100644
> > --- a/include/linux/dcache.h
> > +++ b/include/linux/dcache.h
> > @@ -297,12 +297,15 @@ extern char *dentry_path(const struct dentry *, char *, int);
> >  /* Allocation counts.. */
> >
> >  /**
> > - *   dget, dget_dlock -      get a reference to a dentry
> > - *   @dentry: dentry to get a reference to
> > + * 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
> > - *   if appropriate and return the dentry. A dentry will not be
> > - *   destroyed when it has references.
> > + * 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.
> > + *
> > + * The reference count increment in this function is not atomic.
> > + * Consider dget() if atomicity is required.
> >   */
> >  static inline struct dentry *dget_dlock(struct dentry *dentry)
> >  {
> > @@ -311,6 +314,17 @@ 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.
> > + *
> > + * This function atomically increments the reference count.
> > + * Consider dget_dlock() if atomicity is not required or manually managed.
> > + */
> >  static inline struct dentry *dget(struct dentry *dentry)
> >  {
> >       if (dentry)
>
> --
> ~Randy