]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/commit
devlink: expand the devlink-info documentation
authorJakub Kicinski <kuba@kernel.org>
Tue, 24 Mar 2020 17:30:16 +0000 (10:30 -0700)
committerDavid S. Miller <davem@davemloft.net>
Tue, 24 Mar 2020 23:47:33 +0000 (16:47 -0700)
commitcd556e40fdf3b09e229097021a9148ecb6e7725e
tree4e4398dc821eb0e819f0b2e955ec3f8771f39914
parent2283a02b67d41251a80857121e36845161fc57b5
devlink: expand the devlink-info documentation

We are having multiple review cycles with all vendors trying
to implement devlink-info. Let's expand the documentation with
more information about what's implemented and motivation behind
this interface in an attempt to make the implementations easier.

Describe what each info section is supposed to contain, and make
some references to other HW interfaces (PCI caps).

Document how firmware management is expected to look, to make
it clear how devlink-info and devlink-flash work in concert.

Name some future work.

v2: - improve wording
v3: - improve wording

Signed-off-by: Jakub Kicinski <kuba@kernel.org>
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: David S. Miller <davem@davemloft.net>
Documentation/networking/devlink/devlink-flash.rst [new file with mode: 0644]
Documentation/networking/devlink/devlink-info.rst
Documentation/networking/devlink/devlink-params.rst
Documentation/networking/devlink/index.rst