]> git.ipfire.org Git - thirdparty/linux.git/commitdiff
fs/namei: fix kernel-doc markup for dentry_create
authorJay Winston <jaybenjaminwinston@gmail.com>
Sun, 18 Jan 2026 11:04:01 +0000 (13:04 +0200)
committerChristian Brauner <brauner@kernel.org>
Tue, 20 Jan 2026 13:54:01 +0000 (14:54 +0100)
O_ is interpreted as a broken hyperlink target. Escape _ with a backslash.

The asterisk in "struct file *" is interpreted as an opening emphasis
string that never closes. Replace double quotes with rST backticks.

Change "a ERR_PTR" to "an ERR_PTR".

Signed-off-by: Jay Winston <jaybenjaminwinston@gmail.com>
Link: https://patch.msgid.link/20260118110401.2651-1-jaybenjaminwinston@gmail.com
Reviewed-by: Jan Kara <jack@suse.cz>
Signed-off-by: Christian Brauner <brauner@kernel.org>
fs/namei.c

index aefb21bc0944e393f79834825bf64cc7278ff511..45dd897a03939ce83fdcea921ee8fc09cf6ad132 100644 (file)
@@ -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 an ERR_PTR
  * is returned.
  */
 struct file *dentry_create(struct path *path, int flags, umode_t mode,