> -----Original Message----- > From: [email protected] [mailto:ovs-dev- > [email protected]] On Behalf Of Ilya Maximets > Sent: Tuesday, November 7, 2017 1:17 PM > To: [email protected] > Cc: Ilya Maximets <[email protected]>; Heetae Ahn > <[email protected]> > Subject: [ovs-dev] [PATCH 2/2] netdev-dpdk: Add comment about variables > naming convention. >
Hi Ilya, This looks good and will be useful in future as a reference. Minor nit would be I'd like to see the commit message expanded upon, maybe mentioning which variables are documented etc. to make the commit message more robust. Will look to add this to the DPDK merge branch then. Thanks Ian > Signed-off-by: Ilya Maximets <[email protected]> > --- > lib/netdev-dpdk.c | 17 +++++++++++++++++ > 1 file changed, 17 insertions(+) > > diff --git a/lib/netdev-dpdk.c b/lib/netdev-dpdk.c index 872b133..9423109 > 100644 > --- a/lib/netdev-dpdk.c > +++ b/lib/netdev-dpdk.c > @@ -330,6 +330,23 @@ enum dpdk_hw_ol_features { > NETDEV_RX_CHECKSUM_OFFLOAD = 1 << 0, }; > > +/* > + * In order to avoid confusion in variables names, following naming > +convention > + * should be used, if possible: > + * > + * 'struct netdev' : 'netdev' > + * 'struct netdev_dpdk' : 'dev' > + * 'struct netdev_rxq' : 'rxq' > + * 'struct netdev_rxq_dpdk' : 'rx' > + * > + * Example: > + * struct netdev *netdev = netdev_from_name(name); > + * struct netdev_dpdk *dev = netdev_dpdk_cast(netdev); > + * > + * Also, 'netdev' should be used instead of 'dev->up', where 'netdev' > +was > + * already defined. > + */ > + > struct netdev_dpdk { > PADDED_MEMBERS_CACHELINE_MARKER(CACHE_LINE_SIZE, cacheline0, > dpdk_port_t port_id; > -- > 2.7.4 > > _______________________________________________ > dev mailing list > [email protected] > https://mail.openvswitch.org/mailman/listinfo/ovs-dev _______________________________________________ dev mailing list [email protected] https://mail.openvswitch.org/mailman/listinfo/ovs-dev
