Separate the kernel-doc notation for dget() and dget_dlock() to prevent a kernel-doc warning: include/linux/dcache.h:312: warning: expecting prototype for dget, dget_dlock(). Prototype was for dget_dlock() instead There have been several previous attempts to clean up these kernel-doc warnings: a. https://lore.kernel.org/lkml/20190327051717.23225-14-tobin@xxxxxxxxxx/ b. https://lore.kernel.org/all/eec6afad98dddc2eef10a5c98a074a07aba50787.1657360984.git.mchehab@xxxxxxxxxx/ c. https://lore.kernel.org/all/9d2676a83ebee327b97b82f3c2ab76a2e53756d1.1660829433.git.mchehab@xxxxxxxxxx/ d. https://lore.kernel.org/all/Yvde4NryqBnZesTI@autolfshost/ e. https://lore.kernel.org/all/20230926163631.116405-1-n2h9z4@xxxxxxxxx/ Parts of this patch are from Anup's v3 patch [d]. Fixes: dc0474be3e27 ("fs: dcache rationalise dget variants") Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx> Cc: Alexander Viro <viro@xxxxxxxxxxxxxxxxxx> Cc: Christian Brauner <brauner@xxxxxxxxxx> Cc: Nicholas Piggin <npiggin@xxxxxxxxx> Cc: Andrew Morton <akpm@xxxxxxxxxxxxxxxxxxxx> Cc: linux-fsdevel@xxxxxxxxxxxxxxx Cc: Tobin C. Harding <tobin@xxxxxxxxxx> Cc: Mauro Carvalho Chehab <mchehab@xxxxxxxxxx> Cc: Nik Bune <n2h9z4@xxxxxxxxx> Suggested-by: Anup K Parikh <parikhanupk.foss@xxxxxxxxx> --- include/linux/dcache.h | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff -- a/include/linux/dcache.h b/include/linux/dcache.h --- a/include/linux/dcache.h +++ b/include/linux/dcache.h @@ -301,12 +301,15 @@ extern char *dentry_path(const struct de /* 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 - * if appropriate and return the dentry. A dentry will not be + * 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) { @@ -315,6 +318,17 @@ static inline struct dentry *dget_dlock( 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)
