Documentation: net: move device drivers docs to a submenu [Linux 5.2]

Documentation: net: move device drivers docs to a submenu [Linux 5.2]

This Linux kernel change "Documentation: net: move device drivers docs to a submenu" is included in the Linux 5.2 release. This change is authored by Jakub Kicinski <jakub.kicinski [at] netronome.com> on Tue May 21 18:57:12 2019 -0700. The commit for this change in Linux stable tree is b0d8d43 (patch).

Documentation: net: move device drivers docs to a submenu

Some of the device drivers have really long document titles
making the networking table of contents hard to look through.
Place vendor drivers under a submenu.

Signed-off-by: Jakub Kicinski <[email protected]>
Acked-by: Dave Watson <[email protected]>
Acked-by: Alexei Starovoitov <[email protected]>
Signed-off-by: David S. Miller <[email protected]>

There are 44 lines of Linux source code added/deleted in this change. Code changes to Linux kernel are as follows.

 Documentation/networking/device_drivers/index.rst | 30 +++++++++++++++++++++++
 Documentation/networking/index.rst                | 14 +----------
 2 files changed, 31 insertions(+), 13 deletions(-)
 create mode 100644 Documentation/networking/device_drivers/index.rst

diff --git a/Documentation/networking/device_drivers/index.rst b/Documentation/networking/device_drivers/index.rst
new file mode 100644
index 0000000..75fa537
--- /dev/null
+++ b/Documentation/networking/device_drivers/index.rst
@@ -0,0 +1,30 @@
+.. SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+
+Vendor Device Drivers
+=====================
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   freescale/dpaa2/index
+   intel/e100
+   intel/e1000
+   intel/e1000e
+   intel/fm10k
+   intel/igb
+   intel/igbvf
+   intel/ixgb
+   intel/ixgbe
+   intel/ixgbevf
+   intel/i40e
+   intel/iavf
+   intel/ice
+
+.. only::  subproject
+
+   Indices
+   =======
+
+   * :ref:`genindex`
diff --git a/Documentation/networking/index.rst b/Documentation/networking/index.rst
index f390fe3c..7a2bfad 100644
--- a/Documentation/networking/index.rst
+++ b/Documentation/networking/index.rst
@@ -11,19 +11,7 @@ Contents:
    batman-adv
    can
    can_ucan_protocol
-   device_drivers/freescale/dpaa2/index
-   device_drivers/intel/e100
-   device_drivers/intel/e1000
-   device_drivers/intel/e1000e
-   device_drivers/intel/fm10k
-   device_drivers/intel/igb
-   device_drivers/intel/igbvf
-   device_drivers/intel/ixgb
-   device_drivers/intel/ixgbe
-   device_drivers/intel/ixgbevf
-   device_drivers/intel/i40e
-   device_drivers/intel/iavf
-   device_drivers/intel/ice
+   device_drivers/index
    dsa/index
    devlink-info-versions
    ieee802154

Leave a Reply

Your email address will not be published. Required fields are marked *