linux-kernel - [PATCH] docs/vfs: Fix htmldocs build warning and error

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite for Android: free password hash cracker in your pocket

[<prev] [next>] [day] [month] [year] [list]

Message-ID: <20251231153851.7523-1-krishnagopi487@gmail.com>
Date: Wed, 31 Dec 2025 21:08:49 +0530
From: Gopi Krishna Menon <krishnagopi487@...il.com>
To: viro@...iv.linux.org.uk,
	brauner@...nel.org,
	jack@...e.cz
Cc: Gopi Krishna Menon <krishnagopi487@...il.com>,
	linux-fsdevel@...r.kernel.org,
	linux-kernel@...r.kernel.org
Subject: [PATCH] docs/vfs: Fix htmldocs build warning and error

Running "make htmldocs" generates the following build warning and error
in fs/namei.c:

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]

The error happens due to 'O_' being treated as a named reference by
docutils and the warning happens due to '*' in 'struct file *' being
treated as beginning of emphasis text.

Replace 'O_' with 'O_*' to avoid being treated as a named reference and
reword the return comment to fix the build warning and error.

Signed-off-by: Gopi Krishna Menon <krishnagopi487@...il.com>
---
 fs/namei.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/fs/namei.c b/fs/namei.c
index aefb21bc0944..852fd007187f 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 pointer to struct file. Otherwise a ERR_PTR
  * is returned.
  */
 struct file *dentry_create(struct path *path, int flags, umode_t mode,
-- 
2.51.0