public inbox for linux-next@vger.kernel.org 
 help / color / mirror / Atom feed
From: Bagas Sanjaya <bagasdotme@gmail•com>
To: linux-doc@vger•kernel.org, linux-next@vger•kernel.org
Cc: Bagas Sanjaya <bagasdotme@gmail•com>,
	kernel test robot <lkp@intel•com>,
	Jonathan Corbet <corbet@lwn•net>,
	David Howells <dhowells@redhat•com>,
	Jeff Layton <jlayton@kernel•org>,
	"Matthew Wilcox (Oracle)" <willy@infradead•org>,
	Xiubo Li <xiubli@redhat•com>, Ilya Dryomov <idryomov@gmail•com>,
	stable@vger•kernel.org, linux-kernel@vger•kernel.org
Subject: [PATCH next] Documentation: netfs: Use inline code for *foliop pointer
Date: Thu, 14 Jul 2022 09:56:49 +0700	[thread overview]
Message-ID: <20220714025649.41871-1-bagasdotme@gmail.com> (raw)

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.

Link: https://lore.kernel.org/linux-doc/202207140742.GTPk4U8i-lkp@intel.com/
Fixes: 157be6ddd9e438 ("netfs: do not unlock and put the folio twice")
Reported-by: kernel test robot <lkp@intel•com>
Cc: Jonathan Corbet <corbet@lwn•net>
Cc: David Howells <dhowells@redhat•com>
Cc: Jeff Layton <jlayton@kernel•org>
Cc: "Matthew Wilcox (Oracle)" <willy@infradead•org>
Cc: Xiubo Li <xiubli@redhat•com>
Cc: Ilya Dryomov <idryomov@gmail•com>
Cc: stable@vger•kernel.org
Cc: linux-kernel@vger•kernel.org
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail•com>
---
 Documentation/filesystems/netfs_library.rst | 6 +++---
 fs/netfs/buffered_read.c                    | 4 ++--
 2 files changed, 5 insertions(+), 5 deletions(-)

diff --git a/Documentation/filesystems/netfs_library.rst b/Documentation/filesystems/netfs_library.rst
index 8d4cf5d5822de4..73a4176144b3b8 100644
--- a/Documentation/filesystems/netfs_library.rst
+++ b/Documentation/filesystems/netfs_library.rst
@@ -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``
 
diff --git a/fs/netfs/buffered_read.c b/fs/netfs/buffered_read.c
index 8fa0725cd64981..0ce53585215106 100644
--- a/fs/netfs/buffered_read.c
+++ b/fs/netfs/buffered_read.c
@@ -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.
-- 
An old man doll... just what I always wanted! - Clara


             reply	other threads:[~2022-07-14  2:56 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-07-14  2:56 Bagas Sanjaya [this message]
2022-07-14  8:20 ` [PATCH next] Documentation: netfs: Use inline code for *foliop pointer Ilya Dryomov

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=20220714025649.41871-1-bagasdotme@gmail.com \
    --to=bagasdotme@gmail$(echo .)com \
    --cc=corbet@lwn$(echo .)net \
    --cc=dhowells@redhat$(echo .)com \
    --cc=idryomov@gmail$(echo .)com \
    --cc=jlayton@kernel$(echo .)org \
    --cc=linux-doc@vger$(echo .)kernel.org \
    --cc=linux-kernel@vger$(echo .)kernel.org \
    --cc=linux-next@vger$(echo .)kernel.org \
    --cc=lkp@intel$(echo .)com \
    --cc=stable@vger$(echo .)kernel.org \
    --cc=willy@infradead$(echo .)org \
    --cc=xiubli@redhat$(echo .)com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html
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