linux/Documentation/networking/devlink/index.rst

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-health
   devlink-info
   devlink-params
   devlink-trap
   devlink-trap-netdevsim
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> 2020-01-10 06:46:10 +08:00			`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: convert devlink-health.txt to rst format Update the devlink-health documentation to use the newer ReStructuredText format. Note that it's unclear what OOB stood for, and it has been left as-is without a proper first-use expansion of the acronym. Signed-off-by: Jacob Keller <jacob.e.keller@intel.com> Signed-off-by: David S. Miller <davem@davemloft.net> 2020-01-10 06:46:11 +08:00			`devlink-health`
devlink: rename devlink-info-versions.rst and add a header Rename the devlink-info-versions.rst file to a plain devlink-info.rst file. Add additional paragraphs explaining what devlink-info is for, and the expectation that drivers use the generic names where plausible. Note that drivers which use non-standard info version names ought to document these in a driver-specific info-versions.rst file. Signed-off-by: Jacob Keller <jacob.e.keller@intel.com> Signed-off-by: David S. Miller <davem@davemloft.net> 2020-01-10 06:46:12 +08:00			`devlink-info`
devlink: convert devlink-params.txt to reStructuredText Convert the generic parameters descriptions into the reStructuredText format. Signed-off-by: Jacob Keller <jacob.e.keller@intel.com> Signed-off-by: David S. Miller <davem@davemloft.net> 2020-01-10 06:46:13 +08:00			`devlink-params`
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> 2020-01-10 06:46:10 +08:00			`devlink-trap`
			`devlink-trap-netdevsim`