Documentation: netfs: Use inline code for *foliop pointer
Subsystems (4)
PATCH 1/1 Documentation: netfs: Use inline code for *foliop pointer
Sphinx reported inline emphasis warning on netfs:
Documentation/filesystems/netfs_library.rst:384: WARNING: Inline emphasis start-string without end-string. Documentation/filesystems/netfs_library.rst:384: WARNING: Inline emphasis start-string without end-string. Documentation/filesystems/netfs_library:609: ./fs/netfs/buffered_read.c:318: WARNING: Inline emphasis start-string without end-string.
These warnings above are due to unsecaped *foliop, which confuses Sphinx as italics syntax instead.
Use inline code for the pointer.
--- Documentation/filesystems/netfs_library.rst | 6 +++--- fs/netfs/buffered_read.c | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-)
Documentation/filesystems/netfs_library.rst +3 -3
@@ -382,9 +382,9 @@ The operations are as follows: conflicting state before allowing it to be modified. It may unlock and discard the folio it was given and set the caller's folio - pointer to NULL. It should return 0 if everything is now fine (*foliop - left set) or the op should be retried (*foliop cleared) and any other error - code to abort the operation. + pointer to NULL. It should return 0 if everything is now fine (``*foliop`` + left set) or the op should be retried (``*foliop`` cleared) and any other + error code to abort the operation. * ``done``
fs/netfs/buffered_read.c +2 -2
@@ -320,8 +320,8 @@ static bool netfs_skip_folio_read(struct folio *folio, loff_t pos, size_t len,* pointer to the fsdata cookie that gets returned to the VM to be passed to * write_end. It is permitted to sleep. It should return 0 if the request * should go ahead or it may return an error. It may also unlock and put the -* folio, provided it sets *foliop to NULL, in which case a return of 0 will -* cause the folio to be re-got and the process to be retried. +* folio, provided it sets ``*foliop`` to NULL, in which case a return of 0 +* will cause the folio to be re-got and the process to be retried. * * The calling netfs must initialise a netfs context contiguous to the vfs * inode before calling this.
Signature · 1 line
An old man doll... just what I always wanted! - Clara
Quoted 62 lines · Bagas Sanjaya
Sphinx reported inline emphasis warning on netfs:
Documentation/filesystems/netfs_library.rst:384: WARNING: Inline emphasis start-string without end-string.Documentation/filesystems/netfs_library.rst:384: WARNING: Inline emphasis start-string without end-string.Documentation/filesystems/netfs_library:609:./fs/netfs/buffered_read.c:318: WARNING: Inline emphasis start-string without end-string.These warnings above are due to unsecaped *foliop, which confuses Sphinx as italics syntax instead.
Use inline code for the pointer.
Fixes 157be6ddd9e438 ("netfs: do not unlock and put the folio twice")Reported-by kernel test robot <[email protected]>Cc Jonathan Corbet <[email protected]>Cc David Howells <[email protected]>Cc Jeff Layton <[email protected]>Cc "Matthew Wilcox (Oracle)" <[email protected]>Cc Xiubo Li <[email protected]>Cc Ilya Dryomov <[email protected]>Signed-off-by Bagas Sanjaya <[email protected]>--- Documentation/filesystems/netfs_library.rst | 6 +++--- fs/netfs/buffered_read.c | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-)Documentation/filesystems/netfs_library.rst +3
-3@@ -382,9 +382,9 @@ The operations are as follows: conflicting state before allowing it to be modified. It may unlock and discard the folio it was given and set the caller's folio - pointer to NULL. It should return 0 if everything is now fine (*foliop - left set) or the op should be retried (*foliop cleared) and any other error - code to abort the operation. + pointer to NULL. It should return 0 if everything is now fine (``*foliop`` + left set) or the op should be retried (``*foliop`` cleared) and any other + error code to abort the operation. * ``done``fs/netfs/buffered_read.c +2
-3@@ -320,8 +320,8 @@ static bool netfs_skip_folio_read(struct folio *folio, loff_t pos, size_t len,* pointer to the fsdata cookie that gets returned to the VM to be passed to * write_end. It is permitted to sleep. It should return 0 if the request * should go ahead or it may return an error. It may also unlock and put the -* folio, provided it sets *foliop to NULL, in which case a return of 0 will -* cause the folio to be re-got and the process to be retried. +* folio, provided it sets ``*foliop`` to NULL, in which case a return of 0 +* will cause the folio to be re-got and the process to be retried. * * The calling netfs must initialise a netfs context contiguous to the vfs * inode before calling this. --
Quoted 2 lines
An old man doll... just what I always wanted! - Clara
Hi Bagas,
I folded this fixup into the original patch and added your Signed-off-by. I hope you don't mind.
Thanks,
Ilya