Re: [PATCH] fs/namei: fix kernel-doc markup for dentry_create

Jan Kara
2026-01-19T08:47:16Z

On Sun 18-01-26 13:04:01, Jay Winston wrote:
> 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>

Looks good. Feel free to add:

Reviewed-by: Jan Kara <jack@suse.cz>

Honza

> ---
> fs/namei.c | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/fs/namei.c b/fs/namei.c
> index b19890758646..f511288af463 100644
> --- a/fs/namei.c
> +++ b/fs/namei.c
> @@ -4975,7 +4975,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
> *
> @@ -4986,7 +4986,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,
> --
> 2.46.4
>
--
Jan Kara <jack@suse.com>
SUSE Labs, CR