mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Gopi Krishna Menon <krishnagopi487@gmail.com>
To: viro@zeniv.linux.org.uk, brauner@kernel.org, jack@suse.cz
Cc: Gopi Krishna Menon <krishnagopi487@gmail.com>,
	linux-fsdevel@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: [PATCH] docs/vfs: Fix htmldocs build warning and error
Date: Wed, 31 Dec 2025 21:08:49 +0530	[thread overview]
Message-ID: <20251231153851.7523-1-krishnagopi487@gmail.com> (raw)

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@gmail.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


                 reply	other threads:[~2025-12-31 15:38 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

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=20251231153851.7523-1-krishnagopi487@gmail.com \
    --to=krishnagopi487@gmail.com \
    --cc=brauner@kernel.org \
    --cc=jack@suse.cz \
    --cc=linux-fsdevel@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --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

all inboxes | Powered by JetHome®