netdev - Re: [PATCH v4] net: kernel-doc compliant documentation for net

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 for Android: free password hash cracker in your pocket

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

Date:	Wed, 30 Jul 2014 10:17:53 -0700
From:	Randy Dunlap <rdunlap@...radead.org>
To:	Karoly Kemeny <karoly.kemeny@...il.com>, netdev@...r.kernel.org,
	linux-doc@...r.kernel.org
Subject: Re: [PATCH v4] net: kernel-doc compliant documentation for net_device

On 07/30/14 06:57, Karoly Kemeny wrote:
> Net_device is a vast and important structure, but it has no kernel-doc
> compliant documentation. This patch extracts the comments from the structure
> to clean it up, and let the scripts extract documentation from it. I know that
> the patch is big, but it's just reordering of comments into the appropriate 
> form, and adding a few more, for the missing members.
> 
> v2: 
> Additional documentation added for some members (gflags,neigh_priv_len,
> queues_kset, uc_promisc, promiscuity, allmulti, _rx, _tx, watchdog_timer,
> rtnl_link_state, tstats, gso_max_size, gso_max_segs, num_tc, pm_qos_req).
> Cleaned up trailing whitespaces and blank lines.
> Fixed the beginning to indicate kernel-doc notation.
> 
> v3:
> Fixed typos.
> Added documentation for npinfo and stats
> 
> v4:
> Fixed further typos pointed out by Nikolay
> 
> Signed-off-by: Karoly Kemeny <karoly.kemeny@...il.com>

Acked-by: Randy Dunlap <rdunlap@...radead.org>

Thank you.

> ---
>  include/linux/netdevice.h | 381 ++++++++++++++++++++++++++++++----------------
>  1 file changed, 250 insertions(+), 131 deletions(-)



-- 
~Randy
--
To unsubscribe from this list: send the line "unsubscribe netdev" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html