aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJacob Keller <jacob.e.keller@intel.com>2020-01-09 14:46:10 -0800
committerDavid S. Miller <davem@davemloft.net>2020-01-10 17:06:59 -0800
commitf4bdd7103652fab5ac8b0ed75fa5cbc515b50b8b (patch)
treeca068c74b7e95fa537d7bd156fce5b8ae81ef8b6
parentdevlink: add macro for "fw.psid" (diff)
downloadlinux-dev-f4bdd7103652fab5ac8b0ed75fa5cbc515b50b8b.tar.xz
linux-dev-f4bdd7103652fab5ac8b0ed75fa5cbc515b50b8b.zip
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>
-rw-r--r--Documentation/networking/devlink/devlink-health.txt (renamed from Documentation/networking/devlink-health.txt)0
-rw-r--r--Documentation/networking/devlink/devlink-info-versions.rst (renamed from Documentation/networking/devlink-info-versions.rst)0
-rw-r--r--Documentation/networking/devlink/devlink-params-bnxt.txt (renamed from Documentation/networking/devlink-params-bnxt.txt)0
-rw-r--r--Documentation/networking/devlink/devlink-params-mlx5.txt (renamed from Documentation/networking/devlink-params-mlx5.txt)0
-rw-r--r--Documentation/networking/devlink/devlink-params-mlxsw.txt (renamed from Documentation/networking/devlink-params-mlxsw.txt)0
-rw-r--r--Documentation/networking/devlink/devlink-params-mv88e6xxx.txt (renamed from Documentation/networking/devlink-params-mv88e6xxx.txt)0
-rw-r--r--Documentation/networking/devlink/devlink-params-nfp.txt (renamed from Documentation/networking/devlink-params-nfp.txt)0
-rw-r--r--Documentation/networking/devlink/devlink-params-ti-cpsw-switch.txt (renamed from Documentation/networking/devlink-params-ti-cpsw-switch.txt)0
-rw-r--r--Documentation/networking/devlink/devlink-params.txt (renamed from Documentation/networking/devlink-params.txt)0
-rw-r--r--Documentation/networking/devlink/devlink-trap-netdevsim.rst (renamed from Documentation/networking/devlink-trap-netdevsim.rst)0
-rw-r--r--Documentation/networking/devlink/devlink-trap.rst (renamed from Documentation/networking/devlink-trap.rst)0
-rw-r--r--Documentation/networking/devlink/index.rst14
-rw-r--r--Documentation/networking/index.rst4
-rw-r--r--MAINTAINERS1
-rw-r--r--drivers/net/netdevsim/dev.c2
-rw-r--r--include/net/devlink.h4
16 files changed, 19 insertions, 6 deletions
diff --git a/Documentation/networking/devlink-health.txt b/Documentation/networking/devlink/devlink-health.txt
index 1db3fbea0831..1db3fbea0831 100644
--- a/Documentation/networking/devlink-health.txt
+++ b/Documentation/networking/devlink/devlink-health.txt
diff --git a/Documentation/networking/devlink-info-versions.rst b/Documentation/networking/devlink/devlink-info-versions.rst
index 4914f581b1fd..4914f581b1fd 100644
--- a/Documentation/networking/devlink-info-versions.rst
+++ b/Documentation/networking/devlink/devlink-info-versions.rst
diff --git a/Documentation/networking/devlink-params-bnxt.txt b/Documentation/networking/devlink/devlink-params-bnxt.txt
index 481aa303d5b4..481aa303d5b4 100644
--- a/Documentation/networking/devlink-params-bnxt.txt
+++ b/Documentation/networking/devlink/devlink-params-bnxt.txt
diff --git a/Documentation/networking/devlink-params-mlx5.txt b/Documentation/networking/devlink/devlink-params-mlx5.txt
index 5071467118bd..5071467118bd 100644
--- a/Documentation/networking/devlink-params-mlx5.txt
+++ b/Documentation/networking/devlink/devlink-params-mlx5.txt
diff --git a/Documentation/networking/devlink-params-mlxsw.txt b/Documentation/networking/devlink/devlink-params-mlxsw.txt
index c63ea9fc7009..c63ea9fc7009 100644
--- a/Documentation/networking/devlink-params-mlxsw.txt
+++ b/Documentation/networking/devlink/devlink-params-mlxsw.txt
diff --git a/Documentation/networking/devlink-params-mv88e6xxx.txt b/Documentation/networking/devlink/devlink-params-mv88e6xxx.txt
index 21c4b3556ef2..21c4b3556ef2 100644
--- a/Documentation/networking/devlink-params-mv88e6xxx.txt
+++ b/Documentation/networking/devlink/devlink-params-mv88e6xxx.txt
diff --git a/Documentation/networking/devlink-params-nfp.txt b/Documentation/networking/devlink/devlink-params-nfp.txt
index 43e4d4034865..43e4d4034865 100644
--- a/Documentation/networking/devlink-params-nfp.txt
+++ b/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
index 4037458499f7..4037458499f7 100644
--- a/Documentation/networking/devlink-params-ti-cpsw-switch.txt
+++ b/Documentation/networking/devlink/devlink-params-ti-cpsw-switch.txt
diff --git a/Documentation/networking/devlink-params.txt b/Documentation/networking/devlink/devlink-params.txt
index 04e234e9acc9..04e234e9acc9 100644
--- a/Documentation/networking/devlink-params.txt
+++ b/Documentation/networking/devlink/devlink-params.txt
diff --git a/Documentation/networking/devlink-trap-netdevsim.rst b/Documentation/networking/devlink/devlink-trap-netdevsim.rst
index b721c9415473..b721c9415473 100644
--- a/Documentation/networking/devlink-trap-netdevsim.rst
+++ b/Documentation/networking/devlink/devlink-trap-netdevsim.rst
diff --git a/Documentation/networking/devlink-trap.rst b/Documentation/networking/devlink/devlink-trap.rst
index 03311849bfb1..03311849bfb1 100644
--- a/Documentation/networking/devlink-trap.rst
+++ b/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 000000000000..1252c2a1b680
--- /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 bee73be7af93..d07d9855dcd3 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 9dcb9cab5705..d0ea00e3e8b1 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 059711edfc61..6663f79fe5d1 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 4e80d9acdb86..a6856f1d5d1f 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,