Skip to contentSkip to conversation

linux-next: build warning after merge of the ntb tree

PATCH In review Stephen Rothwell 4 participants 6 messages Jun 21, 2022 – Aug 12, 2022

Subsystems (4)
lore
Share & tools
lore
#0 lore raw

Hi all,

After merging the ntb tree, today's linux-next build (htmldocs) produced this warning:

Documentation/PCI/endpoint/pci-vntb-function.rst:82: WARNING: Unexpected indentation. Documentation/PCI/endpoint/pci-vntb-howto.rst:131: WARNING: Title underline too short.

lspci Output at Host side
------------------------

Introduced by commit

0c4b285d9636 ("Documentation: PCI: Add specification for the PCI vNTB function device")

Signature · 2 lines
Cheers,
Stephen Rothwell
#1 lore raw

cover Documentation: PCI: Documentation fixes for vNTB

After merging ntb tree for linux-next integration testing, Stephen Rothwell reported following htmldocs warnings:

Documentation/PCI/endpoint/pci-vntb-function.rst:82: WARNING: Unexpected indentation. Documentation/PCI/endpoint/pci-vntb-howto.rst:131: WARNING: Title underline too short.

These warnings are introduced by commit 0c4b285d9636cc ("Documentation: PCI:
Add specification for the PCI vNTB function device").

Fix these two warnings above by:
1. Using code block for scratchpad diagram ([1/2])
2. Extending "lspci output" subheading underline syntax ([2/2])

This patchset is based on next-20220622.

Bagas Sanjaya (2):
Documentation: PCI: Use code-block block for scratchpad registers
diagram
Documentation: PCI: extend subheading underline for "lspci output"
section

 Documentation/PCI/endpoint/pci-vntb-function.rst | 5 ++++-
 Documentation/PCI/endpoint/pci-vntb-howto.rst    | 2 +-
 2 files changed, 5 insertions(+), 2 deletions(-)

base-commit: ac0ba5454ca85162c08dc429fef1999e077ca976

Signature · 1 line
An old man doll... just what I always wanted! - Clara
#2 lore raw

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.

Fixes 0c4b285d9636cc ("Documentation: PCI: Add specification for the PCI vNTB function device")
Cc Kishon Vijay Abraham I <[email protected]>
Cc Lorenzo Pieralisi <[email protected]>
Cc "Krzysztof Wilczyński" <[email protected]>
Cc Bjorn Helgaas <[email protected]>
Cc Jonathan Corbet <[email protected]>
Cc Frank Li <[email protected]>
Cc Jon Mason <[email protected]>
---
 Documentation/PCI/endpoint/pci-vntb-function.rst | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)
Documentation/PCI/endpoint/pci-vntb-function.rst +4 -1
index cad8013e88390e..0c51f53ab972a0 100644
@@ -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
   |                                                  |
Signature · 1 line
An old man doll... just what I always wanted! - Clara
#3 lore raw

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

Quoted 51 lines

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

Cc Kishon Vijay Abraham I <[email protected]>
Cc Lorenzo Pieralisi <[email protected]>
Cc "Krzysztof Wilczyński" <[email protected]>
Cc Bjorn Helgaas <[email protected]>
Cc Jonathan Corbet <[email protected]>
Cc Frank Li <[email protected]>
Cc Jon Mason <[email protected]>
Quoted 3 lines
---
 Documentation/PCI/endpoint/pci-vntb-function.rst | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

[Frank Li] Acked.

Quoted 20 lines
Documentation/PCI/endpoint/pci-vntb-function.rst +4 -2
index cad8013e88390e..0c51f53ab972a0 100644
@@ -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

#4 lore raw

PATCH 2/2 Documentation: PCI: extend subheading underline for "lspci output" section

In reply to Bagas Sanjaya

The underline syntax for "lspci output..." section is off-by-one less than the section heading's length, hence triggers the warning:

Documentation/PCI/endpoint/pci-vntb-howto.rst:131: WARNING: Title underline too short.

Extend the underline by one to match the heading length.

Fixes 0c4b285d9636cc ("Documentation: PCI: Add specification for the PCI vNTB function device")
Cc Kishon Vijay Abraham I <[email protected]>
Cc Lorenzo Pieralisi <[email protected]>
Cc "Krzysztof Wilczyński" <[email protected]>
Cc Bjorn Helgaas <[email protected]>
Cc Jonathan Corbet <[email protected]>
Cc Frank Li <[email protected]>
Cc Jon Mason <[email protected]>
---
 Documentation/PCI/endpoint/pci-vntb-howto.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/PCI/endpoint/pci-vntb-howto.rst +1 -1
index b4a679144692a8..31a0bae868f996 100644
@@ -128,7 +128,7 @@ RootComplex Device
 ==================
 
 lspci Output at Host side
-------------------------
+-------------------------
 
 Note that the devices listed here correspond to the values populated in
 "Creating pci-epf-ntb Device" section above::
Signature · 1 line
An old man doll... just what I always wanted! - Clara
#5 lore raw

Re: [PATCH 0/2] Documentation: PCI: Documentation fixes for vNTB

In reply to Bagas Sanjaya
Quoted 21 lines · Bagas Sanjaya

After merging ntb tree for linux-next integration testing, Stephen Rothwell reported following htmldocs warnings:

Documentation/PCI/endpoint/pci-vntb-function.rst:82: WARNING: Unexpected indentation. Documentation/PCI/endpoint/pci-vntb-howto.rst:131: WARNING: Title underline too short.

These warnings are introduced by commit 0c4b285d9636cc ("Documentation: PCI:
Add specification for the PCI vNTB function device").

Fix these two warnings above by:
1. Using code block for scratchpad diagram ([1/2])
2. Extending "lspci output" subheading underline syntax ([2/2])

This patchset is based on next-20220622.

Bagas Sanjaya (2):
Documentation: PCI: Use code-block block for scratchpad registers
diagram
Documentation: PCI: extend subheading underline for "lspci output"
section

Quoted 9 lines
 Documentation/PCI/endpoint/pci-vntb-function.rst | 5 ++++-
 Documentation/PCI/endpoint/pci-vntb-howto.rst    | 2 +-
 2 files changed, 5 insertions(+), 2 deletions(-)

base-commit: ac0ba5454ca85162c08dc429fef1999e077ca976

Signature · 1 line
An old man doll... just what I always wanted! - Clara

Sorry for the extremely long delay in response. This series is in my ntb branch and will be in my pull request for v5.20 which should be going out later today.

Thanks,
Jon