[PATCH v3] VFS: d_duplicate: repair comments to avoid kernel-doc warnings

[PATCH v3] VFS: d_duplicate: repair comments to avoid kernel-doc warnings

[Randy Dunlap]

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

Re: [PATCH v3] VFS: d_duplicate: repair comments to avoid kernel-doc warnings

[Jan Kara]

On Wed 30-09-26 19:17:45, Randy Dunlap wrote:
> 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>

Looks good. Feel free to add:

Reviewed-by: Jan Kara <jack@suse.cz>

								Honza

> ---
> 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
-- 
Jan Kara <jack@suse.com>
SUSE Labs, CR