net: bonding: bond_3ad: Fix a bunch of kerneldoc parameter issues

Renames and missing descriptions.

Fixes the following W=1 kernel build warning(s):

 drivers/net/bonding/bond_3ad.c:140: warning: Function parameter or member 'port' not described in '__get_first_agg'
 drivers/net/bonding/bond_3ad.c:140: warning: Excess function parameter 'bond' description in '__get_first_agg'
 drivers/net/bonding/bond_3ad.c:1655: warning: Function parameter or member 'agg' not described in 'ad_agg_selection_logic'
 drivers/net/bonding/bond_3ad.c:1655: warning: Excess function parameter 'aggregator' description in 'ad_agg_selection_logic'
 drivers/net/bonding/bond_3ad.c:1817: warning: Function parameter or member 'port' not described in 'ad_initialize_port'
 drivers/net/bonding/bond_3ad.c:1817: warning: Excess function parameter 'aggregator' description in 'ad_initialize_port'
 drivers/net/bonding/bond_3ad.c:1976: warning: Function parameter or member 'timeout' not described in 'bond_3ad_initiate_agg_selection'
 drivers/net/bonding/bond_3ad.c:2274: warning: Function parameter or member 'work' not described in 'bond_3ad_state_machine_handler'
 drivers/net/bonding/bond_3ad.c:2274: warning: Excess function parameter 'bond' description in 'bond_3ad_state_machine_handler'
 drivers/net/bonding/bond_3ad.c:2508: warning: Function parameter or member 'link' not described in 'bond_3ad_handle_link_change'
 drivers/net/bonding/bond_3ad.c:2508: warning: Excess function parameter 'status' description in 'bond_3ad_handle_link_change'
 drivers/net/bonding/bond_3ad.c:2566: warning: Function parameter or member 'bond' not described in 'bond_3ad_set_carrier'
 drivers/net/bonding/bond_3ad.c:2677: warning: Function parameter or member 'bond' not described in 'bond_3ad_update_lacp_rate'
 drivers/net/bonding/bond_3ad.c:1655: warning: Function parameter or member 'agg' not described in 'ad_agg_selection_logic'
 drivers/net/bonding/bond_3ad.c:1655: warning: Excess function parameter 'aggregator' description in 'ad_agg_selection_logic'
 drivers/net/bonding/bond_3ad.c:1817: warning: Function parameter or member 'port' not described in 'ad_initialize_port'
 drivers/net/bonding/bond_3ad.c:1817: warning: Excess function parameter 'aggregator' description in 'ad_initialize_port'
 drivers/net/bonding/bond_3ad.c:1976: warning: Function parameter or member 'timeout' not described in 'bond_3ad_initiate_agg_selection'
 drivers/net/bonding/bond_3ad.c:2274: warning: Function parameter or member 'work' not described in 'bond_3ad_state_machine_handler'
 drivers/net/bonding/bond_3ad.c:2274: warning: Excess function parameter 'bond' description in 'bond_3ad_state_machine_handler'
 drivers/net/bonding/bond_3ad.c:2508: warning: Function parameter or member 'link' not described in 'bond_3ad_handle_link_change'
 drivers/net/bonding/bond_3ad.c:2508: warning: Excess function parameter 'status' description in 'bond_3ad_handle_link_change'
 drivers/net/bonding/bond_3ad.c:2566: warning: Function parameter or member 'bond' not described in 'bond_3ad_set_carrier'
 drivers/net/bonding/bond_3ad.c:2677: warning: Function parameter or member 'bond' not described in 'bond_3ad_update_lacp_rate'

Cc: Jay Vosburgh <j.vosburgh@gmail.com>
Cc: Veaceslav Falico <vfalico@gmail.com>
Cc: Andy Gospodarek <andy@greyhouse.net>
Cc: "David S. Miller" <davem@davemloft.net>
Cc: Jakub Kicinski <kuba@kernel.org>
Cc: netdev@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
Signed-off-by: David S. Miller <davem@davemloft.net>
This commit is contained in:
Lee Jones 2020-08-14 12:39:04 +01:00 committed by David S. Miller
parent 77b981c82c
commit a35e547877
1 changed files with 8 additions and 7 deletions

View File

@ -130,7 +130,7 @@ static inline struct bonding *__get_bond_by_port(struct port *port)
/** /**
* __get_first_agg - get the first aggregator in the bond * __get_first_agg - get the first aggregator in the bond
* @bond: the bond we're looking at * @port: the port we're looking at
* *
* Return the aggregator of the first slave in @bond, or %NULL if it can't be * Return the aggregator of the first slave in @bond, or %NULL if it can't be
* found. * found.
@ -1626,7 +1626,7 @@ static int agg_device_up(const struct aggregator *agg)
/** /**
* ad_agg_selection_logic - select an aggregation group for a team * ad_agg_selection_logic - select an aggregation group for a team
* @aggregator: the aggregator we're looking at * @agg: the aggregator we're looking at
* @update_slave_arr: Does slave array need update? * @update_slave_arr: Does slave array need update?
* *
* It is assumed that only one aggregator may be selected for a team. * It is assumed that only one aggregator may be selected for a team.
@ -1810,7 +1810,7 @@ static void ad_initialize_agg(struct aggregator *aggregator)
/** /**
* ad_initialize_port - initialize a given port's parameters * ad_initialize_port - initialize a given port's parameters
* @aggregator: the aggregator we're looking at * @port: the port we're looking at
* @lacp_fast: boolean. whether fast periodic should be used * @lacp_fast: boolean. whether fast periodic should be used
*/ */
static void ad_initialize_port(struct port *port, int lacp_fast) static void ad_initialize_port(struct port *port, int lacp_fast)
@ -1967,6 +1967,7 @@ static void ad_marker_response_received(struct bond_marker *marker,
/** /**
* bond_3ad_initiate_agg_selection - initate aggregator selection * bond_3ad_initiate_agg_selection - initate aggregator selection
* @bond: bonding struct * @bond: bonding struct
* @timeout: timeout value to set
* *
* Set the aggregation selection timer, to initiate an agg selection in * Set the aggregation selection timer, to initiate an agg selection in
* the very near future. Called during first initialization, and during * the very near future. Called during first initialization, and during
@ -2259,7 +2260,7 @@ void bond_3ad_update_ad_actor_settings(struct bonding *bond)
/** /**
* bond_3ad_state_machine_handler - handle state machines timeout * bond_3ad_state_machine_handler - handle state machines timeout
* @bond: bonding struct to work on * @work: work context to fetch bonding struct to work on from
* *
* The state machine handling concept in this module is to check every tick * The state machine handling concept in this module is to check every tick
* which state machine should operate any function. The execution order is * which state machine should operate any function. The execution order is
@ -2500,7 +2501,7 @@ void bond_3ad_adapter_speed_duplex_changed(struct slave *slave)
/** /**
* bond_3ad_handle_link_change - handle a slave's link status change indication * bond_3ad_handle_link_change - handle a slave's link status change indication
* @slave: slave struct to work on * @slave: slave struct to work on
* @status: whether the link is now up or down * @link: whether the link is now up or down
* *
* Handle reselection of aggregator (if needed) for this port. * Handle reselection of aggregator (if needed) for this port.
*/ */
@ -2551,7 +2552,7 @@ void bond_3ad_handle_link_change(struct slave *slave, char link)
/** /**
* bond_3ad_set_carrier - set link state for bonding master * bond_3ad_set_carrier - set link state for bonding master
* @bond - bonding structure * @bond: bonding structure
* *
* if we have an active aggregator, we're up, if not, we're down. * if we have an active aggregator, we're up, if not, we're down.
* Presumes that we cannot have an active aggregator if there are * Presumes that we cannot have an active aggregator if there are
@ -2664,7 +2665,7 @@ int bond_3ad_lacpdu_recv(const struct sk_buff *skb, struct bonding *bond,
/** /**
* bond_3ad_update_lacp_rate - change the lacp rate * bond_3ad_update_lacp_rate - change the lacp rate
* @bond - bonding struct * @bond: bonding struct
* *
* When modify lacp_rate parameter via sysfs, * When modify lacp_rate parameter via sysfs,
* update actor_oper_port_state of each port. * update actor_oper_port_state of each port.