public inbox for linux-fsdevel@vger.kernel.org
 help / color / mirror / Atom feed
From: Al Viro <viro@zeniv.linux.org.uk>
To: Jay Winston <jaybenjaminwinston@gmail.com>
Cc: corbet@lwn.net, brauner@kernel.org, linux-doc@vger.kernel.org,
	linux-fsdevel@vger.kernel.org
Subject: Re: [PATCH] docs: filesystems: escape errant underscore in porting.rst
Date: Sun, 18 Jan 2026 17:35:18 +0000	[thread overview]
Message-ID: <20260118173518.GC3634291@ZenIV> (raw)
In-Reply-To: <20260118131612.21948-1-jaybenjaminwinston@gmail.com>

On Sun, Jan 18, 2026 at 03:16:12PM +0200, Jay Winston wrote:
> filename_...() seems to be literal text whereas Sphinx thinks filename_ is
> a link. Wrap all with double backticks to quiet Sphinx warning and wrap
> do_{...}() as well for consistency.
> 
> Signed-off-by: Jay Winston <jaybenjaminwinston@gmail.com>
> ---
>  Documentation/filesystems/porting.rst | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/Documentation/filesystems/porting.rst b/Documentation/filesystems/porting.rst
> index 8bf09b2ea912..86d722ddd40e 100644
> --- a/Documentation/filesystems/porting.rst
> +++ b/Documentation/filesystems/porting.rst
> @@ -1345,6 +1345,6 @@ implementation should set it to generic_setlease().
>  
>  **mandatory**
>  
> -do_{mkdir,mknod,link,symlink,renameat2,rmdir,unlink}() are gone; filename_...()
> -counterparts replace those.  The difference is that the former used to consume
> -filename references; the latter do not.
> +``do_{mkdir,mknod,link,symlink,renameat2,rmdir,unlink}()`` are gone;
> +``filename_...()`` counterparts replace those.  The difference is that the
> +former used to consume filename references; the latter do not.

FWIW, check the current viro/vfs.git#work.filename; that fragment is now

fs/namei.c primitives that consume filesystem references (do_renameat2(),
do_linkat(), do_symlinkat(), do_mkdirat(), do_mknodat(), do_unlinkat()
and do_rmdir()) are gone; they are replaced with non-consuming analogues
(filename_renameat2(), etc.)
Callers are adjusted - responsibility for dropping the filenames belongs
to them now.


  reply	other threads:[~2026-01-18 17:33 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-01-18 13:16 [PATCH] docs: filesystems: escape errant underscore in porting.rst Jay Winston
2026-01-18 17:35 ` Al Viro [this message]
2026-01-18 18:40   ` Jay Benjamin Winston

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=20260118173518.GC3634291@ZenIV \
    --to=viro@zeniv.linux.org.uk \
    --cc=brauner@kernel.org \
    --cc=corbet@lwn.net \
    --cc=jaybenjaminwinston@gmail.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-fsdevel@vger.kernel.org \
    /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