net: fix ndo_features_check/ndo_fix_features comment ordering
Subsystems (2)
PATCH 1/1 net: fix ndo_features_check/ndo_fix_features comment ordering
Commit cdba756f5803a2 ("net: move ndo_features_check() close to ndo_start_xmit()") inadvertently moved the doc comment for .ndo_fix_features instead of .ndo_features_check. Fix the comment ordering.
--- include/linux/netdevice.h | 29 +++++++++++++++-------------- 1 file changed, 15 insertions(+), 14 deletions(-)
include/linux/netdevice.h +15 -14
@@ -866,11 +866,15 @@ struct netdev_xdp {* of useless work if you return NETDEV_TX_BUSY. * Required; cannot be NULL. * -* netdev_features_t (*ndo_fix_features)(struct net_device *dev, -* netdev_features_t features); -* Adjusts the requested feature flags according to device-specific -* constraints, and returns the resulting flags. Must not modify -* the device state. +* netdev_features_t (*ndo_features_check)(struct sk_buff *skb, +* struct net_device *dev +* netdev_features_t features); +* Called by core transmit path to determine if device is capable of +* performing offload operations on a given packet. This is to give +* the device an opportunity to implement any restrictions that cannot +* be otherwise expressed by feature flags. The check is called with +* the set of features that the stack has calculated and it returns +* those the driver believes to be appropriate. * * u16 (*ndo_select_queue)(struct net_device *dev, struct sk_buff *skb, * void *accel_priv, select_queue_fallback_t fallback);
@@ -1028,6 +1032,12 @@ struct netdev_xdp {* Called to release previously enslaved netdev. * * Feature/offload setting functions. +* netdev_features_t (*ndo_fix_features)(struct net_device *dev, +* netdev_features_t features); +* Adjusts the requested feature flags according to device-specific +* constraints, and returns the resulting flags. Must not modify +* the device state. +* * int (*ndo_set_features)(struct net_device *dev, netdev_features_t features); * Called to update device configuration to new features. Passed * feature set might be less than what was returned by ndo_fix_features()).
@@ -1100,15 +1110,6 @@ struct netdev_xdp {* Callback to use for xmit over the accelerated station. This * is used in place of ndo_start_xmit on accelerated net * devices. -* netdev_features_t (*ndo_features_check)(struct sk_buff *skb, -* struct net_device *dev -* netdev_features_t features); -* Called by core transmit path to determine if device is capable of -* performing offload operations on a given packet. This is to give -* the device an opportunity to implement any restrictions that cannot -* be otherwise expressed by feature flags. The check is called with -* the set of features that the stack has calculated and it returns -* those the driver believes to be appropriate. * int (*ndo_set_tx_maxrate)(struct net_device *dev, * int queue_index, u32 maxrate); * Called when a user wants to set a max-rate limitation of specific
Signature · 1 line
2.11.0.483.g087da7b7c-goog
Quoted 8 lines · Dimitris Michailidis
Commit
cdba756f5803a2("net: movendo_features_check()close tondo_start_xmit()") inadvertently moved the doc comment for .ndo_fix_features instead of .ndo_features_check. Fix the comment ordering.Fixes cdba756f5803a2 ("net: move ndo_features_check() close to ndo_start_xmit()")Signed-off-by Dimitris Michailidis <[email protected]>---
LGTM
I am currently doing a reorg of net_device fields to improve locality, I am not sure I will touch comments. We might do this later when things are stabilized.
From: Dimitris Michailidis <[email protected]>
Date: Tue, 31 Jan 2017 16:03:13 -0800
Quoted 7 lines
Commit
cdba756f5803a2("net: movendo_features_check()close tondo_start_xmit()") inadvertently moved the doc comment for .ndo_fix_features instead of .ndo_features_check. Fix the comment ordering.Fixes cdba756f5803a2 ("net: move ndo_features_check() close to ndo_start_xmit()")Signed-off-by Dimitris Michailidis <[email protected]>
Applied, thank you.