Re: [PATCH 0/4] docs: e100[0] fix build errors

From: Kirsher, Jeffrey T
Date: Sun Jun 24 2018 - 21:12:02 EST




> On Jun 24, 2018, at 16:41, Tobin C. Harding <me@xxxxxxxx> wrote:
>
>> On Fri, Jun 22, 2018 at 01:22:37PM -0700, Randy Dunlap wrote:
>> Hi Tobin,
>>
>>> On 06/21/2018 05:37 PM, Tobin C. Harding wrote:
>>> Hi Jonathan,
>>>
>>> This patch set fixes current docs build failure on Linus' mainline
>>>
>>> commit: (ba4dbdedd3ed Merge tag 'jfs-4.18' of git://github.com/kleikamp/linux-shaggy)
>>>
>>> (FYI this is 8 commits after Linux 4.18-rc1).
>>>
>>> And also same build errors on today's linux-next
>>>
>>> 8439c34f07a3 (tag: next-20180621, linux-next/master, linux-next) Add linux-next specific files for 20180621
>>>
>>>
>>> I split the patches in between the two drivers to enable use of the
>>> 'Fixes:' tag.
>>>
>>> Tobin C. Harding (4):
>>> Documentation: e100: Use correct heading adornment
>>> Documentation: e1000: Use correct heading adornment
>>> Documentation: e100: Fix docs build error
>>> Documentation: e1000: Fix docs build error
>>>
>>> Documentation/networking/e100.rst | 112 +++++++++++++++--------------
>>> Documentation/networking/e1000.rst | 76 ++++++++++----------
>>> 2 files changed, 96 insertions(+), 92 deletions(-)
>>
>> I am still seeing a few warnings (your 4 patches applied to
>> linux-next-20180622):
>>
>> linux-next-20180622/Documentation/networking/e100.rst:57: WARNING: Literal block expected; none found.
>> linux-next-20180622/Documentation/networking/e100.rst:68: WARNING: Literal block expected; none found.
>> linux-next-20180622/Documentation/networking/e100.rst:75: WARNING: Literal block expected; none found.
>> linux-next-20180622/Documentation/networking/e100.rst:84: WARNING: Literal block expected; none found.
>> linux-next-20180622/Documentation/networking/e100.rst:93: WARNING: Inline emphasis start-string without end-string.
>> linux-next-20180622/Documentation/networking/e1000.rst:83: ERROR: Unexpected indentation.
>> linux-next-20180622/Documentation/networking/e1000.rst:84: WARNING: Block quote ends without a blank line; unexpected unindent.
>> linux-next-20180622/Documentation/networking/e1000.rst:173: WARNING: Definition list ends without a blank line; unexpected unindent.
>> linux-next-20180622/Documentation/networking/e1000.rst:236: WARNING: Definition list ends without a blank line; unexpected unindent.
>>
>>
>> You didn't get these warnings? or they weren't important?
>> or "perfect" was not your primary goal? :) [which is fine]
>>
>> [I see around 50 similar doc formatting warnings/errors in the entire
>> Documentation build.]
>
> Thanks for testing this Randy. You are right there are a bunch of
> warnings, I did not think to grep for warnings on these files - sloppy
> work by me. The series has been applied already but I'll add clearing
> these warnings to my TODO list.

Thanks, already on it. I have a set of patches that I will push once Dave open’s up his net-next tree.

>
>> Anyway, much better than it was. Thanks.
>>
>> Tested-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
>
> Thanks again,
> Tobin.