netdev - [PATCH net-next 00/14] ethtool: Improve documentation

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Date:	Wed, 12 Feb 2014 22:13:04 +0000
From:	Ben Hutchings <ben@...adent.org.uk>
To:	David Miller <davem@...emloft.net>
Cc:	netdev@...r.kernel.org
Subject: [PATCH net-next 00/14] ethtool: Improve documentation

This series converts most comments in <linux/ethtool.h> into kernel-doc
format, and expands them to describe the semantics as well as I
understand them.  It also fixes some kernel-doc formatting errors.

I started on this at Solarflare, but they graciously allowed me to take
it away and finish it off.

Ben.

Ben Hutchings (14):
  ethtool: Expand documentation of struct ethtool_cmd
  ethtool: Expand documentation of struct ethtool_drvinfo
  ethtool: Expand documentation of struct ethtool_wol
  ethtool: Expand documentation of struct ethtool_regs
  ethtool: Expand documentation of struct ethtool_eeprom
  ethtool: Expand documentation of struct ethtool_ringparam
  ethtool: Update documentation of struct ethtool_pauseparam
  ethtool: Expand documentation of string set types
  ethtool: Expand documentation of struct ethtool_test
  ethtool: Expand documentation of struct ethtool_stats
  ethtool: Expand documentation of struct ethtool_perm_addr
  ethtool: Document the general convention for VLAs in kernel space
  ethtool: Move kernel-doc comment next to struct ethtool_dump
    definition
  ethtool: Fix unwanted section breaks in kernel-doc

 include/linux/ethtool.h      |   3 +
 include/uapi/linux/ethtool.h | 439 ++++++++++++++++++++++++++++++++-----------
 2 files changed, 329 insertions(+), 113 deletions(-)


-- 
Ben Hutchings
If more than one person is responsible for a bug, no one is at fault.

Download attachment "signature.asc" of type "application/pgp-signature" (812 bytes)