devlink: move devlink documentation to subfolder

Combine the documentation for devlink into a subfolder, and provide an index.rst file that can be used to generally describe devlink. Signed-off-by: Jacob Keller <[email protected]> Signed-off-by: David S. Miller <[email protected]>
lachaves · Jan 11, 2020 · f4bdd71 · f4bdd71
1 parent 468672b
commit f4bdd71
Show file tree

Hide file tree

Showing 16 changed files with 19 additions and 6 deletions.
diff --git a/Documentation/networking/devlink-health.txt → ...ion/networking/devlink/devlink-health.txt b/Documentation/networking/devlink-health.txt → ...ion/networking/devlink/devlink-health.txt
diff --git a/...tion/networking/devlink-info-versions.rst → ...working/devlink/devlink-info-versions.rst b/...tion/networking/devlink-info-versions.rst → ...working/devlink/devlink-info-versions.rst
diff --git a/...tation/networking/devlink-params-bnxt.txt → ...etworking/devlink/devlink-params-bnxt.txt b/...tation/networking/devlink-params-bnxt.txt → ...etworking/devlink/devlink-params-bnxt.txt
diff --git a/...tation/networking/devlink-params-mlx5.txt → ...etworking/devlink/devlink-params-mlx5.txt b/...tation/networking/devlink-params-mlx5.txt → ...etworking/devlink/devlink-params-mlx5.txt
diff --git a/...ation/networking/devlink-params-mlxsw.txt → ...tworking/devlink/devlink-params-mlxsw.txt b/...ation/networking/devlink-params-mlxsw.txt → ...tworking/devlink/devlink-params-mlxsw.txt
diff --git a/...n/networking/devlink-params-mv88e6xxx.txt → ...king/devlink/devlink-params-mv88e6xxx.txt b/...n/networking/devlink-params-mv88e6xxx.txt → ...king/devlink/devlink-params-mv88e6xxx.txt
diff --git a/...ntation/networking/devlink-params-nfp.txt → ...networking/devlink/devlink-params-nfp.txt b/...ntation/networking/devlink-params-nfp.txt → ...networking/devlink/devlink-params-nfp.txt
diff --git a/...working/devlink-params-ti-cpsw-switch.txt → ...devlink/devlink-params-ti-cpsw-switch.txt b/...working/devlink-params-ti-cpsw-switch.txt → ...devlink/devlink-params-ti-cpsw-switch.txt
diff --git a/Documentation/networking/devlink-params.txt → ...ion/networking/devlink/devlink-params.txt b/Documentation/networking/devlink-params.txt → ...ion/networking/devlink/devlink-params.txt
diff --git a/...ion/networking/devlink-trap-netdevsim.rst → ...orking/devlink/devlink-trap-netdevsim.rst b/...ion/networking/devlink-trap-netdevsim.rst → ...orking/devlink/devlink-trap-netdevsim.rst
diff --git a/Documentation/networking/devlink-trap.rst → ...ation/networking/devlink/devlink-trap.rst b/Documentation/networking/devlink-trap.rst → ...ation/networking/devlink/devlink-trap.rst
diff --git a/Documentation/networking/devlink/index.rst b/Documentation/networking/devlink/index.rst
@@ -0,0 +1,14 @@
+Linux Devlink Documentation
+===========================
+
+devlink is an API to expose device information and resources not directly
+related to any device class, such as chip-wide/switch-ASIC-wide configuration.
+
+Contents:
+
+.. toctree::
+   :maxdepth: 1
+
+   devlink-info-versions
+   devlink-trap
+   devlink-trap-netdevsim
diff --git a/Documentation/networking/index.rst b/Documentation/networking/index.rst
@@ -13,9 +13,7 @@ Contents:
    can_ucan_protocol
    device_drivers/index
    dsa/index
-   devlink-info-versions
-   devlink-trap
-   devlink-trap-netdevsim
+   devlink/index
    ethtool-netlink
    ieee802154
    j1939

diff --git a/MAINTAINERS b/MAINTAINERS
@@ -4848,6 +4848,7 @@ S:	Supported
 F:	net/core/devlink.c
 F:	include/net/devlink.h
 F:	include/uapi/linux/devlink.h
+F:	Documentation/networking/devlink
 
 DIALOG SEMICONDUCTOR DRIVERS
 M:	Support Opensource <[email protected]>

diff --git a/drivers/net/netdevsim/dev.c b/drivers/net/netdevsim/dev.c
@@ -270,7 +270,7 @@ struct nsim_trap_data {
 };
 
 /* All driver-specific traps must be documented in
- * Documentation/networking/devlink-trap-netdevsim.rst
+ * Documentation/networking/devlink/devlink-trap-netdevsim.rst
  */
 enum {
 	NSIM_TRAP_ID_BASE = DEVLINK_TRAP_GENERIC_ID_MAX,

diff --git a/include/net/devlink.h b/include/net/devlink.h
@@ -564,7 +564,7 @@ struct devlink_trap {
 };
 
 /* All traps must be documented in
- * Documentation/networking/devlink-trap.rst
+ * Documentation/networking/devlink/devlink-trap.rst
  */
 enum devlink_trap_generic_id {
 	DEVLINK_TRAP_GENERIC_ID_SMAC_MC,
@@ -598,7 +598,7 @@ enum devlink_trap_generic_id {
 };
 
 /* All trap groups must be documented in
- * Documentation/networking/devlink-trap.rst
+ * Documentation/networking/devlink/devlink-trap.rst
  */
 enum devlink_trap_group_generic_id {
 	DEVLINK_TRAP_GROUP_GENERIC_ID_L2_DROPS,