[1/2] Documentation: PCI: Use code-block block for scratchpad registers diagram

Commit Message

Bagas Sanjaya June 22, 2022, 9:53 a.m. UTC

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/[e-mail]/
Fixes: 0c4b285d9636cc ("Documentation: PCI: Add specification for the PCI vNTB function device")
Reported-by: Stephen Rothwell <[e-mail]>
Cc: Kishon Vijay Abraham I <[e-mail]>
Cc: Lorenzo Pieralisi <[e-mail]>
Cc: "Krzysztof Wilczyński" <[e-mail]>
Cc: Bjorn Helgaas <[e-mail]>
Cc: Jonathan Corbet <[e-mail]>
Cc: Frank Li <[e-mail]>
Cc: Jon Mason <[e-mail]>
Cc: [e-mail]
Cc: [e-mail]
Cc: [e-mail]
Signed-off-by: Bagas Sanjaya <[e-mail]>
---
 Documentation/PCI/endpoint/pci-vntb-function.rst | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

Comments

Frank Li June 23, 2022, 3:37 p.m. UTC | #1

> -----Original Message-----
> From: Bagas Sanjaya <[e-mail]>
> Sent: Wednesday, June 22, 2022 4:54 AM
> To: [e-mail]
> Cc: Bagas Sanjaya <[e-mail]>; Stephen Rothwell
> <[e-mail]>; Kishon Vijay Abraham I <[e-mail]>; Lorenzo
> Pieralisi <[e-mail]>; Krzysztof Wilczyński <[e-mail]>; Bjorn
> Helgaas <[e-mail]>; Jonathan Corbet <[e-mail]>; Frank
> Li <[e-mail]>; Jon Mason <[e-mail]>; linux-
> [e-mail]; [e-mail]; linux-
> [e-mail]
> 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 <[e-mail]>
> Cc: Kishon Vijay Abraham I <[e-mail]>
> Cc: Lorenzo Pieralisi <[e-mail]>
> Cc: "Krzysztof Wilczyński" <[e-mail]>
> Cc: Bjorn Helgaas <[e-mail]>
> Cc: Jonathan Corbet <[e-mail]>
> Cc: Frank Li <[e-mail]>
> Cc: Jon Mason <[e-mail]>
> Cc: [e-mail]
> Cc: [e-mail]
> Cc: [e-mail]
> Signed-off-by: Bagas Sanjaya <[e-mail]>
> ---
>  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

Patch

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
   |                                                  |