linux-fpga.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH -next] fpga: dfl-pci: rectify ReST formatting
@ 2021-01-11 11:21 Lukas Bulwahn
  2021-01-11 15:11 ` Tom Rix
                   ` (2 more replies)
  0 siblings, 3 replies; 12+ messages in thread
From: Lukas Bulwahn @ 2021-01-11 11:21 UTC (permalink / raw)
  To: Greg Kroah-Hartman, Wu Hao, Moritz Fischer, Matthew Gerlach, linux-fpga
  Cc: Tom Rix, linux-doc, kernel-janitors, linux-kernel, Lukas Bulwahn

Commit fa41d10589be ("fpga: dfl-pci: locate DFLs by PCIe vendor specific
capability") provides documentation to the FPGA Device Feature List (DFL)
Framework Overview, but introduced new documentation warnings:

  ./Documentation/fpga/dfl.rst:
    505: WARNING: Title underline too short.
    523: WARNING: Unexpected indentation.
    523: WARNING: Blank line required after table.
    524: WARNING: Block quote ends without a blank line; unexpected unindent.

Rectify ReST formatting in ./Documentation/fpga/dfl.rst.

Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com>
---
applies cleanly on next-20210111

Moritz, Matthew, please ack.

Greg, please pick this doc fixup to your fpga -next tree on top of
the commit above.

 Documentation/fpga/dfl.rst | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/Documentation/fpga/dfl.rst b/Documentation/fpga/dfl.rst
index ea8cefc18bdb..c41ac76ffaae 100644
--- a/Documentation/fpga/dfl.rst
+++ b/Documentation/fpga/dfl.rst
@@ -502,7 +502,7 @@ FME Partial Reconfiguration Sub Feature driver (see drivers/fpga/dfl-fme-pr.c)
 could be a reference.
 
 Location of DFLs on a PCI Device
-===========================
+================================
 The original method for finding a DFL on a PCI device assumed the start of the
 first DFL to offset 0 of bar 0.  If the first node of the DFL is an FME,
 then further DFLs in the port(s) are specified in FME header registers.
@@ -514,6 +514,7 @@ data begins with a 4 byte vendor specific register for the number of DFLs follow
 Offset/BIR vendor specific registers for each DFL. Bits 2:0 of Offset/BIR register
 indicates the BAR, and bits 31:3 form the 8 byte aligned offset where bits 2:0 are
 zero.
+::
 
         +----------------------------+
         |31     Number of DFLS      0|
-- 
2.17.1


^ permalink raw reply related	[flat|nested] 12+ messages in thread

end of thread, other threads:[~2021-01-14 17:06 UTC | newest]

Thread overview: 12+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-01-11 11:21 [PATCH -next] fpga: dfl-pci: rectify ReST formatting Lukas Bulwahn
2021-01-11 15:11 ` Tom Rix
2021-01-11 15:53   ` Greg Kroah-Hartman
2021-01-11 16:07     ` Tom Rix
2021-01-11 15:53 ` Greg Kroah-Hartman
2021-01-11 16:34   ` Lukas Bulwahn
2021-01-11 18:14     ` Greg Kroah-Hartman
2021-01-14 16:45       ` Moritz Fischer
2021-01-14 17:05         ` Greg Kroah-Hartman
2021-01-11 15:55 ` Moritz Fischer
2021-01-11 17:10   ` Lukas Bulwahn
2021-01-11 18:16   ` matthew.gerlach

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