From: Randy Dunlap <rdunlap@infradead.org>
To: linux-kernel@vger.kernel.org
Cc: Randy Dunlap <rdunlap@infradead.org>, NeilBrown <neil@brown.name>,
Alexander Viro <viro@zeniv.linux.org.uk>,
Christian Brauner <brauner@kernel.org>, Jan Kara <jack@suse.cz>,
linux-fsdevel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
Shuah Khan <skhan@linuxfoundation.org>,
linux-doc@vger.kernel.org
Subject: [PATCH v3] VFS: d_duplicate: repair comments to avoid kernel-doc warnings
Date: Wed, 30 Sep 2026 19:17:45 -0700 [thread overview]
Message-ID: <20261001021745.2160005-1-rdunlap@infradead.org> (raw)
Use a typical list style for comments to prevent kernel-doc warnings:
Documentation/filesystems/api-summary:20: ../fs/dcache.c:2029: ERROR: Unexpected indentation. [docutils]
Documentation/filesystems/api-summary:20: ../fs/dcache.c:2030: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]
Also, modify the spelling of "whiteout" to match all other uses in
the kernel source tree and to be consistent on the same line.
Fixes: 33d76519f0cc ("VFS: add d_duplicate()")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
v3: use one colon for the list, not "::" for a literal block (Neil).
Add linux-doc etc. to Cc: list.
v2: dropped Jan's Reviewed-by since the patch changed.
Cc: NeilBrown <neil@brown.name>
Cc: Alexander Viro <viro@zeniv.linux.org.uk>
Cc: Christian Brauner <brauner@kernel.org>
Cc: Jan Kara <jack@suse.cz>
Cc: linux-fsdevel@vger.kernel.org
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Shuah Khan <skhan@linuxfoundation.org>
Cc: linux-doc@vger.kernel.org
fs/dcache.c | 11 ++++++-----
1 file changed, 6 insertions(+), 5 deletions(-)
--- linux-next-20260930.orig/fs/dcache.c
+++ linux-next-20260930/fs/dcache.c
@@ -2025,11 +2025,12 @@ EXPORT_SYMBOL(d_alloc);
* @dentry: the dentry to duplicate
*
* Some rename operations need to be combined with another operation
- * inside the filesystem.
- * 1/ A cluster filesystem when renaming to an in-use file might need to
- * first "silly-rename" that target out of the way before the main rename
- * 2/ A filesystem that supports white-out might want to create a whiteout
- * in place of the file being moved.
+ * inside the filesystem:
+ *
+ * 1. A cluster filesystem when renaming to an in-use file might need to
+ * first "silly-rename" that target out of the way before the main rename
+ * 2. A filesystem that supports whiteout might want to create a whiteout
+ * in place of the file being moved.
*
* For this they need two dentries which temporarily have the same name,
* before one is renamed. d_duplicate() provides for this. Given a
next reply other threads:[~2026-10-01 2:17 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-10-01 2:17 Randy Dunlap [this message]
2026-10-01 8:50 ` [PATCH v3] VFS: d_duplicate: repair comments to avoid kernel-doc warnings Jan Kara
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20261001021745.2160005-1-rdunlap@infradead.org \
--to=rdunlap@infradead.org \
--cc=brauner@kernel.org \
--cc=corbet@lwn.net \
--cc=jack@suse.cz \
--cc=linux-doc@vger.kernel.org \
--cc=linux-fsdevel@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=neil@brown.name \
--cc=skhan@linuxfoundation.org \
--cc=viro@zeniv.linux.org.uk \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox