From f4bdd7103652fab5ac8b0ed75fa5cbc515b50b8b Mon Sep 17 00:00:00 2001
From: Jacob Keller <jacob.e.keller@intel.com>
Date: Thu, 9 Jan 2020 14:46:10 -0800
Subject: [PATCH] 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 <jacob.e.keller@intel.com>
Signed-off-by: David S. Miller <davem@davemloft.net>
---
.../networking/{ => devlink}/devlink-health.txt | 0
.../{ => devlink}/devlink-info-versions.rst | 0
.../{ => devlink}/devlink-params-bnxt.txt | 0
.../{ => devlink}/devlink-params-mlx5.txt | 0
.../{ => devlink}/devlink-params-mlxsw.txt | 0
.../{ => devlink}/devlink-params-mv88e6xxx.txt | 0
.../{ => devlink}/devlink-params-nfp.txt | 0
.../devlink-params-ti-cpsw-switch.txt | 0
.../networking/{ => devlink}/devlink-params.txt | 0
.../{ => devlink}/devlink-trap-netdevsim.rst | 0
.../networking/{ => devlink}/devlink-trap.rst | 0
Documentation/networking/devlink/index.rst | 14 ++++++++++++++
Documentation/networking/index.rst | 4 +---
MAINTAINERS | 1 +
drivers/net/netdevsim/dev.c | 2 +-
include/net/devlink.h | 4 ++--
16 files changed, 19 insertions(+), 6 deletions(-)
rename Documentation/networking/{ => devlink}/devlink-health.txt (100%)
rename Documentation/networking/{ => devlink}/devlink-info-versions.rst (100%)
rename Documentation/networking/{ => devlink}/devlink-params-bnxt.txt (100%)
rename Documentation/networking/{ => devlink}/devlink-params-mlx5.txt (100%)
rename Documentation/networking/{ => devlink}/devlink-params-mlxsw.txt (100%)
rename Documentation/networking/{ => devlink}/devlink-params-mv88e6xxx.txt (100%)
rename Documentation/networking/{ => devlink}/devlink-params-nfp.txt (100%)
rename Documentation/networking/{ => devlink}/devlink-params-ti-cpsw-switch.txt (100%)
rename Documentation/networking/{ => devlink}/devlink-params.txt (100%)
rename Documentation/networking/{ => devlink}/devlink-trap-netdevsim.rst (100%)
rename Documentation/networking/{ => devlink}/devlink-trap.rst (100%)
create mode 100644 Documentation/networking/devlink/index.rst
diff --git a/Documentation/networking/devlink-health.txt b/Documentation/networking/devlink/devlink-health.txt
similarity index 100%
rename from Documentation/networking/devlink-health.txt
rename to Documentation/networking/devlink/devlink-health.txt
diff --git a/Documentation/networking/devlink-info-versions.rst b/Documentation/networking/devlink/devlink-info-versions.rst
similarity index 100%
rename from Documentation/networking/devlink-info-versions.rst
rename to Documentation/networking/devlink/devlink-info-versions.rst
diff --git a/Documentation/networking/devlink-params-bnxt.txt b/Documentation/networking/devlink/devlink-params-bnxt.txt
similarity index 100%
rename from Documentation/networking/devlink-params-bnxt.txt
rename to Documentation/networking/devlink/devlink-params-bnxt.txt
diff --git a/Documentation/networking/devlink-params-mlx5.txt b/Documentation/networking/devlink/devlink-params-mlx5.txt
similarity index 100%
rename from Documentation/networking/devlink-params-mlx5.txt
rename to Documentation/networking/devlink/devlink-params-mlx5.txt
diff --git a/Documentation/networking/devlink-params-mlxsw.txt b/Documentation/networking/devlink/devlink-params-mlxsw.txt
similarity index 100%
rename from Documentation/networking/devlink-params-mlxsw.txt
rename to Documentation/networking/devlink/devlink-params-mlxsw.txt
diff --git a/Documentation/networking/devlink-params-mv88e6xxx.txt b/Documentation/networking/devlink/devlink-params-mv88e6xxx.txt
similarity index 100%
rename from Documentation/networking/devlink-params-mv88e6xxx.txt
rename to Documentation/networking/devlink/devlink-params-mv88e6xxx.txt
diff --git a/Documentation/networking/devlink-params-nfp.txt b/Documentation/networking/devlink/devlink-params-nfp.txt
similarity index 100%
rename from Documentation/networking/devlink-params-nfp.txt
rename to Documentation/networking/devlink/devlink-params-nfp.txt
diff --git a/Documentation/networking/devlink-params-ti-cpsw-switch.txt b/Documentation/networking/devlink/devlink-params-ti-cpsw-switch.txt
similarity index 100%
rename from Documentation/networking/devlink-params-ti-cpsw-switch.txt
rename to Documentation/networking/devlink/devlink-params-ti-cpsw-switch.txt
diff --git a/Documentation/networking/devlink-params.txt b/Documentation/networking/devlink/devlink-params.txt
similarity index 100%
rename from Documentation/networking/devlink-params.txt
rename to Documentation/networking/devlink/devlink-params.txt
diff --git a/Documentation/networking/devlink-trap-netdevsim.rst b/Documentation/networking/devlink/devlink-trap-netdevsim.rst
similarity index 100%
rename from Documentation/networking/devlink-trap-netdevsim.rst
rename to Documentation/networking/devlink/devlink-trap-netdevsim.rst
diff --git a/Documentation/networking/devlink-trap.rst b/Documentation/networking/devlink/devlink-trap.rst
similarity index 100%
rename from Documentation/networking/devlink-trap.rst
rename to Documentation/networking/devlink/devlink-trap.rst
diff --git a/Documentation/networking/devlink/index.rst b/Documentation/networking/devlink/index.rst
new file mode 100644
index 0000000000000..1252c2a1b680a
--- /dev/null
+++ 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
index bee73be7af93f..d07d9855dcd3e 100644
--- 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
index 9dcb9cab57057..d0ea00e3e8b15 100644
--- 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 <support.opensource@diasemi.com>
diff --git a/drivers/net/netdevsim/dev.c b/drivers/net/netdevsim/dev.c
index 059711edfc61e..6663f79fe5d1e 100644
--- 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
index 4e80d9acdb861..a6856f1d5d1fc 100644
--- 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,
--
GitLab