[PATCH] docs: filesystems: escape errant underscore in porting.rst

[PATCH] docs: filesystems: escape errant underscore in porting.rst

[Jay Winston]

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.
-- 
2.46.4

Re: [PATCH] docs: filesystems: escape errant underscore in porting.rst

[Al Viro]

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.

Re: [PATCH] docs: filesystems: escape errant underscore in porting.rst

[Jay Benjamin Winston]

Al Viro <viro@zeniv.linux.org.uk> writes:

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

Got it, I see that now. Thanks!