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

From: Tobin C. Harding
Date: Thu Jun 21 2018 - 20:37:27 EST


Hi Jonathan,

I may be a little confused here, I'm getting docs build failure on
Linus' mainline, linux-next, and your docs-next but different errors.
There seems to be patches to the first two trees that are not in your
docs-next tree?

Do networking docs typically go through your tree? Looks like
networking has done some conversion to rst that hasn't gone through your
tree. Or else my git skills are failing.

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 pulled your tree, just to make sure I'm pulling the correct one I got

a49d9c0ae46e (HEAD -> docs-next, tag: docs-4.18, corbet/docs-next) Documentation: document hung_task_panic kernel parameter

I split the patches in between the two drivers to enable use of the
'Fixes:' tag.

One question, is there are standard spacing after headings. I attempted
to maintain uniformity within each file but this has resulted in the two
files being different. One has no space after section headings

section heading
---------------
Some text with no newline.

While the other file uses a single newline after section headings.

While on the topic of newlines and headings; is there a correct number
of newlines to have _before_ a heading?

I did not find this information when looking at
Documentation/doc-guide/sphinx.rst

If there is a ruling on these newlines I can re-spin this set with an
added patch to fix all the newlines in both e1000.rst and e100.rst


thanks,
Tobin.


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

--
2.17.1