The patch titled
Subject: fs: add kernel-doc comments to fat_parse_long()
has been added to the -mm mm-nonmm-unstable branch. Its filename is
fs-add-kernel-doc-comments-to-fat_parse_long.patch
This patch will shortly appear at
https://git.kernel.org/pub/scm/linux/kernel/git/akpm/25-new.git/tree/patches/fs-add-kernel-doc-comments-to-fat_parse_long.patch
This patch will later appear in the mm-nonmm-unstable branch at
git://git.kernel.org/pub/scm/linux/kernel/git/akpm/mm
Before you just go and hit "reply", please:
a) Consider who else should be cc'ed
b) Prefer to cc a suitable mailing list as well
c) Ideally: find the original patch on the mailing list and do a
reply-to-all to that, adding suitable additional cc's
*** Remember to use Documentation/process/submit-checklist.rst when testing your code ***
The -mm tree is included into linux-next via the mm-everything
branch at git://git.kernel.org/pub/scm/linux/kernel/git/akpm/mm
and is updated there every 2-3 working days
------------------------------------------------------
From: Yang Li <yang.lee@xxxxxxxxxxxxxxxxx>
Subject: fs: add kernel-doc comments to fat_parse_long()
Date: Fri, 22 Mar 2024 15:37:24 +0800
Add kernel-doc style comments with complete parameter descriptions for
fat_parse_long().
Link: https://lkml.kernel.org/r/20240322073724.102332-1-yang.lee@xxxxxxxxxxxxxxxxx
Signed-off-by: Yang Li <yang.lee@xxxxxxxxxxxxxxxxx>
Acked-by: OGAWA Hirofumi <hirofumi@xxxxxxxxxxxxxxxxxx>
Signed-off-by: Andrew Morton <akpm@xxxxxxxxxxxxxxxxxxxx>
---
fs/fat/dir.c | 12 ++++++++++++
1 file changed, 12 insertions(+)
--- a/fs/fat/dir.c~fs-add-kernel-doc-comments-to-fat_parse_long
+++ a/fs/fat/dir.c
@@ -269,6 +269,18 @@ enum { PARSE_INVALID = 1, PARSE_NOT_LONG
/**
* fat_parse_long - Parse extended directory entry.
*
+ * @dir: Pointer to the inode that represents the directory.
+ * @pos: On input, contains the starting position to read from.
+ * On output, updated with the new position.
+ * @bh: Pointer to the buffer head that may be used for reading directory
+ * entries. May be updated.
+ * @de: On input, points to the current directory entry.
+ * On output, points to the next directory entry.
+ * @unicode: Pointer to a buffer where the parsed Unicode long filename will be
+ * stored.
+ * @nr_slots: Pointer to a variable that will store the number of longname
+ * slots found.
+ *
* This function returns zero on success, negative value on error, or one of
* the following:
*
_
Patches currently in -mm which might be from yang.lee@xxxxxxxxxxxxxxxxx are
fs-add-kernel-doc-comments-to-fat_parse_long.patch
