[ovs-dev] [PATCH v2 2/2] netdev-dpdk: Add comment about variables naming convention.
Ilya Maximets
i.maximets at samsung.com
Thu Nov 23 13:48:26 UTC 2017
It'll be nice to document current naming convention for variables of
the following types used in netdev-dpdk:
* netdev
* netdev_dpdk
* netdev_rxq
* netdev_rxq_dpdk
to be sure that we will not return to chaos which was before
commit d46285a2206f ("netdev-dpdk: Consistent variable naming.").
Signed-off-by: Ilya Maximets <i.maximets at samsung.com>
---
lib/netdev-dpdk.c | 17 +++++++++++++++++
1 file changed, 17 insertions(+)
diff --git a/lib/netdev-dpdk.c b/lib/netdev-dpdk.c
index 647a9b2..4b42c08 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
More information about the dev
mailing list