From: Bagas Sanjaya via B4 Relay <devnull+bagasdotme.gmail.com@kernel.org>
To: Alexander Viro <viro@zeniv.linux.org.uk>,
Christian Brauner <brauner@kernel.org>, Jan Kara <jack@suse.cz>,
Benjamin Coddington <bcodding@hammerspace.com>,
Jeff Layton <jlayton@kernel.org>
Cc: linux-fsdevel@vger.kernel.org, linux-kernel@vger.kernel.org,
Stephen Rothwell <sfr@canb.auug.org.au>,
Bagas Sanjaya <bagasdotme@gmail.com>
Subject: [PATCH] VFS: fix dentry_create() kernel-doc comment
Date: Thu, 18 Dec 2025 12:05:00 +0700 [thread overview]
Message-ID: <20251218-dentry-inline-v1-1-0107f4cd8246@gmail.com> (raw)
From: Bagas Sanjaya <bagasdotme@gmail.com>
Sphinx reports htmldocs warnings:
Documentation/filesystems/api-summary:56: fs/namei.c:4952: WARNING: Inline emphasis start-string without end-string. [docutils]
Documentation/filesystems/api-summary:56: fs/namei.c:4942: ERROR: Unknown target name: "o". [docutils]
Fix them by escaping trailing underscore and wildcard.
Fixes: 977de00dfcf87e ("VFS: move dentry_create() from fs/open.c to fs/namei.c")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Closes: https://lore.kernel.org/linux-next/20251216115252.709078e8@canb.auug.org.au/
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
Sphinx reports htmldocs warnings:
Documentation/filesystems/api-summary:56: fs/namei.c:4952: WARNING: Inline emphasis start-string without end-string. [docutils]
Documentation/filesystems/api-summary:56: fs/namei.c:4942: ERROR: Unknown target name: "o". [docutils]
Fix them by escaping trailing underscore and wildcard.
---
fs/namei.c | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/fs/namei.c b/fs/namei.c
index aefb21bc0944e3..d575d671b4f960 100644
--- a/fs/namei.c
+++ b/fs/namei.c
@@ -4939,7 +4939,7 @@ EXPORT_SYMBOL(start_creating_user_path);
/**
* dentry_create - Create and open a file
* @path: path to create
- * @flags: O_ flags
+ * @flags: O\_ flags
* @mode: mode bits for new file
* @cred: credentials to use
*
@@ -4950,7 +4950,7 @@ EXPORT_SYMBOL(start_creating_user_path);
* the new file is to be created. The parent directory and the
* negative dentry must reside on the same filesystem instance.
*
- * On success, returns a "struct file *". Otherwise a ERR_PTR
+ * On success, returns a "struct file \*". Otherwise a ERR_PTR
* is returned.
*/
struct file *dentry_create(struct path *path, int flags, umode_t mode,
---
base-commit: 981be27a72d163610e8e1c342373930bae80ac99
change-id: 20251218-dentry-inline-4091feeae685
Best regards,
--
Bagas Sanjaya <bagasdotme@gmail.com>
next reply other threads:[~2025-12-18 5:05 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-12-18 5:05 Bagas Sanjaya via B4 Relay [this message]
2025-12-18 6:10 ` [PATCH] VFS: fix dentry_create() kernel-doc comment Al Viro
2025-12-18 6:48 ` Bagas Sanjaya
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=20251218-dentry-inline-v1-1-0107f4cd8246@gmail.com \
--to=devnull+bagasdotme.gmail.com@kernel.org \
--cc=bagasdotme@gmail.com \
--cc=bcodding@hammerspace.com \
--cc=brauner@kernel.org \
--cc=jack@suse.cz \
--cc=jlayton@kernel.org \
--cc=linux-fsdevel@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=sfr@canb.auug.org.au \
--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;
as well as URLs for NNTP newsgroup(s).