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>
This commit is contained in:
Jacob Keller 2020-01-09 14:46:10 -08:00 committed by David S. Miller
parent 468672b24f
commit f4bdd71036
16 changed files with 19 additions and 6 deletions

View File

@ -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

View File

@ -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

View File

@ -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>

View File

@ -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,

View File

@ -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,