netdev.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Randy Dunlap <rdunlap@infradead.org>
To: Karoly Kemeny <karoly.kemeny@gmail.com>,
	netdev@vger.kernel.org, linux-doc@vger.kernel.org
Subject: Re: [PATCH v4] net: kernel-doc compliant documentation for net_device
Date: Wed, 30 Jul 2014 10:17:53 -0700	[thread overview]
Message-ID: <53D928C1.9070107@infradead.org> (raw)
In-Reply-To: <1406728663-3848-1-git-send-email-karoly.kemeny@gmail.com>

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@gmail.com>

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

Thank you.

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



-- 
~Randy

  reply	other threads:[~2014-07-30 17:17 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-07-30 13:57 [PATCH v4] net: kernel-doc compliant documentation for net_device Karoly Kemeny
2014-07-30 17:17 ` Randy Dunlap [this message]
2014-07-30 17:26 ` Florian Fainelli
  -- strict thread matches above, loose matches on Subject: below --
2014-07-30 18:27 Karoly Kemeny
2014-08-01  4:34 ` 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=53D928C1.9070107@infradead.org \
    --to=rdunlap@infradead.org \
    --cc=karoly.kemeny@gmail.com \
    --cc=linux-doc@vger.kernel.org \
    --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).