ethtool: Expand documentation of struct ethtool_cmd
authorBen Hutchings <ben@decadent.org.uk>
Wed, 12 Feb 2014 22:13:57 +0000 (22:13 +0000)
committerDavid S. Miller <davem@davemloft.net>
Wed, 12 Feb 2014 22:33:01 +0000 (17:33 -0500)
commitbf8fc60a62db3fa99d2ded50e68bf3e5be027ebe
tree39e5fe5134b8f28c6d7797c1efe0d560e8e62a5c
parent738b52bb9845da183b6ff46a8f685b56a63379d1
ethtool: Expand documentation of struct ethtool_cmd

struct ethtool_cmd has very limited documentation; it contains
several obscure or obsolete fields and several with non-obvious
interpretation.

Replace the inline comments (and some others below) with a full
explanation of the semantics as well as I understand them, in
kernel-doc format.  Formally deprecate some fields that seem to be of
historical use only.

Extend the comment about 32/64-bit compatibility to cover all
ethtool structures.

Signed-off-by: Ben Hutchings <ben@decadent.org.uk>
Signed-off-by: David S. Miller <davem@davemloft.net>
include/uapi/linux/ethtool.h