| Message ID | 1544371791-31192-1-git-send-email-rppt@linux.ibm.com |
|---|---|
| State | Awaiting Upstream, archived |
| Delegated to: | David Miller |
| Headers | show |
| Series | docs/networking: fix formatting of Intel drivers documentation | expand |
From: Mike Rapoport <rppt@linux.ibm.com> Date: Sun, 9 Dec 2018 18:09:51 +0200 > The documentation of Intel drivers is missing the heading adornment for > document titles. > > This causes the generated html to have TOC entries from these documents to > appear as top level TOC entries: > > * Linux* Base Driver for Intel(R) Ethernet Network Connection > * Contents > * Identifying Your Adapter > * Command Line Parameters > * AutoNeg > * Duplex > ... > > Add overline heading adornment to document titles. > > Signed-off-by: Mike Rapoport <rppt@linux.ibm.com> Jeff, I am assuming you picked this up. Let me know if you haven't and you want me to integrate it. Thanks.
On Tue, 2018-12-11 at 22:50 -0800, David Miller wrote: > From: Mike Rapoport <rppt@linux.ibm.com> > Date: Sun, 9 Dec 2018 18:09:51 +0200 > > > The documentation of Intel drivers is missing the heading adornment > > for > > document titles. > > > > This causes the generated html to have TOC entries from these > > documents to > > appear as top level TOC entries: > > > > * Linux* Base Driver for Intel(R) Ethernet Network Connection > > * Contents > > * Identifying Your Adapter > > * Command Line Parameters > > * AutoNeg > > * Duplex > > ... > > > > Add overline heading adornment to document titles. > > > > Signed-off-by: Mike Rapoport <rppt@linux.ibm.com> > > Jeff, I am assuming you picked this up. > > Let me know if you haven't and you want me to integrate it. I got it covered, thanks!
diff --git a/Documentation/networking/e100.rst b/Documentation/networking/e100.rst index 5e2839b..2b9f488 100644 --- a/Documentation/networking/e100.rst +++ b/Documentation/networking/e100.rst @@ -1,5 +1,6 @@ .. SPDX-License-Identifier: GPL-2.0+ +============================================================== Linux* Base Driver for the Intel(R) PRO/100 Family of Adapters ============================================================== diff --git a/Documentation/networking/e1000.rst b/Documentation/networking/e1000.rst index 6379d4d..956560b 100644 --- a/Documentation/networking/e1000.rst +++ b/Documentation/networking/e1000.rst @@ -1,5 +1,6 @@ .. SPDX-License-Identifier: GPL-2.0+ +=========================================================== Linux* Base Driver for Intel(R) Ethernet Network Connection =========================================================== diff --git a/Documentation/networking/e1000e.rst b/Documentation/networking/e1000e.rst index 33554e5..01999f0 100644 --- a/Documentation/networking/e1000e.rst +++ b/Documentation/networking/e1000e.rst @@ -1,5 +1,6 @@ .. SPDX-License-Identifier: GPL-2.0+ +====================================================== Linux* Driver for Intel(R) Ethernet Network Connection ====================================================== diff --git a/Documentation/networking/fm10k.rst b/Documentation/networking/fm10k.rst index bf5e594..ac3269e 100644 --- a/Documentation/networking/fm10k.rst +++ b/Documentation/networking/fm10k.rst @@ -1,5 +1,6 @@ .. SPDX-License-Identifier: GPL-2.0+ +============================================================== Linux* Base Driver for Intel(R) Ethernet Multi-host Controller ============================================================== diff --git a/Documentation/networking/i40e.rst b/Documentation/networking/i40e.rst index 0cc16c5..848fd38 100644 --- a/Documentation/networking/i40e.rst +++ b/Documentation/networking/i40e.rst @@ -1,5 +1,6 @@ .. SPDX-License-Identifier: GPL-2.0+ +================================================================== Linux* Base Driver for the Intel(R) Ethernet Controller 700 Series ================================================================== diff --git a/Documentation/networking/iavf.rst b/Documentation/networking/iavf.rst index f8b42b6..2d0c3ba 100644 --- a/Documentation/networking/iavf.rst +++ b/Documentation/networking/iavf.rst @@ -1,5 +1,6 @@ .. SPDX-License-Identifier: GPL-2.0+ +================================================================== Linux* Base Driver for Intel(R) Ethernet Adaptive Virtual Function ================================================================== diff --git a/Documentation/networking/ice.rst b/Documentation/networking/ice.rst index 4d118b8..c220aa2 100644 --- a/Documentation/networking/ice.rst +++ b/Documentation/networking/ice.rst @@ -1,5 +1,6 @@ .. SPDX-License-Identifier: GPL-2.0+ +=================================================================== Linux* Base Driver for the Intel(R) Ethernet Connection E800 Series =================================================================== diff --git a/Documentation/networking/igb.rst b/Documentation/networking/igb.rst index ba16b86..e8f99af 100644 --- a/Documentation/networking/igb.rst +++ b/Documentation/networking/igb.rst @@ -1,5 +1,6 @@ .. SPDX-License-Identifier: GPL-2.0+ +=========================================================== Linux* Base Driver for Intel(R) Ethernet Network Connection =========================================================== diff --git a/Documentation/networking/igbvf.rst b/Documentation/networking/igbvf.rst index a8a9ffa..9cddabe 100644 --- a/Documentation/networking/igbvf.rst +++ b/Documentation/networking/igbvf.rst @@ -1,5 +1,6 @@ .. SPDX-License-Identifier: GPL-2.0+ +============================================================ Linux* Base Virtual Function Driver for Intel(R) 1G Ethernet ============================================================ diff --git a/Documentation/networking/ixgb.rst b/Documentation/networking/ixgb.rst index 8bd80e27..9450182 100644 --- a/Documentation/networking/ixgb.rst +++ b/Documentation/networking/ixgb.rst @@ -1,5 +1,6 @@ .. SPDX-License-Identifier: GPL-2.0+ +===================================================================== Linux Base Driver for 10 Gigabit Intel(R) Ethernet Network Connection ===================================================================== diff --git a/Documentation/networking/ixgbe.rst b/Documentation/networking/ixgbe.rst index 725fc69..255bfe1 100644 --- a/Documentation/networking/ixgbe.rst +++ b/Documentation/networking/ixgbe.rst @@ -1,5 +1,6 @@ .. SPDX-License-Identifier: GPL-2.0+ +============================================================================= Linux* Base Driver for the Intel(R) Ethernet 10 Gigabit PCI Express Adapters ============================================================================= diff --git a/Documentation/networking/ixgbevf.rst b/Documentation/networking/ixgbevf.rst index 56cde63..5d49773 100644 --- a/Documentation/networking/ixgbevf.rst +++ b/Documentation/networking/ixgbevf.rst @@ -1,5 +1,6 @@ .. SPDX-License-Identifier: GPL-2.0+ +============================================================= Linux* Base Virtual Function Driver for Intel(R) 10G Ethernet =============================================================
The documentation of Intel drivers is missing the heading adornment for document titles. This causes the generated html to have TOC entries from these documents to appear as top level TOC entries: * Linux* Base Driver for Intel(R) Ethernet Network Connection * Contents * Identifying Your Adapter * Command Line Parameters * AutoNeg * Duplex ... Add overline heading adornment to document titles. Signed-off-by: Mike Rapoport <rppt@linux.ibm.com> --- Another interesting thing is that many of these documents have very similar or even identical titles. It would be nice to include the adapter name in the titles to make them distinguishable. Documentation/networking/e100.rst | 1 + Documentation/networking/e1000.rst | 1 + Documentation/networking/e1000e.rst | 1 + Documentation/networking/fm10k.rst | 1 + Documentation/networking/i40e.rst | 1 + Documentation/networking/iavf.rst | 1 + Documentation/networking/ice.rst | 1 + Documentation/networking/igb.rst | 1 + Documentation/networking/igbvf.rst | 1 + Documentation/networking/ixgb.rst | 1 + Documentation/networking/ixgbe.rst | 1 + Documentation/networking/ixgbevf.rst | 1 + 12 files changed, 12 insertions(+)