fpga: dfl-pci: rectify ReST formatting
Subsystems (4)
PATCH 1/1 fpga: dfl-pci: rectify ReST formatting
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.
---
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(-)
Documentation/fpga/dfl.rst +1 -1
@@ -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|
Signature · 1 line
2.17.1
Tom Rix
reviewerQuoted 11 lines · 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.
Can you explain how to reproduce this problem ?
Tom
Quoted 33 lines
Signed-off-by Lukas Bulwahn <[email protected]>---
applies cleanly on next-20210111Moritz, 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(-)Documentation/fpga/dfl.rst +1
-1@@ -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|
Quoted 12 lines · Tom Rix
Quoted 10 lines · 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.
Quoted 3 lines
Quoted 1 line
Rectify ReST formatting in
./Documentation/fpga/dfl.rst.Can you explain how to reproduce this problem ?
'make htmldocs'
Quoted 12 lines · Greg Kroah-Hartman
Quoted 11 lines · Tom Rix
Quoted 10 lines · 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.
Quoted 3 lines
Quoted 2 lines
Quoted 1 line
Rectify ReST formatting in
./Documentation/fpga/dfl.rst.Can you explain how to reproduce this problem ?
'make htmldocs'
Thanks, I have verified the problem and its resolution.
Quoted 1 line
Quoted 10 lines · 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.
Quoted 3 lines
Rectify ReST formatting in
./Documentation/fpga/dfl.rst.Signed-off-by Lukas Bulwahn <[email protected]>
You forgot a Reported-by: tag for the person who notified you of this :(
Quoted 12 lines · Greg Kroah-Hartman
Quoted 10 lines · 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.
Quoted 6 lines
Quoted 3 lines
Rectify ReST formatting in
./Documentation/fpga/dfl.rst.Signed-off-by Lukas Bulwahn <[email protected]>You forgot a Reported-by: tag for the person who notified you of this :(
Greg, would you believe that I run 'make htmldocs' on linux-next myself?
Of course, Stephen Rothwell reports such documentation warnings as well, but I take care independent of Stephen's reporting.
Lukas
Quoted 14 lines · Lukas Bulwahn
Quoted 12 lines · Greg Kroah-Hartman
Quoted 10 lines · 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.
Quoted 8 lines
Quoted 6 lines
Quoted 3 lines
Rectify ReST formatting in
./Documentation/fpga/dfl.rst.Signed-off-by Lukas Bulwahn <[email protected]>You forgot a Reported-by: tag for the person who notified you of this :(
Greg, would you believe that I run 'make htmldocs' on linux-next myself?
Sure, just seemed to match up with when Stephen reported this a few hours earlier...
thanks,
greg k-h
Moritz Fischer
maintainerHi Greg,
Quoted 22 lines · Greg Kroah-Hartman
Quoted 21 lines · Lukas Bulwahn
Quoted 18 lines · Greg Kroah-Hartman
Quoted 10 lines · 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.Quoted 3 lines
Rectify ReST formatting in
./Documentation/fpga/dfl.rst.Signed-off-by Lukas Bulwahn <[email protected]>You forgot a Reported-by: tag for the person who notified you of this :(
Quoted 8 lines
Quoted 1 line
Greg, would you believe that I run 'make htmldocs' on linux-next myself?
Sure, just seemed to match up with when Stephen reported this a few hours earlier...
thanks,
greg k-h
Are you waiting for a resend on this? Just asking because we got three versions of this patch by now :)
I haven't re-sent this since you were already on the thread.
- Moritz
Quoted 30 lines · Moritz Fischer
Hi Greg,
Quoted 27 lines · Greg Kroah-Hartman
Quoted 14 lines · Lukas Bulwahn
Quoted 12 lines · Greg Kroah-Hartman
Quoted 10 lines · 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.Quoted 8 lines
Quoted 6 lines
Quoted 3 lines
Rectify ReST formatting in
./Documentation/fpga/dfl.rst.Signed-off-by Lukas Bulwahn <[email protected]>You forgot a Reported-by: tag for the person who notified you of this :(
Greg, would you believe that I run 'make htmldocs' on linux-next myself?
Sure, just seemed to match up with when Stephen reported this a few hours earlier...
Quoted 8 lines
Quoted 3 lines
thanks,
greg k-h
Are you waiting for a resend on this? Just asking because we got three versions of this patch by now :)
I haven't re-sent this since you were already on the thread.
I'll just take this one, for some reason I thought Lukas was going to resend, my fault...
greg k-h
Hi Lukas,
Quoted 2 lines · Lukas Bulwahn
Commit
fa41d10589be("fpga: dfl-pci: locate DFLs by PCIe vendor specific capability") provides documentation to the FPGA Device Feature List (DFL)
Nit: Do you want to make this a Fixes: tag instead?
Quoted 11 lines
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 <[email protected]>
Quoted 34 lines
---
applies cleanly on next-20210111Moritz, 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(-)Documentation/fpga/dfl.rst +1
-1@@ -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|Signature · 1 line
2.17.1
Thanks for doing this, I was about to send that same patch myself.
- Moritz
Quoted 7 lines · Moritz Fischer
Hi Lukas,
Quoted 2 lines · Lukas Bulwahn
Commit
fa41d10589be("fpga: dfl-pci: locate DFLs by PCIe vendor specific capability") provides documentation to the FPGA Device Feature List (DFL)Nit: Do you want to make this a Fixes: tag instead?
IMHO, it is just adjusting the mark-up of the documentation and that does not deserve a Fixes: tag.
Also, in the past, I got more frequent rejections when adding Fixes:
tags for such patches compared to proposals adding a Fixes: tag. So, I settled for not adding Fixes: tags for such minor adjustment patches.
Lukas
Quoted 50 lines
Quoted 11 lines
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 <[email protected]>Acked-by Moritz Fischer <[email protected]>Quoted 32 lines
---
applies cleanly on next-20210111Moritz, 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(-)Documentation/fpga/dfl.rst +1
-2@@ -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| --Quoted 2 lines
2.17.1
Thanks for doing this, I was about to send that same patch myself.
- Moritz
[email protected]
Acked-byQuoted 14 lines · Moritz Fischer
Hi Lukas,
Quoted 2 lines · Lukas Bulwahn
Commit
fa41d10589be("fpga: dfl-pci: locate DFLs by PCIe vendor specific capability") provides documentation to the FPGA Device Feature List (DFL)Nit: Do you want to make this a Fixes: tag instead?
Quoted 8 lines
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.
Quoted 4 lines
Quoted 3 lines
Rectify ReST formatting in
./Documentation/fpga/dfl.rst.Signed-off-by Lukas Bulwahn <[email protected]>Acked-by Moritz Fischer <[email protected]>
Quoted 39 lines
Quoted 32 lines
---
applies cleanly on next-20210111Moritz, 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(-)Documentation/fpga/dfl.rst +1
-2@@ -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| --Quoted 2 lines
2.17.1
Thanks for doing this, I was about to send that same patch myself.
- Moritz