diff mbox series

[05/10] docs: fpga: dfl.rst: Fix a couple building issues

Message ID fca8e53692b1e57242e09fc3436cacd1961c8d8b.1610610444.git.mchehab+huawei@kernel.org (mailing list archive)
State Superseded, archived
Headers show
Series Fix documentation warnings at linux-next | expand

Commit Message

Mauro Carvalho Chehab Jan. 14, 2021, 7:53 a.m. UTC
A title markup length is smaller than required;
A literal block is not marked as such.

This fixes the warnings below:

    .../Documentation/fpga/dfl.rst:505: WARNING: Title underline too short.

    Location of DFLs on a PCI Device
    ===========================
    .../Documentation/fpga/dfl.rst:523: WARNING: Unexpected indentation.
    .../Documentation/fpga/dfl.rst:523: WARNING: Blank line required after table.
    .../Documentation/fpga/dfl.rst:524: WARNING: Block quote ends without a blank line; unexpected unindent.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
 Documentation/fpga/dfl.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Tom Rix Jan. 14, 2021, 2:56 p.m. UTC | #1
On 1/13/21 11:53 PM, Mauro Carvalho Chehab wrote:
> A title markup length is smaller than required;
> A literal block is not marked as such.
>
> This fixes the warnings below:
>
>     .../Documentation/fpga/dfl.rst:505: WARNING: Title underline too short.
>
>     Location of DFLs on a PCI Device
>     ===========================
>     .../Documentation/fpga/dfl.rst:523: WARNING: Unexpected indentation.
>     .../Documentation/fpga/dfl.rst:523: WARNING: Blank line required after table.
>     .../Documentation/fpga/dfl.rst:524: WARNING: Block quote ends without a blank line; unexpected unindent.
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Lukas made an earlier change here

https://lore.kernel.org/linux-fpga/alpine.DEB.2.22.394.2101111016480.2457315@rhweight-WRK1/

Tom
diff mbox series

Patch

diff --git a/Documentation/fpga/dfl.rst b/Documentation/fpga/dfl.rst
index ea8cefc18bdb..716a3d705046 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.
@@ -513,7 +513,7 @@  VSEC ID of 0x43 for this purpose.  The vendor specific
 data begins with a 4 byte vendor specific register for the number of DFLs followed 4 byte
 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.
+zero::
 
         +----------------------------+
         |31     Number of DFLS      0|