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

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

[Tobin C. Harding]

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

[PATCH 1/4] Documentation: e100: Use correct heading adornment

[Tobin C. Harding]

Recently documentation file was converted to rst.  The document title
has the incorrect heading adornment.  From kernel docs:

	* Please stick to this order of heading adornments:

	  1. ``=`` with overline for document title::

	       ==============
	       Document title
	       ==============

Add  overline heading adornment to document title.

Fixes commit (85d63445f411 Documentation: e100: Update the Intel 10/100 driver doc)

CC: Jeff Kirsher <jeffrey.t.kirsher@intel.com>
Signed-off-by: Tobin C. Harding <me@tobin.cc>
---
 Documentation/networking/e100.rst | 1 +
 1 file changed, 1 insertion(+)

diff --git a/Documentation/networking/e100.rst b/Documentation/networking/e100.rst
index d4d837027925..59b80608e27d 100644
--- a/Documentation/networking/e100.rst
+++ b/Documentation/networking/e100.rst
@@ -1,3 +1,4 @@
+==============================================================
 Linux* Base Driver for the Intel(R) PRO/100 Family of Adapters
 ==============================================================
 
-- 
2.17.1

[PATCH 2/4] Documentation: e1000: Use correct heading adornment

[Tobin C. Harding]

Recently documentation file was converted to rst.  The document title
has the incorrect heading adornment.  From kernel docs:

	* Please stick to this order of heading adornments:

	  1. ``=`` with overline for document title::

	       ==============
	       Document title
	       ==============

Add  overline heading adornment to document title.

Fixes commit (228046e76189 Documentation: e1000: Update kernel documentation)

CC: Jeff Kirsher <jeffrey.t.kirsher@intel.com>
Signed-off-by: Tobin C. Harding <me@tobin.cc>
---
 Documentation/networking/e1000.rst | 1 +
 1 file changed, 1 insertion(+)

diff --git a/Documentation/networking/e1000.rst b/Documentation/networking/e1000.rst
index 616848940e63..55f28e5043b6 100644
--- a/Documentation/networking/e1000.rst
+++ b/Documentation/networking/e1000.rst
@@ -1,3 +1,4 @@
+===========================================================
 Linux* Base Driver for Intel(R) Ethernet Network Connection
 ===========================================================
 
-- 
2.17.1

[PATCH 3/4] Documentation: e100: Fix docs build error

[Tobin C. Harding]

Recent patch updated e100 docs to rst format.  Docs build (`make
htmldocs`) is currently failing due to this file with error:

	(SEVERE/4) Unexpected section title.

This is because a section of the file is indented 2 spaces.  Build error
can be cleared by aligning the text with column 0.  While we are changing
these lines we can make sure line length does not exceed 72, that
newlines following headings are uniform, and that full stops are
followed by two spaces.

Align text with column 0, limit line length to 72, ensure two spaces
follow all full stops, ensure uniform use of newlines after heading.

Fixes commit (85d63445f411 Documentation: e100: Update the Intel 10/100 driver doc)

CC: Jeff Kirsher <jeffrey.t.kirsher@intel.com>
Signed-off-by: Tobin C. Harding <me@tobin.cc>
---
 Documentation/networking/e100.rst | 115 +++++++++++++++---------------
 1 file changed, 58 insertions(+), 57 deletions(-)

diff --git a/Documentation/networking/e100.rst b/Documentation/networking/e100.rst
index 59b80608e27d..9708f5fa76de 100644
--- a/Documentation/networking/e100.rst
+++ b/Documentation/networking/e100.rst
@@ -87,83 +87,84 @@ Event Log Message Level:  The driver uses the message level flag to log events
 Additional Configurations
 =========================
 
-  Configuring the Driver on Different Distributions
-  -------------------------------------------------
-
-  Configuring a network driver to load properly when the system is started is
-  distribution dependent. Typically, the configuration process involves adding
-  an alias line to /etc/modprobe.d/*.conf as well as editing other system
-  startup scripts and/or configuration files.  Many popular Linux
-  distributions ship with tools to make these changes for you. To learn the
-  proper way to configure a network device for your system, refer to your
-  distribution documentation.  If during this process you are asked for the
-  driver or module name, the name for the Linux Base Driver for the Intel
-  PRO/100 Family of Adapters is e100.
-
-  As an example, if you install the e100 driver for two PRO/100 adapters
-  (eth0 and eth1), add the following to a configuration file in /etc/modprobe.d/
+Configuring the Driver on Different Distributions
+-------------------------------------------------
+
+Configuring a network driver to load properly when the system is started
+is distribution dependent.  Typically, the configuration process involves
+adding an alias line to /etc/modprobe.d/*.conf as well as editing other
+system startup scripts and/or configuration files.  Many popular Linux
+distributions ship with tools to make these changes for you.  To learn
+the proper way to configure a network device for your system, refer to
+your distribution documentation.  If during this process you are asked
+for the driver or module name, the name for the Linux Base Driver for
+the Intel PRO/100 Family of Adapters is e100.
+
+As an example, if you install the e100 driver for two PRO/100 adapters
+(eth0 and eth1), add the following to a configuration file in
+/etc/modprobe.d/::
 
        alias eth0 e100
        alias eth1 e100
 
-  Viewing Link Messages
-  ---------------------
-  In order to see link messages and other Intel driver information on your
-  console, you must set the dmesg level up to six. This can be done by
-  entering the following on the command line before loading the e100 driver::
+Viewing Link Messages
+---------------------
 
-       dmesg -n 6
-
-  If you wish to see all messages issued by the driver, including debug
-  messages, set the dmesg level to eight.
+In order to see link messages and other Intel driver information on your
+console, you must set the dmesg level up to six.  This can be done by
+entering the following on the command line before loading the e100
+driver::
 
-  NOTE: This setting is not saved across reboots.
+       dmesg -n 6
 
+If you wish to see all messages issued by the driver, including debug
+messages, set the dmesg level to eight.
 
-  ethtool
-  -------
+NOTE: This setting is not saved across reboots.
 
-  The driver utilizes the ethtool interface for driver configuration and
-  diagnostics, as well as displaying statistical information.  The ethtool
-  version 1.6 or later is required for this functionality.
+ethtool
+-------
 
-  The latest release of ethtool can be found from
-  https://www.kernel.org/pub/software/network/ethtool/
+The driver utilizes the ethtool interface for driver configuration and
+diagnostics, as well as displaying statistical information.  The ethtool
+version 1.6 or later is required for this functionality.
 
-  Enabling Wake on LAN* (WoL)
-  ---------------------------
-  WoL is provided through the ethtool* utility.  For instructions on enabling
-  WoL with ethtool, refer to the ethtool man page.
+The latest release of ethtool can be found from
+https://www.kernel.org/pub/software/network/ethtool/
 
-  WoL will be enabled on the system during the next shut down or reboot. For
-  this driver version, in order to enable WoL, the e100 driver must be
-  loaded when shutting down or rebooting the system.
+Enabling Wake on LAN* (WoL)
+---------------------------
+WoL is provided through the ethtool* utility.  For instructions on
+enabling WoL with ethtool, refer to the ethtool man page.  WoL will be
+enabled on the system during the next shut down or reboot.  For this
+driver version, in order to enable WoL, the e100 driver must be loaded
+when shutting down or rebooting the system.
 
-  NAPI
-  ----
+NAPI
+----
 
-  NAPI (Rx polling mode) is supported in the e100 driver.
+NAPI (Rx polling mode) is supported in the e100 driver.
 
-  See https://wiki.linuxfoundation.org/networking/napi for more information
-  on NAPI.
+See https://wiki.linuxfoundation.org/networking/napi for more
+information on NAPI.
 
-  Multiple Interfaces on Same Ethernet Broadcast Network
-  ------------------------------------------------------
+Multiple Interfaces on Same Ethernet Broadcast Network
+------------------------------------------------------
 
-  Due to the default ARP behavior on Linux, it is not possible to have
-  one system on two IP networks in the same Ethernet broadcast domain
-  (non-partitioned switch) behave as expected. All Ethernet interfaces
-  will respond to IP traffic for any IP address assigned to the system.
-  This results in unbalanced receive traffic.
+Due to the default ARP behavior on Linux, it is not possible to have one
+system on two IP networks in the same Ethernet broadcast domain
+(non-partitioned switch) behave as expected.  All Ethernet interfaces
+will respond to IP traffic for any IP address assigned to the system.
+This results in unbalanced receive traffic.
 
-  If you have multiple interfaces in a server, either turn on ARP
-  filtering by
+If you have multiple interfaces in a server, either turn on ARP
+filtering by
 
-  (1) entering:: echo 1 > /proc/sys/net/ipv4/conf/all/arp_filter
-      (this only works if your kernel's version is higher than 2.4.5), or
+(1) entering:: echo 1 > /proc/sys/net/ipv4/conf/all/arp_filter
+    (this only works if your kernel's version is higher than 2.4.5), or
 
-  (2) installing the interfaces in separate broadcast domains (either
-      in different switches or in a switch partitioned to VLANs).
+(2) installing the interfaces in separate broadcast domains (either
+    in different switches or in a switch partitioned to VLANs).
 
 
 Support
-- 
2.17.1

[PATCH 4/4] Documentation: e1000: Fix docs build error

[Tobin C. Harding]

Recent patch updated e1000 docs to rst format.  Docs build (`make
htmldocs`) is currently failing due to this file with error:

        (SEVERE/4) Unexpected section title.

This is because a section of the file is indented 2 spaces.  Build error
can be cleared by aligning the text with column 0.  While we are changing
these lines we can make sure line length does not exceed 72, that
newlines following headings are uniform, and that full stops are
followed by two spaces.

Align text with column 0, limit line length to 72, ensure two spaces
follow all full stops, ensure uniform use of newlines after heading.

Fixes commit (228046e76189 Documentation: e1000: Update kernel documentation)

CC: Jeff Kirsher <jeffrey.t.kirsher@intel.com>
Signed-off-by: Tobin C. Harding <me@tobin.cc>
---
 Documentation/networking/e1000.rst | 75 +++++++++++++++---------------
 1 file changed, 38 insertions(+), 37 deletions(-)

diff --git a/Documentation/networking/e1000.rst b/Documentation/networking/e1000.rst
index 55f28e5043b6..144b87eef153 100644
--- a/Documentation/networking/e1000.rst
+++ b/Documentation/networking/e1000.rst
@@ -355,57 +355,58 @@ previously mentioned to force the adapter to the same speed and duplex.
 Additional Configurations
 =========================
 
-  Jumbo Frames
-  ------------
-  Jumbo Frames support is enabled by changing the MTU to a value larger than
-  the default of 1500.  Use the ifconfig command to increase the MTU size.
-  For example::
+Jumbo Frames
+------------
+Jumbo Frames support is enabled by changing the MTU to a value larger
+than the default of 1500.  Use the ifconfig command to increase the MTU
+size.  For example::
 
        ifconfig eth<x> mtu 9000 up
 
-  This setting is not saved across reboots.  It can be made permanent if
-  you add::
+This setting is not saved across reboots.  It can be made permanent if
+you add::
 
        MTU=9000
 
-   to the file /etc/sysconfig/network-scripts/ifcfg-eth<x>.  This example
-   applies to the Red Hat distributions; other distributions may store this
-   setting in a different location.
+to the file /etc/sysconfig/network-scripts/ifcfg-eth<x>.  This example
+applies to the Red Hat distributions; other distributions may store this
+setting in a different location.
 
-  Notes:
-  Degradation in throughput performance may be observed in some Jumbo frames
-  environments. If this is observed, increasing the application's socket buffer
-  size and/or increasing the /proc/sys/net/ipv4/tcp_*mem entry values may help.
-  See the specific application manual and /usr/src/linux*/Documentation/
-  networking/ip-sysctl.txt for more details.
+Notes: Degradation in throughput performance may be observed in some
+Jumbo frames environments.  If this is observed, increasing the
+application's socket buffer size and/or increasing the
+/proc/sys/net/ipv4/tcp_*mem entry values may help.  See the specific
+application manual and /usr/src/linux*/Documentation/
+networking/ip-sysctl.txt for more details.
 
-  - The maximum MTU setting for Jumbo Frames is 16110.  This value coincides
-    with the maximum Jumbo Frames size of 16128.
+- The maximum MTU setting for Jumbo Frames is 16110.  This value
+  coincides with the maximum Jumbo Frames size of 16128.
 
-  - Using Jumbo frames at 10 or 100 Mbps is not supported and may result in
-    poor performance or loss of link.
+- Using Jumbo frames at 10 or 100 Mbps is not supported and may result
+  in poor performance or loss of link.
 
-  - Adapters based on the Intel(R) 82542 and 82573V/E controller do not
-    support Jumbo Frames. These correspond to the following product names:
-     Intel(R) PRO/1000 Gigabit Server Adapter
-     Intel(R) PRO/1000 PM Network Connection
+- Adapters based on the Intel(R) 82542 and 82573V/E controller do not
+  support Jumbo Frames.  These correspond to the following product names:
+  Intel(R) PRO/1000 Gigabit Server Adapter Intel(R) PRO/1000 PM Network
+  Connection
 
-  ethtool
-  -------
-  The driver utilizes the ethtool interface for driver configuration and
-  diagnostics, as well as displaying statistical information.  The ethtool
-  version 1.6 or later is required for this functionality.
+ethtool
+-------
+The driver utilizes the ethtool interface for driver configuration and
+diagnostics, as well as displaying statistical information.  The ethtool
+version 1.6 or later is required for this functionality.
+
+The latest release of ethtool can be found from
+https://www.kernel.org/pub/software/network/ethtool/
 
-  The latest release of ethtool can be found from
-  https://www.kernel.org/pub/software/network/ethtool/
+Enabling Wake on LAN* (WoL)
+---------------------------
+WoL is configured through the ethtool* utility.
 
-  Enabling Wake on LAN* (WoL)
-  ---------------------------
-  WoL is configured through the ethtool* utility.
+WoL will be enabled on the system during the next shut down or reboot.
+For this driver version, in order to enable WoL, the e1000 driver must be
+loaded when shutting down or rebooting the system.
 
-  WoL will be enabled on the system during the next shut down or reboot.
-  For this driver version, in order to enable WoL, the e1000 driver must be
-  loaded when shutting down or rebooting the system.
 
 Support
 =======
-- 
2.17.1

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

[Jeff Kirsher]

[-- Attachment #1: Type: text/plain, Size: 629 bytes --]

On Fri, 2018-06-22 at 10:37 +1000, Tobin C. Harding wrote:
> 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.

Networking documentation changes went through David Miller's networking
tree because he maintains changes under Documentation/networking/

[-- Attachment #2: This is a digitally signed message part --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

Re: [PATCH 1/4] Documentation: e100: Use correct heading adornment

[Jeff Kirsher]

[-- Attachment #1: Type: text/plain, Size: 732 bytes --]

On Fri, 2018-06-22 at 10:37 +1000, Tobin C. Harding wrote:
> Recently documentation file was converted to rst.  The document title
> has the incorrect heading adornment.  From kernel docs:
> 
>         * Please stick to this order of heading adornments:
> 
>           1. ``=`` with overline for document title::
> 
>                ==============
>                Document title
>                ==============
> 
> Add  overline heading adornment to document title.
> 
> Fixes commit (85d63445f411 Documentation: e100: Update the Intel
> 10/100 driver doc)
> 
> CC: Jeff Kirsher <jeffrey.t.kirsher@intel.com>
> Signed-off-by: Tobin C. Harding <me@tobin.cc>

Acked-by: Jeff Kirsher <jeffrey.t.kirsher@intel.com>

[-- Attachment #2: This is a digitally signed message part --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

Re: [PATCH 2/4] Documentation: e1000: Use correct heading adornment

[Jeff Kirsher]

[-- Attachment #1: Type: text/plain, Size: 726 bytes --]

On Fri, 2018-06-22 at 10:37 +1000, Tobin C. Harding wrote:
> Recently documentation file was converted to rst.  The document title
> has the incorrect heading adornment.  From kernel docs:
> 
>         * Please stick to this order of heading adornments:
> 
>           1. ``=`` with overline for document title::
> 
>                ==============
>                Document title
>                ==============
> 
> Add  overline heading adornment to document title.
> 
> Fixes commit (228046e76189 Documentation: e1000: Update kernel
> documentation)
> 
> CC: Jeff Kirsher <jeffrey.t.kirsher@intel.com>
> Signed-off-by: Tobin C. Harding <me@tobin.cc>

Acked-by: Jeff Kirsher <jeffrey.t.kirsher@intel.com>

[-- Attachment #2: This is a digitally signed message part --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

Re: [PATCH 3/4] Documentation: e100: Fix docs build error

[Jeff Kirsher]

[-- Attachment #1: Type: text/plain, Size: 970 bytes --]

On Fri, 2018-06-22 at 10:37 +1000, Tobin C. Harding wrote:
> Recent patch updated e100 docs to rst format.  Docs build (`make
> htmldocs`) is currently failing due to this file with error:
> 
>         (SEVERE/4) Unexpected section title.
> 
> This is because a section of the file is indented 2 spaces.  Build
> error
> can be cleared by aligning the text with column 0.  While we are
> changing
> these lines we can make sure line length does not exceed 72, that
> newlines following headings are uniform, and that full stops are
> followed by two spaces.
> 
> Align text with column 0, limit line length to 72, ensure two spaces
> follow all full stops, ensure uniform use of newlines after heading.
> 
> Fixes commit (85d63445f411 Documentation: e100: Update the Intel
> 10/100 driver doc)
> 
> CC: Jeff Kirsher <jeffrey.t.kirsher@intel.com>
> Signed-off-by: Tobin C. Harding <me@tobin.cc>

Acked-by: Jeff Kirsher <jeffrey.t.kirsher@intel.com>

[-- Attachment #2: This is a digitally signed message part --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

Re: [PATCH 4/4] Documentation: e1000: Fix docs build error

[Jeff Kirsher]

[-- Attachment #1: Type: text/plain, Size: 965 bytes --]

On Fri, 2018-06-22 at 10:37 +1000, Tobin C. Harding wrote:
> Recent patch updated e1000 docs to rst format.  Docs build (`make
> htmldocs`) is currently failing due to this file with error:
> 
>         (SEVERE/4) Unexpected section title.
> 
> This is because a section of the file is indented 2 spaces.  Build
> error
> can be cleared by aligning the text with column 0.  While we are
> changing
> these lines we can make sure line length does not exceed 72, that
> newlines following headings are uniform, and that full stops are
> followed by two spaces.
> 
> Align text with column 0, limit line length to 72, ensure two spaces
> follow all full stops, ensure uniform use of newlines after heading.
> 
> Fixes commit (228046e76189 Documentation: e1000: Update kernel
> documentation)
> 
> CC: Jeff Kirsher <jeffrey.t.kirsher@intel.com>
> Signed-off-by: Tobin C. Harding <me@tobin.cc>

Acked-by: Jeff Kirsher <jeffrey.t.kirsher@intel.com>

[-- Attachment #2: This is a digitally signed message part --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

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

[Randy Dunlap]

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.]

Anyway, much better than it was.  Thanks.

Tested-by: Randy Dunlap <rdunlap@infradead.org>

-- 
~Randy

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

[David Miller]

From: Jeff Kirsher <jeffrey.t.kirsher@intel.com>
Date: Fri, 22 Jun 2018 09:44:00 -0700

> On Fri, 2018-06-22 at 10:37 +1000, Tobin C. Harding wrote:
>> 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.
> 
> Networking documentation changes went through David Miller's networking
> tree because he maintains changes under Documentation/networking/

I've applied this series of fixes to my 'net' tree, thanks everyone.

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

[Tobin C. Harding]

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.

> Anyway, much better than it was.  Thanks.
> 
> Tested-by: Randy Dunlap <rdunlap@infradead.org>

Thanks again,
Tobin.

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

[Kirsher, Jeffrey T]

> On Jun 24, 2018, at 16:41, Tobin C. Harding <me@tobin.cc> 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@infradead.org>
> 
> Thanks again,
> Tobin.

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

[Tobin C. Harding]

On Mon, Jun 25, 2018 at 01:11:33AM +0000, Kirsher, Jeffrey T wrote:
> 
> 
> > On Jun 24, 2018, at 16:41, Tobin C. Harding <me@tobin.cc> 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.

Oh cool, even better.

thanks,
Tobin.