diff mbox series

[09/30] net: wireless: ath: ath5k: pcu: Add a description for 'band' remove one for 'mode'

Message ID 20200814113933.1903438-10-lee.jones@linaro.org
State New
Headers show
Series [01/30] net: bonding: bond_3ad: Fix a bunch of kerneldoc parameter issues | expand

Commit Message

Lee Jones Aug. 14, 2020, 11:39 a.m. UTC
Fixes the following W=1 kernel build warning(s):

 drivers/net/wireless/ath/ath5k/pcu.c:115: warning: Function parameter or member 'band' not described in 'ath5k_hw_get_frame_duration'
 drivers/net/wireless/ath/ath5k/pcu.c:955: warning: Excess function parameter 'mode' description in 'ath5k_hw_pcu_init'

Cc: Jiri Slaby <jirislaby@kernel.org>
Cc: Nick Kossifidis <mickflemm@gmail.com>
Cc: Luis Chamberlain <mcgrof@kernel.org>
Cc: Kalle Valo <kvalo@codeaurora.org>
Cc: "David S. Miller" <davem@davemloft.net>
Cc: Jakub Kicinski <kuba@kernel.org>
Cc: Reyk Floeter <reyk@openbsd.org>
Cc: "W. S. Bell" <mentor@madwifi.org>
Cc: Luis Rodriguez <mcgrof@winlab.rutgers.edu>
Cc: Pavel Roskin <proski@gnu.org>
Cc: linux-wireless@vger.kernel.org
Cc: netdev@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>

---
 drivers/net/wireless/ath/ath5k/pcu.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

-- 
2.25.1

Comments

Kalle Valo Aug. 17, 2020, 10:20 a.m. UTC | #1
Lee Jones <lee.jones@linaro.org> wrote:

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

> 

>  drivers/net/wireless/ath/ath5k/pcu.c:115: warning: Function parameter or member 'band' not described in 'ath5k_hw_get_frame_duration'

>  drivers/net/wireless/ath/ath5k/pcu.c:955: warning: Excess function parameter 'mode' description in 'ath5k_hw_pcu_init'

> 

> Cc: Jiri Slaby <jirislaby@kernel.org>

> Cc: Nick Kossifidis <mickflemm@gmail.com>

> Cc: Luis Chamberlain <mcgrof@kernel.org>

> Cc: Kalle Valo <kvalo@codeaurora.org>

> Cc: "David S. Miller" <davem@davemloft.net>

> Cc: Jakub Kicinski <kuba@kernel.org>

> Cc: Reyk Floeter <reyk@openbsd.org>

> Cc: "W. S. Bell" <mentor@madwifi.org>

> Cc: Luis Rodriguez <mcgrof@winlab.rutgers.edu>

> Cc: Pavel Roskin <proski@gnu.org>

> Cc: linux-wireless@vger.kernel.org

> Cc: netdev@vger.kernel.org

> Signed-off-by: Lee Jones <lee.jones@linaro.org>

> Signed-off-by: Kalle Valo <kvalo@codeaurora.org>


3 patches applied to ath-next branch of ath.git, thanks.

3a059c76f4eb ath5k: pcu: Add a description for 'band' remove one for 'mode'
691c7a4d4fd7 wil6210: Demote non-kerneldoc headers to standard comment blocks
1d4f5c15cf65 ath5k: Fix kerneldoc formatting issue

-- 
https://patchwork.kernel.org/patch/11714405/

https://wireless.wiki.kernel.org/en/developers/documentation/submittingpatches
diff mbox series

Patch

diff --git a/drivers/net/wireless/ath/ath5k/pcu.c b/drivers/net/wireless/ath/ath5k/pcu.c
index 05140d8baa360..627bfd9f484a8 100644
--- a/drivers/net/wireless/ath/ath5k/pcu.c
+++ b/drivers/net/wireless/ath/ath5k/pcu.c
@@ -101,6 +101,7 @@  static const unsigned int ack_rates_high[] =
 /**
  * ath5k_hw_get_frame_duration() - Get tx time of a frame
  * @ah: The &struct ath5k_hw
+ * @band: One of enum nl80211_band
  * @len: Frame's length in bytes
  * @rate: The @struct ieee80211_rate
  * @shortpre: Indicate short preample
@@ -945,7 +946,6 @@  ath5k_hw_set_opmode(struct ath5k_hw *ah, enum nl80211_iftype op_mode)
  * ath5k_hw_pcu_init() - Initialize PCU
  * @ah: The &struct ath5k_hw
  * @op_mode: One of enum nl80211_iftype
- * @mode: One of enum ath5k_driver_mode
  *
  * This function is used to initialize PCU by setting current
  * operation mode and various other settings.