linux-kernel - Re: [PATCH next] Documentation: netfs: Use inline code for *foliop pointer

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <CAOi1vP__iYzy85CJtxP3qWAKt1OxoLWe3GQPNKwUJ3pmLpRYgg@mail.gmail.com>
Date:   Thu, 14 Jul 2022 10:20:03 +0200
From:   Ilya Dryomov <idryomov@...il.com>
To:     Bagas Sanjaya <bagasdotme@...il.com>
Cc:     Linux Documentation List <linux-doc@...r.kernel.org>,
        linux-next <linux-next@...r.kernel.org>,
        kernel test robot <lkp@...el.com>,
        Jonathan Corbet <corbet@....net>,
        David Howells <dhowells@...hat.com>,
        Jeff Layton <jlayton@...nel.org>,
        "Matthew Wilcox (Oracle)" <willy@...radead.org>,
        Xiubo Li <xiubli@...hat.com>, stable@...r.kernel.org,
        LKML <linux-kernel@...r.kernel.org>
Subject: Re: [PATCH next] Documentation: netfs: Use inline code for *foliop pointer

On Thu, Jul 14, 2022 at 4:56 AM Bagas Sanjaya <bagasdotme@...il.com> wrote:
>
> 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@...el.com>
> Cc: Jonathan Corbet <corbet@....net>
> Cc: David Howells <dhowells@...hat.com>
> Cc: Jeff Layton <jlayton@...nel.org>
> Cc: "Matthew Wilcox (Oracle)" <willy@...radead.org>
> Cc: Xiubo Li <xiubli@...hat.com>
> Cc: Ilya Dryomov <idryomov@...il.com>
> Cc: stable@...r.kernel.org
> Cc: linux-kernel@...r.kernel.org
> Signed-off-by: Bagas Sanjaya <bagasdotme@...il.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
>

Hi Bagas,

I folded this fixup into the original patch and added your
Signed-off-by.  I hope you don't mind.

Thanks,

                Ilya