linux-kernel - [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 for Android: free password hash cracker in your pocket

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

Message-Id: <20220622095345.27121-2-bagasdotme@gmail.com>
Date:   Wed, 22 Jun 2022 16:53:44 +0700
From:   Bagas Sanjaya <bagasdotme@...il.com>
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: [PATCH 1/2] Documentation: PCI: Use code-block block for scratchpad registers diagram

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://lore.kernel.org/linux-next/20220621200235.211b2e32@canb.auug.org.au/
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(-)

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