docs: filesystems: escape errant underscore in porting.rst
Subsystems (2)
PATCH 1/1 docs: filesystems: escape errant underscore in porting.rst
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.
--- Documentation/filesystems/porting.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)
Documentation/filesystems/porting.rst +3 -3
@@ -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.
Signature · 1 line
2.46.4
Al Viro
maintainerQuoted 14 lines · 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 <[email protected]>--- Documentation/filesystems/porting.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)Documentation/filesystems/porting.rst +0
-0
Documentation/filesystems/porting.rst implementation should set it to generic_setlease(). · line 1350
Quoted 9 lines
Documentation/filesystems/porting.rst +3
-3@@ -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.
Quoted 29 lines · Al Viro
Quoted 15 lines · 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 <[email protected]>--- Documentation/filesystems/porting.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)Documentation/filesystems/porting.rst +0
-0Documentation/filesystems/porting.rst implementation should set it to generic_setlease(). · line 1350
Quoted 10 lines
Documentation/filesystems/porting.rst +3
-3@@ -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
Quoted 6 lines
fs/namei.cprimitives that consume filesystem references (do_renameat2(),do_linkat(),do_symlinkat(),do_mkdirat(),do_mknodat(),do_unlinkat()anddo_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!