netdev.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jacob Keller <jacob.e.keller@intel.com>
To: netdev@vger.kernel.org
Cc: Jiri Pirko <jiri@mellanox.com>, Jacob Keller <jacob.e.keller@intel.com>
Subject: [PATCH 00/17] devlink documentation refactor
Date: Thu,  9 Jan 2020 14:46:08 -0800	[thread overview]
Message-ID: <20200109224625.1470433-1-jacob.e.keller@intel.com> (raw)

This series updates the devlink documentation, with a few primary goals

 * move all of the devlink documentation into a dedicated subfolder
 * convert that documentation to the reStructuredText format
 * merge driver-specific documentations into a single file per driver
 * add missing documentation, including per-driver and devlink generally

For each driver, I took the time to review the code and add further
documentation on the various features it currently supports. Additionally, I
added new documentation files for some of the features such as
devlink-dpipe, devlink-resource, and devlink-regions.

Note for the region snapshot triggering, I kept that as a separate patch as
that is based on work that has not yet been merged to net-next, and may
change.

I also improved the existing documentation for devlink-info and
devlink-param by adding a bit more of an introduction when converting it to
the rst format.

Jacob Keller (17):
  devlink: add macro for "fw.psid"
  devlink: move devlink documentation to subfolder
  devlink: convert devlink-health.txt to rst format
  devlink: rename devlink-info-versions.rst and add a header
  devlink: convert devlink-params.txt to reStructuredText
  devlink: add documentation for generic devlink parameters
  devlink: mention reloading in devlink-params.rst
  devlink: convert driver-specific files to reStructuredText
  devlink: document info versions for each driver
  devlink: add parameter documentation for the mlx4 driver
  devlink: add a driver-specific file for the qed driver
  devlink: add a file documenting devlink regions
  devlink: add documentation for ionic device driver
  devlink: rename and expand devlink-trap-netdevsim.rst
  devlink: add a devlink-resource.rst documentation file
  devlink: introduce devlink-dpipe.rst documentation file
  devlink: document region snapshot triggering from userspace

 .../device_drivers/ti/cpsw_switchdev.txt      |   2 +-
 Documentation/networking/devlink-health.txt   |  86 ------
 .../networking/devlink-info-versions.rst      |  64 -----
 .../networking/devlink-params-bnxt.txt        |  18 --
 .../networking/devlink-params-mlx5.txt        |  17 --
 .../networking/devlink-params-mlxsw.txt       |  10 -
 .../networking/devlink-params-mv88e6xxx.txt   |   7 -
 .../networking/devlink-params-nfp.txt         |   5 -
 .../devlink-params-ti-cpsw-switch.txt         |  10 -
 Documentation/networking/devlink-params.txt   |  71 -----
 .../networking/devlink-trap-netdevsim.rst     |  20 --
 Documentation/networking/devlink/bnxt.rst     |  41 +++
 .../networking/devlink/devlink-dpipe.rst      | 252 ++++++++++++++++++
 .../networking/devlink/devlink-health.rst     | 114 ++++++++
 .../networking/devlink/devlink-info.rst       |  94 +++++++
 .../networking/devlink/devlink-params.rst     | 108 ++++++++
 .../networking/devlink/devlink-region.rst     |  60 +++++
 .../networking/devlink/devlink-resource.rst   |  62 +++++
 .../networking/{ => devlink}/devlink-trap.rst |   2 +-
 Documentation/networking/devlink/index.rst    |  42 +++
 Documentation/networking/devlink/ionic.rst    |  29 ++
 Documentation/networking/devlink/mlx4.rst     |  56 ++++
 Documentation/networking/devlink/mlx5.rst     |  59 ++++
 Documentation/networking/devlink/mlxsw.rst    |  59 ++++
 .../networking/devlink/mv88e6xxx.rst          |  28 ++
 .../networking/devlink/netdevsim.rst          |  72 +++++
 Documentation/networking/devlink/nfp.rst      |  65 +++++
 Documentation/networking/devlink/qed.rst      |  26 ++
 .../networking/devlink/ti-cpsw-switch.rst     |  31 +++
 Documentation/networking/index.rst            |   4 +-
 MAINTAINERS                                   |   3 +-
 drivers/net/netdevsim/dev.c                   |   2 +-
 include/net/devlink.h                         |   6 +-
 33 files changed, 1208 insertions(+), 317 deletions(-)
 delete mode 100644 Documentation/networking/devlink-health.txt
 delete mode 100644 Documentation/networking/devlink-info-versions.rst
 delete mode 100644 Documentation/networking/devlink-params-bnxt.txt
 delete mode 100644 Documentation/networking/devlink-params-mlx5.txt
 delete mode 100644 Documentation/networking/devlink-params-mlxsw.txt
 delete mode 100644 Documentation/networking/devlink-params-mv88e6xxx.txt
 delete mode 100644 Documentation/networking/devlink-params-nfp.txt
 delete mode 100644 Documentation/networking/devlink-params-ti-cpsw-switch.txt
 delete mode 100644 Documentation/networking/devlink-params.txt
 delete mode 100644 Documentation/networking/devlink-trap-netdevsim.rst
 create mode 100644 Documentation/networking/devlink/bnxt.rst
 create mode 100644 Documentation/networking/devlink/devlink-dpipe.rst
 create mode 100644 Documentation/networking/devlink/devlink-health.rst
 create mode 100644 Documentation/networking/devlink/devlink-info.rst
 create mode 100644 Documentation/networking/devlink/devlink-params.rst
 create mode 100644 Documentation/networking/devlink/devlink-region.rst
 create mode 100644 Documentation/networking/devlink/devlink-resource.rst
 rename Documentation/networking/{ => devlink}/devlink-trap.rst (99%)
 create mode 100644 Documentation/networking/devlink/index.rst
 create mode 100644 Documentation/networking/devlink/ionic.rst
 create mode 100644 Documentation/networking/devlink/mlx4.rst
 create mode 100644 Documentation/networking/devlink/mlx5.rst
 create mode 100644 Documentation/networking/devlink/mlxsw.rst
 create mode 100644 Documentation/networking/devlink/mv88e6xxx.rst
 create mode 100644 Documentation/networking/devlink/netdevsim.rst
 create mode 100644 Documentation/networking/devlink/nfp.rst
 create mode 100644 Documentation/networking/devlink/qed.rst
 create mode 100644 Documentation/networking/devlink/ti-cpsw-switch.rst

-- 
2.25.0.rc1


             reply	other threads:[~2020-01-09 22:46 UTC|newest]

Thread overview: 22+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-01-09 22:46 Jacob Keller [this message]
2020-01-09 22:46 ` [PATCH 01/17] devlink: add macro for "fw.psid" Jacob Keller
2020-01-09 22:46 ` [PATCH 02/17] devlink: move devlink documentation to subfolder Jacob Keller
2020-01-09 22:46 ` [PATCH 03/17] devlink: convert devlink-health.txt to rst format Jacob Keller
2020-01-09 22:46 ` [PATCH 04/17] devlink: rename devlink-info-versions.rst and add a header Jacob Keller
2020-01-09 22:46 ` [PATCH 05/17] devlink: convert devlink-params.txt to reStructuredText Jacob Keller
2020-01-09 22:46 ` [PATCH 06/17] devlink: add documentation for generic devlink parameters Jacob Keller
2020-01-09 22:46 ` [PATCH 07/17] devlink: mention reloading in devlink-params.rst Jacob Keller
2020-01-09 22:46 ` [PATCH 08/17] devlink: convert driver-specific files to reStructuredText Jacob Keller
2020-01-09 22:46 ` [PATCH 09/17] devlink: document info versions for each driver Jacob Keller
2020-01-09 22:46 ` [PATCH 10/17] devlink: add parameter documentation for the mlx4 driver Jacob Keller
2020-01-09 22:46 ` [PATCH 11/17] devlink: add a driver-specific file for the qed driver Jacob Keller
2020-01-14  8:41   ` [EXT] " Michal Kalderon
2020-01-14 20:07     ` Jacob Keller
2020-01-09 22:46 ` [PATCH 12/17] devlink: add a file documenting devlink regions Jacob Keller
2020-01-09 22:46 ` [PATCH 13/17] devlink: add documentation for ionic device driver Jacob Keller
2020-01-09 22:57   ` Shannon Nelson
2020-01-09 22:46 ` [PATCH 14/17] devlink: rename and expand devlink-trap-netdevsim.rst Jacob Keller
2020-01-09 22:46 ` [PATCH 15/17] devlink: add a devlink-resource.rst documentation file Jacob Keller
2020-01-09 22:46 ` [PATCH 16/17] devlink: introduce devlink-dpipe.rst " Jacob Keller
2020-01-09 22:46 ` [PATCH 17/17] devlink: document region snapshot triggering from userspace Jacob Keller
2020-01-11  1:07 ` [PATCH 00/17] devlink documentation refactor David Miller

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20200109224625.1470433-1-jacob.e.keller@intel.com \
    --to=jacob.e.keller@intel.com \
    --cc=jiri@mellanox.com \
    --cc=netdev@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).