* linux-next: build warning after merge of the ntb tree
@ 2022-06-21 10:02 Stephen Rothwell
[not found] ` <20220622095345.27121-1-bagasdotme@gmail.com>
0 siblings, 1 reply; 4+ messages in thread
From: Stephen Rothwell @ 2022-06-21 10:02 UTC (permalink / raw)
To: Jon Mason, NTB Mailing List
Cc: Frank Li, Linux Kernel Mailing List, Linux Next Mailing List
[-- Attachment #1: Type: text/plain, Size: 483 bytes --]
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")
--
Cheers,
Stephen Rothwell
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]
^ permalink raw reply [flat|nested] 4+ messages in thread[parent not found: <20220622095345.27121-1-bagasdotme@gmail.com>]
* [PATCH 1/2] Documentation: PCI: Use code-block block for scratchpad registers diagram [not found] ` <20220622095345.27121-1-bagasdotme@gmail.com> @ 2022-06-22 9:53 ` Bagas Sanjaya 2022-06-23 15:37 ` [EXT] " Frank Li 2022-06-22 9:53 ` [PATCH 2/2] Documentation: PCI: extend subheading underline for "lspci output" section Bagas Sanjaya 1 sibling, 1 reply; 4+ messages in thread From: Bagas Sanjaya @ 2022-06-22 9:53 UTC (permalink / raw) To: linux-doc Cc: Bagas Sanjaya, Stephen Rothwell, Kishon Vijay Abraham I, Lorenzo Pieralisi, Krzysztof Wilczyński, Bjorn Helgaas, Jonathan Corbet, Frank Li, Jon Mason, linux-pci, linux-next, linux-kernel 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@canb.auug.org.au> Cc: Kishon Vijay Abraham I <kishon@ti.com> Cc: Lorenzo Pieralisi <lpieralisi@kernel.org> Cc: "Krzysztof Wilczyński" <kw@linux.com> Cc: Bjorn Helgaas <bhelgaas@google.com> Cc: Jonathan Corbet <corbet@lwn.net> Cc: Frank Li <Frank.Li@nxp.com> Cc: Jon Mason <jdmason@kudzu.us> Cc: linux-pci@vger.kernel.org Cc: linux-next@vger.kernel.org Cc: linux-kernel@vger.kernel.org Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.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 ^ permalink raw reply related [flat|nested] 4+ messages in thread
* RE: [EXT] [PATCH 1/2] Documentation: PCI: Use code-block block for scratchpad registers diagram 2022-06-22 9:53 ` [PATCH 1/2] Documentation: PCI: Use code-block block for scratchpad registers diagram Bagas Sanjaya @ 2022-06-23 15:37 ` Frank Li 0 siblings, 0 replies; 4+ messages in thread From: Frank Li @ 2022-06-23 15:37 UTC (permalink / raw) To: Bagas Sanjaya, linux-doc Cc: Stephen Rothwell, Kishon Vijay Abraham I, Lorenzo Pieralisi, Krzysztof Wilczyński, Bjorn Helgaas, Jonathan Corbet, Jon Mason, linux-pci, linux-next, linux-kernel > -----Original Message----- > From: Bagas Sanjaya <bagasdotme@gmail.com> > Sent: Wednesday, June 22, 2022 4:54 AM > To: linux-doc@vger.kernel.org > Cc: Bagas Sanjaya <bagasdotme@gmail.com>; Stephen Rothwell > <sfr@canb.auug.org.au>; Kishon Vijay Abraham I <kishon@ti.com>; Lorenzo > Pieralisi <lpieralisi@kernel.org>; Krzysztof Wilczyński <kw@linux.com>; Bjorn > Helgaas <bhelgaas@google.com>; Jonathan Corbet <corbet@lwn.net>; Frank > Li <frank.li@nxp.com>; Jon Mason <jdmason@kudzu.us>; linux- > pci@vger.kernel.org; linux-next@vger.kernel.org; linux- > kernel@vger.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&data=05 > %7C01%7CFrank.Li%40nxp.com%7C36a0e13e10194fda105b08da543520dc%7 > C686ea1d3bc2b4c6fa92cd99c5c301635%7C0%7C0%7C637914884407847247 > %7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiL > CJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=ZPulixx > LoPG65rjdBPo3heIb%2BFhKK7wnWD4js9i5dPI%3D&reserved=0 > Fixes: 0c4b285d9636cc ("Documentation: PCI: Add specification for the PCI > vNTB function device") > Reported-by: Stephen Rothwell <sfr@canb.auug.org.au> > Cc: Kishon Vijay Abraham I <kishon@ti.com> > Cc: Lorenzo Pieralisi <lpieralisi@kernel.org> > Cc: "Krzysztof Wilczyński" <kw@linux.com> > Cc: Bjorn Helgaas <bhelgaas@google.com> > Cc: Jonathan Corbet <corbet@lwn.net> > Cc: Frank Li <Frank.Li@nxp.com> > Cc: Jon Mason <jdmason@kudzu.us> > Cc: linux-pci@vger.kernel.org > Cc: linux-next@vger.kernel.org > Cc: linux-kernel@vger.kernel.org > Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.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 ^ permalink raw reply [flat|nested] 4+ messages in thread
* [PATCH 2/2] Documentation: PCI: extend subheading underline for "lspci output" section [not found] ` <20220622095345.27121-1-bagasdotme@gmail.com> 2022-06-22 9:53 ` [PATCH 1/2] Documentation: PCI: Use code-block block for scratchpad registers diagram Bagas Sanjaya @ 2022-06-22 9:53 ` Bagas Sanjaya 1 sibling, 0 replies; 4+ messages in thread From: Bagas Sanjaya @ 2022-06-22 9:53 UTC (permalink / raw) To: linux-doc Cc: Bagas Sanjaya, Stephen Rothwell, Kishon Vijay Abraham I, Lorenzo Pieralisi, Krzysztof Wilczyński, Bjorn Helgaas, Jonathan Corbet, Frank Li, Jon Mason, linux-pci, linux-next, linux-kernel 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. 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@canb.auug.org.au> Cc: Kishon Vijay Abraham I <kishon@ti.com> Cc: Lorenzo Pieralisi <lpieralisi@kernel.org> Cc: "Krzysztof Wilczyński" <kw@linux.com> Cc: Bjorn Helgaas <bhelgaas@google.com> Cc: Jonathan Corbet <corbet@lwn.net> Cc: Frank Li <Frank.Li@nxp.com> Cc: Jon Mason <jdmason@kudzu.us> Cc: linux-pci@vger.kernel.org Cc: linux-next@vger.kernel.org Cc: linux-kernel@vger.kernel.org Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com> --- Documentation/PCI/endpoint/pci-vntb-howto.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/PCI/endpoint/pci-vntb-howto.rst b/Documentation/PCI/endpoint/pci-vntb-howto.rst index b4a679144692a8..31a0bae868f996 100644 --- a/Documentation/PCI/endpoint/pci-vntb-howto.rst +++ b/Documentation/PCI/endpoint/pci-vntb-howto.rst @@ -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:: -- An old man doll... just what I always wanted! - Clara ^ permalink raw reply related [flat|nested] 4+ messages in thread
end of thread, other threads:[~2022-06-23 15:37 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-06-21 10:02 linux-next: build warning after merge of the ntb tree Stephen Rothwell
[not found] ` <20220622095345.27121-1-bagasdotme@gmail.com>
2022-06-22 9:53 ` [PATCH 1/2] Documentation: PCI: Use code-block block for scratchpad registers diagram Bagas Sanjaya
2022-06-23 15:37 ` [EXT] " Frank Li
2022-06-22 9:53 ` [PATCH 2/2] Documentation: PCI: extend subheading underline for "lspci output" section Bagas Sanjaya
This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox; as well as URLs for NNTP newsgroup(s).