From: "André Almeida" <andrealmeid@igalia.com>
To: Hugh Dickins <hughd@google.com>,
Andrew Morton <akpm@linux-foundation.org>,
Alexander Viro <viro@zeniv.linux.org.uk>,
Christian Brauner <brauner@kernel.org>, Jan Kara <jack@suse.cz>,
krisman@kernel.org, Stephen Rothwell <sfr@canb.auug.org.au>,
Nathan Chancellor <nathan@kernel.org>
Cc: linux-mm@kvack.org, linux-kernel@vger.kernel.org,
linux-fsdevel@vger.kernel.org, kernel-dev@igalia.com,
"Theodore Ts'o" <tytso@mit.edu>,
"André Almeida" <andrealmeid@igalia.com>
Subject: [PATCH 1/3] libfs: Fix kernel-doc warning in generic_ci_validate_strict_name
Date: Thu, 31 Oct 2024 22:37:39 -0300 [thread overview]
Message-ID: <20241101013741.295792-2-andrealmeid@igalia.com> (raw)
In-Reply-To: <20241101013741.295792-1-andrealmeid@igalia.com>
Fix the indentation of the return values from
generic_ci_validate_strict_name() to properly render the comment and to
address a `make htmldocs` warning:
Documentation/filesystems/api-summary:14: include/linux/fs.h:3504:
WARNING: Bullet list ends without a blank line; unexpected unindent.
Fixes: 0e152beb5aa1 ("libfs: Create the helper function generic_ci_validate_strict_name()")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Closes: https://lore.kernel.org/lkml/20241030162435.05425f60@canb.auug.org.au/
Signed-off-by: André Almeida <andrealmeid@igalia.com>
---
include/linux/fs.h | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/include/linux/fs.h b/include/linux/fs.h
index 3b279f60e48f..b562a161e2ee 100644
--- a/include/linux/fs.h
+++ b/include/linux/fs.h
@@ -3499,12 +3499,12 @@ int generic_ci_d_compare(const struct dentry *dentry, unsigned int len,
* @name: name of the new file
*
* Return:
- * * True if the filename is suitable for this directory. It can be
- * true if a given name is not suitable for a strict encoding
- * directory, but the directory being used isn't strict
+ * * True: if the filename is suitable for this directory. It can be
+ * true if a given name is not suitable for a strict encoding
+ * directory, but the directory being used isn't strict
* * False if the filename isn't suitable for this directory. This only
- * happens when a directory is casefolded and the filesystem is strict
- * about its encoding.
+ * happens when a directory is casefolded and the filesystem is strict
+ * about its encoding.
*/
static inline bool generic_ci_validate_strict_name(struct inode *dir, struct qstr *name)
{
--
2.47.0
next prev parent reply other threads:[~2024-11-01 1:38 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-11-01 1:37 [PATCH 0/3] tmpfs: Casefold fixes André Almeida
2024-11-01 1:37 ` André Almeida [this message]
2024-11-01 1:37 ` [PATCH 2/3] tmpfs: Fix type for sysfs' casefold attribute André Almeida
2024-11-01 7:12 ` Nathan Chancellor
2024-11-01 1:37 ` [PATCH 3/3] tmpfs: Initialize sysfs during tmpfs init André Almeida
2024-11-01 7:19 ` Nathan Chancellor
2024-11-01 16:23 ` André Almeida
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=20241101013741.295792-2-andrealmeid@igalia.com \
--to=andrealmeid@igalia.com \
--cc=akpm@linux-foundation.org \
--cc=brauner@kernel.org \
--cc=hughd@google.com \
--cc=jack@suse.cz \
--cc=kernel-dev@igalia.com \
--cc=krisman@kernel.org \
--cc=linux-fsdevel@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-mm@kvack.org \
--cc=nathan@kernel.org \
--cc=sfr@canb.auug.org.au \
--cc=tytso@mit.edu \
--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