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 <[email protected]>
---
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
On Mon, Jan 11, 2021 at 07:11:59AM -0800, Tom Rix wrote:
>
> On 1/11/21 3:21 AM, Lukas Bulwahn wrote:
> > 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 ?
'make htmldocs'
Hi Lukas,
On Mon, Jan 11, 2021 at 12:21:13PM +0100, Lukas Bulwahn wrote:
> 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?
> 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]>
> ---
> 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
>
Thanks for doing this, I was about to send that same patch myself.
- Moritz
On Mon, Jan 11, 2021 at 12:21:13PM +0100, Lukas Bulwahn wrote:
> 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 <[email protected]>
You forgot a Reported-by: tag for the person who notified you of this :(
On 1/11/21 7:53 AM, Greg Kroah-Hartman wrote:
> On Mon, Jan 11, 2021 at 07:11:59AM -0800, Tom Rix wrote:
>> On 1/11/21 3:21 AM, Lukas Bulwahn wrote:
>>> 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 ?
> 'make htmldocs'
Thanks, I have verified the problem and its resolution.
Tested-by: Tom Rix <[email protected]>
>
On Mon, Jan 11, 2021 at 4:55 PM Moritz Fischer <[email protected]> wrote:
>
> Hi Lukas,
>
> On Mon, Jan 11, 2021 at 12:21:13PM +0100, Lukas Bulwahn wrote:
> > 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
> > 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]>
> > ---
> > 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
> >
>
> Thanks for doing this, I was about to send that same patch myself.
>
> - Moritz
On Mon, Jan 11, 2021 at 05:34:57PM +0100, Lukas Bulwahn wrote:
> On Mon, Jan 11, 2021 at 4:52 PM Greg Kroah-Hartman
> <[email protected]> wrote:
> >
> > On Mon, Jan 11, 2021 at 12:21:13PM +0100, Lukas Bulwahn wrote:
> > > 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 <[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
On Mon, 11 Jan 2021, Moritz Fischer wrote:
> Hi Lukas,
>
> On Mon, Jan 11, 2021 at 12:21:13PM +0100, Lukas Bulwahn wrote:
>> 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?
>> 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]>
Acked-by: Matthew Gerlach <[email protected]>
>> ---
>> 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
>>
>
> Thanks for doing this, I was about to send that same patch myself.
>
> - Moritz
>
On 1/11/21 3:21 AM, Lukas Bulwahn wrote:
> 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
>
> Signed-off-by: Lukas Bulwahn <[email protected]>
> ---
> 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|
On Mon, Jan 11, 2021 at 4:52 PM Greg Kroah-Hartman
<[email protected]> wrote:
>
> On Mon, Jan 11, 2021 at 12:21:13PM +0100, Lukas Bulwahn wrote:
> > 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 <[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
Hi Greg,
On Mon, Jan 11, 2021 at 07:14:22PM +0100, Greg Kroah-Hartman wrote:
> On Mon, Jan 11, 2021 at 05:34:57PM +0100, Lukas Bulwahn wrote:
> > On Mon, Jan 11, 2021 at 4:52 PM Greg Kroah-Hartman
> > <[email protected]> wrote:
> > >
> > > On Mon, Jan 11, 2021 at 12:21:13PM +0100, Lukas Bulwahn wrote:
> > > > 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 <[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
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
On Thu, Jan 14, 2021 at 08:45:15AM -0800, Moritz Fischer wrote:
> Hi Greg,
>
> On Mon, Jan 11, 2021 at 07:14:22PM +0100, Greg Kroah-Hartman wrote:
> > On Mon, Jan 11, 2021 at 05:34:57PM +0100, Lukas Bulwahn wrote:
> > > On Mon, Jan 11, 2021 at 4:52 PM Greg Kroah-Hartman
> > > <[email protected]> wrote:
> > > >
> > > > On Mon, Jan 11, 2021 at 12:21:13PM +0100, Lukas Bulwahn wrote:
> > > > > 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 <[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
>
> 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