]> git.baikalelectronics.ru Git - kernel.git/commit
devlink: convert driver-specific files to reStructuredText
authorJacob Keller <jacob.e.keller@intel.com>
Thu, 9 Jan 2020 22:46:16 +0000 (14:46 -0800)
committerDavid S. Miller <davem@davemloft.net>
Sat, 11 Jan 2020 01:06:59 +0000 (17:06 -0800)
commit9db34d94cac77e2b0c82b7dcb0acee1b1aff4121
tree0b38819273d985cc715898420c82af20e3c31b87
parentb60cab4f97370c1305f5f77db1130f78c8e0a669
devlink: convert driver-specific files to reStructuredText

Several drivers document what parameters they support in
a devlink-params-*.txt file. This file is supposed to contain both the
list of generic parameters implemented by the driver, as well as a list
of driver-specific parameters and their descriptions.

It would also be good if the driver documentation included other
driver-specific implementations, such as info versions, devlink
regions, and so forth.

Convert all of these documentation files to reStructuredText, and rename
them to just the driver name. Future changes will include other
driver-specific implementations. Each file will contain a table for the
generic parameters implemented, as well as a separate table for the
driver-specific parameters.

Future sections such as for devlink info versions will be added to these
files. This avoids creating additional devlink-<feature>-<driver> files
for each devlink feature, reducing clutter in the documentation folder.

Signed-off-by: Jacob Keller <jacob.e.keller@intel.com>
Cc: Tariq Toukan <tariqt@mellanox.com>
Cc: Saeed Mahameed <saeedm@mellanox.com>
Cc: Leon Romanovsky <leonro@mellanox.com>
Cc: Michael Chan <michael.chan@broadcom.com>
Cc: Andrew Lunn <andrew@lunn.ch>
Cc: Vivien Didelot <vivien.didelot@gmail.com>
Cc: Jiri Pirko <jiri@mellanox.com>
Cc: Ido Schimmel <idosch@mellanox.com>
Cc: Jakub Kicinski <jakub.kicinski@netronome.com>
Cc: Grygorii Strashko <grygorii.strashko@ti.com>
Signed-off-by: David S. Miller <davem@davemloft.net>
15 files changed:
Documentation/networking/device_drivers/ti/cpsw_switchdev.txt
Documentation/networking/devlink/bnxt.rst [new file with mode: 0644]
Documentation/networking/devlink/devlink-params-bnxt.txt [deleted file]
Documentation/networking/devlink/devlink-params-mlx5.txt [deleted file]
Documentation/networking/devlink/devlink-params-mlxsw.txt [deleted file]
Documentation/networking/devlink/devlink-params-mv88e6xxx.txt [deleted file]
Documentation/networking/devlink/devlink-params-nfp.txt [deleted file]
Documentation/networking/devlink/devlink-params-ti-cpsw-switch.txt [deleted file]
Documentation/networking/devlink/index.rst
Documentation/networking/devlink/mlx5.rst [new file with mode: 0644]
Documentation/networking/devlink/mlxsw.rst [new file with mode: 0644]
Documentation/networking/devlink/mv88e6xxx.rst [new file with mode: 0644]
Documentation/networking/devlink/nfp.rst [new file with mode: 0644]
Documentation/networking/devlink/ti-cpsw-switch.rst [new file with mode: 0644]
MAINTAINERS