From: Eric Dumazet <eric.dumazet@gmail.com>
To: Veaceslav Falico <vfalico@redhat.com>
Cc: Ben Hutchings <bhutchings@solarflare.com>,
netdev@vger.kernel.org, jiri@resnulli.us,
"David S. Miller" <davem@davemloft.net>,
Eric Dumazet <edumazet@google.com>,
Alexander Duyck <alexander.h.duyck@intel.com>
Subject: Re: [PATCH v3 net-next 07/27] net: add for_each iterators through neighbour lower link's private
Date: Tue, 17 Sep 2013 04:43:02 -0700 [thread overview]
Message-ID: <1379418182.3457.2.camel@edumazet-glaptop> (raw)
In-Reply-To: <20130917073618.GC18195@redhat.com>
On Tue, 2013-09-17 at 09:36 +0200, Veaceslav Falico wrote:
> On Tue, Sep 17, 2013 at 02:26:43AM +0100, Ben Hutchings wrote:
> >On Tue, 2013-09-17 at 02:46 +0200, Veaceslav Falico wrote:
> >[...]
> >> --- a/net/core/dev.c
> >> +++ b/net/core/dev.c
> >> @@ -4537,6 +4537,72 @@ struct net_device *netdev_all_upper_get_next_dev_rcu(struct net_device *dev,
> >> }
> >> EXPORT_SYMBOL(netdev_all_upper_get_next_dev_rcu);
> >>
> >> +/* netdev_lower_get_next_private - Get the next ->private from the
> >> + * lower neighbour list
> >[...]
> >
> >This is not correct kernel-doc syntax. You must begin the comment like
> >this:
> >
> >/**
> > * function_name - summary on one physical line, no wrapping allowed
>
> I've thought that netdev specifically requires that type of comments*. But
> I don't have any strong opinion on that, so if needed - can change easily
> in the next version.
>
> Thanks a lot!
>
> *Documentation/networking/netdev-FAQ.txt
>
> Q: Someone said that the comment style and coding convention is different
> for the networking content. Is this true?
>
> A: Yes, in a largely trivial way. Instead of this:
>
> /*
> * foobar blah blah blah
> * another line of text
> */
>
> it is requested that you make it look like this:
>
> /* foobar blah blah blah
> * another line of text
> */
>
>
Thats for comments, not kernel-doc sections.
You provided :
+/* netdev_lower_get_next_private - Get the next ->private from the
+ * lower neighbour list
+ * @dev: device
+ * @iter: list_head ** of the current position
+ *
+ * Gets the next netdev_adjacent->private from the dev's lower neighbour
+ * list, starting from iter position. The caller must hold either hold the
+ * RTNL lock or its own locking that guarantees that the neighbour lower
+ * list will remain unchainged. If iter is NULL - return the first private.
+ */
Which really looks like a kernel-doc section,
but misses the proper delimiter which is :
/**
Not
/*
next prev parent reply other threads:[~2013-09-17 11:43 UTC|newest]
Thread overview: 37+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-09-17 0:46 [PATCH v3 net-next 00/27] bonding: use neighbours instead of own lists Veaceslav Falico
2013-09-17 0:46 ` [PATCH v3 net-next 01/27] net: add adj_list to save only neighbours Veaceslav Falico
2013-09-17 0:46 ` [PATCH v3 net-next 02/27] net: add RCU variant to search for netdev_adjacent link Veaceslav Falico
2013-09-17 1:23 ` Ben Hutchings
2013-09-17 7:34 ` Veaceslav Falico
2013-09-17 0:46 ` [PATCH v3 net-next 03/27] net: uninline netdev neighbour functions Veaceslav Falico
2013-09-17 0:46 ` [PATCH v3 net-next 04/27] net: add netdev_adjacent->private and allow to use it Veaceslav Falico
2013-09-17 0:46 ` [PATCH v3 net-next 05/27] bonding: populate neighbour's private on enslave Veaceslav Falico
2013-09-17 0:46 ` [PATCH v3 net-next 06/27] bonding: modify bond_get_slave_by_dev() to use neighbours Veaceslav Falico
2013-09-17 0:46 ` [PATCH v3 net-next 07/27] net: add for_each iterators through neighbour lower link's private Veaceslav Falico
2013-09-17 1:26 ` Ben Hutchings
2013-09-17 7:36 ` Veaceslav Falico
2013-09-17 11:43 ` Eric Dumazet [this message]
2013-09-17 12:29 ` Veaceslav Falico
2013-09-17 0:46 ` [PATCH v3 net-next 08/27] bonding: remove bond_for_each_slave_continue_reverse() Veaceslav Falico
2013-09-17 0:46 ` [PATCH v3 net-next 09/27] bonding: make bond_for_each_slave() use lower neighbour's private Veaceslav Falico
2013-09-17 0:46 ` [PATCH v3 net-next 10/27] bonding: use bond_for_each_slave() in bond_uninit() Veaceslav Falico
2013-09-18 9:53 ` Veaceslav Falico
2013-09-17 0:46 ` [PATCH v3 net-next 11/27] bonding: rework bond_3ad_xmit_xor() to use bond_for_each_slave() only Veaceslav Falico
2013-09-17 0:46 ` [PATCH v3 net-next 12/27] bonding: rework rlb_next_rx_slave() to use bond_for_each_slave() Veaceslav Falico
2013-09-17 0:46 ` [PATCH v3 net-next 13/27] bonding: rework bond_find_best_slave() " Veaceslav Falico
2013-09-17 0:46 ` [PATCH v3 net-next 14/27] bonding: rework bond_ab_arp_probe() " Veaceslav Falico
2013-09-17 0:46 ` [PATCH v3 net-next 15/27] bonding: remove unused bond_for_each_slave_from() Veaceslav Falico
2013-09-17 0:46 ` [PATCH v3 net-next 16/27] bonding: add bond_has_slaves() and use it Veaceslav Falico
2013-09-17 0:46 ` [PATCH v3 net-next 17/27] bonding: convert bond_has_slaves() to use the neighbour list Veaceslav Falico
2013-09-17 0:46 ` [PATCH v3 net-next 18/27] net: add a possibility to get private from netdev_adjacent->list Veaceslav Falico
2013-09-17 0:46 ` [PATCH v3 net-next 19/27] bonding: convert first/last slave logic to use neighbours Veaceslav Falico
2013-09-17 0:46 ` [PATCH v3 net-next 20/27] bonding: remove bond_prev_slave() Veaceslav Falico
2013-09-17 0:46 ` [PATCH v3 net-next 21/27] net: add a function to get the next private Veaceslav Falico
2013-09-17 1:50 ` Ben Hutchings
2013-09-17 13:55 ` Veaceslav Falico
2013-09-17 0:46 ` [PATCH v3 net-next 22/27] bonding: use neighbours for bond_next_slave() Veaceslav Falico
2013-09-17 0:46 ` [PATCH v3 net-next 23/27] bonding: remove slave lists Veaceslav Falico
2013-09-17 0:46 ` [PATCH v3 net-next 24/27] vlan: link the upper neighbour only after registering Veaceslav Falico
2013-09-17 0:46 ` [PATCH v3 net-next 25/27] vlan: unlink the upper neighbour before unregistering Veaceslav Falico
2013-09-17 0:46 ` [PATCH v3 net-next 26/27] net: expose the master link to sysfs, and remove it from bond Veaceslav Falico
2013-09-17 0:46 ` [PATCH v3 net-next 27/27] net: create sysfs symlinks for neighbour devices Veaceslav Falico
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=1379418182.3457.2.camel@edumazet-glaptop \
--to=eric.dumazet@gmail.com \
--cc=alexander.h.duyck@intel.com \
--cc=bhutchings@solarflare.com \
--cc=davem@davemloft.net \
--cc=edumazet@google.com \
--cc=jiri@resnulli.us \
--cc=netdev@vger.kernel.org \
--cc=vfalico@redhat.com \
/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