linux-kernel - RE: [EXT] [PATCH 1/2] Documentation: PCI: Use code-block block for scratchpad registers diagram

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: <PAXPR04MB9186A076FE12F992DAF7E1FD88B59@PAXPR04MB9186.eurprd04.prod.outlook.com>
Date:   Thu, 23 Jun 2022 15:37:51 +0000
From:   Frank Li <frank.li@....com>
To:     Bagas Sanjaya <bagasdotme@...il.com>,
        "linux-doc@...r.kernel.org" <linux-doc@...r.kernel.org>
CC:     Stephen Rothwell <sfr@...b.auug.org.au>,
        Kishon Vijay Abraham I <kishon@...com>,
        Lorenzo Pieralisi <lpieralisi@...nel.org>,
        Krzysztof Wilczyński <kw@...ux.com>,
        Bjorn Helgaas <bhelgaas@...gle.com>,
        Jonathan Corbet <corbet@....net>, Jon Mason <jdmason@...zu.us>,
        "linux-pci@...r.kernel.org" <linux-pci@...r.kernel.org>,
        "linux-next@...r.kernel.org" <linux-next@...r.kernel.org>,
        "linux-kernel@...r.kernel.org" <linux-kernel@...r.kernel.org>
Subject: RE: [EXT] [PATCH 1/2] Documentation: PCI: Use code-block block for
 scratchpad registers diagram



> -----Original Message-----
> From: Bagas Sanjaya <bagasdotme@...il.com>
> Sent: Wednesday, June 22, 2022 4:54 AM
> To: linux-doc@...r.kernel.org
> Cc: Bagas Sanjaya <bagasdotme@...il.com>; Stephen Rothwell
> <sfr@...b.auug.org.au>; Kishon Vijay Abraham I <kishon@...com>; Lorenzo
> Pieralisi <lpieralisi@...nel.org>; Krzysztof Wilczyński <kw@...ux.com>; Bjorn
> Helgaas <bhelgaas@...gle.com>; Jonathan Corbet <corbet@....net>; Frank
> Li <frank.li@....com>; Jon Mason <jdmason@...zu.us>; linux-
> pci@...r.kernel.org; linux-next@...r.kernel.org; linux-
> kernel@...r.kernel.org
> Subject: [EXT] [PATCH 1/2] Documentation: PCI: Use code-block block for
> scratchpad registers diagram
> 
> Caution: EXT Email
> 
> The diagram in "Scratchpad Registers" isn't formatted inside code block,
> hence triggers indentation warning:
> 
> Documentation/PCI/endpoint/pci-vntb-function.rst:82: WARNING:
> Unexpected indentation.
> 
> Fix the warning by using code-block directive to format the diagram
> inside code block, as in other diagrams in Documentation/. While at it,
> unindent the preceeding text.
> 
> Link:
> https://eur01.safelinks.protection.outlook.com/?url=https%3A%2F%2Flore.k
> ernel.org%2Flinux-
> next%2F20220621200235.211b2e32%40canb.auug.org.au%2F&amp;data=05
> %7C01%7CFrank.Li%40nxp.com%7C36a0e13e10194fda105b08da543520dc%7
> C686ea1d3bc2b4c6fa92cd99c5c301635%7C0%7C0%7C637914884407847247
> %7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiL
> CJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&amp;sdata=ZPulixx
> LoPG65rjdBPo3heIb%2BFhKK7wnWD4js9i5dPI%3D&amp;reserved=0
> Fixes: 0c4b285d9636cc ("Documentation: PCI: Add specification for the PCI
> vNTB function device")
> Reported-by: Stephen Rothwell <sfr@...b.auug.org.au>
> Cc: Kishon Vijay Abraham I <kishon@...com>
> Cc: Lorenzo Pieralisi <lpieralisi@...nel.org>
> Cc: "Krzysztof Wilczyński" <kw@...ux.com>
> Cc: Bjorn Helgaas <bhelgaas@...gle.com>
> Cc: Jonathan Corbet <corbet@....net>
> Cc: Frank Li <Frank.Li@....com>
> Cc: Jon Mason <jdmason@...zu.us>
> Cc: linux-pci@...r.kernel.org
> Cc: linux-next@...r.kernel.org
> Cc: linux-kernel@...r.kernel.org
> Signed-off-by: Bagas Sanjaya <bagasdotme@...il.com>
> ---
>  Documentation/PCI/endpoint/pci-vntb-function.rst | 5 ++++-
>  1 file changed, 4 insertions(+), 1 deletion(-)

[Frank Li] Acked. 

> 
> diff --git a/Documentation/PCI/endpoint/pci-vntb-function.rst
> b/Documentation/PCI/endpoint/pci-vntb-function.rst
> index cad8013e88390e..0c51f53ab972a0 100644
> --- a/Documentation/PCI/endpoint/pci-vntb-function.rst
> +++ b/Documentation/PCI/endpoint/pci-vntb-function.rst
> @@ -58,7 +58,10 @@ It is same as PCI NTB Function driver
>  Scratchpad Registers:
>  ---------------------
> 
> -  It is appended after Config region.
> +It is appended after Config region.
> +
> +.. code-block:: text
> +
> 
>    +--------------------------------------------------+ Base
>    |                                                  |
> --
> An old man doll... just what I always wanted! - Clara