All of lore.kernel.org
 help / color / mirror / Atom feed
From: Lee Jones <lee.jones@linaro.org>
To: kvalo@codeaurora.org, davem@davemloft.net, kuba@kernel.org
Cc: linux-kernel@vger.kernel.org, linux-wireless@vger.kernel.org,
	netdev@vger.kernel.org, Lee Jones <lee.jones@linaro.org>,
	Amitkumar Karwar <amitkarwar@gmail.com>,
	Siva Rebbagondla <siva8118@gmail.com>
Subject: [PATCH 02/28] wireless: rsi_91x_main: Fix some kernel-doc issues
Date: Wed, 19 Aug 2020 08:23:36 +0100	[thread overview]
Message-ID: <20200819072402.3085022-3-lee.jones@linaro.org> (raw)
In-Reply-To: <20200819072402.3085022-1-lee.jones@linaro.org>

The file header should not be kernel-doc.  Add missing 'rec_pkt'
description.  Update 'rsi_91x_init()'s parameter description.

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

 drivers/net/wireless/rsi/rsi_91x_main.c:17: warning: Function parameter or member 'fmt' not described in 'pr_fmt'
 drivers/net/wireless/rsi/rsi_91x_main.c:156: warning: Function parameter or member 'rx_pkt' not described in 'rsi_read_pkt'
 drivers/net/wireless/rsi/rsi_91x_main.c:287: warning: Function parameter or member 'oper_mode' not described in 'rsi_91x_init'
 drivers/net/wireless/rsi/rsi_91x_main.c:287: warning: Excess function parameter 'void' description in 'rsi_91x_init'

Cc: Amitkumar Karwar <amitkarwar@gmail.com>
Cc: Siva Rebbagondla <siva8118@gmail.com>
Cc: Kalle Valo <kvalo@codeaurora.org>
Cc: "David S. Miller" <davem@davemloft.net>
Cc: Jakub Kicinski <kuba@kernel.org>
Cc: linux-wireless@vger.kernel.org
Cc: netdev@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/net/wireless/rsi/rsi_91x_main.c | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/drivers/net/wireless/rsi/rsi_91x_main.c b/drivers/net/wireless/rsi/rsi_91x_main.c
index 29d83049c5f56..576f51f9b4a7e 100644
--- a/drivers/net/wireless/rsi/rsi_91x_main.c
+++ b/drivers/net/wireless/rsi/rsi_91x_main.c
@@ -1,4 +1,4 @@
-/**
+/*
  * Copyright (c) 2014 Redpine Signals Inc.
  *
  * Permission to use, copy, modify, and/or distribute this software for any
@@ -148,6 +148,7 @@ static struct sk_buff *rsi_prepare_skb(struct rsi_common *common,
 /**
  * rsi_read_pkt() - This function reads frames from the card.
  * @common: Pointer to the driver private structure.
+ * @rcv_pkt: Received pkt.
  * @rcv_pkt_len: Received pkt length. In case of USB it is 0.
  *
  * Return: 0 on success, -1 on failure.
@@ -279,7 +280,7 @@ void rsi_set_bt_context(void *priv, void *bt_context)
 
 /**
  * rsi_91x_init() - This function initializes os interface operations.
- * @void: Void.
+ * @oper_mode: One of DEV_OPMODE_*.
  *
  * Return: Pointer to the adapter structure on success, NULL on failure .
  */
-- 
2.25.1


  parent reply	other threads:[~2020-08-19  7:30 UTC|newest]

Thread overview: 41+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-08-19  7:23 [PATCH 00/28] Rid W=1 warnings in Wireless Lee Jones
2020-08-19  7:23 ` [PATCH 01/28] wireless: intersil: hostap: Mark 'freq_list' as __maybe_unused Lee Jones
2020-09-01  9:03   ` [01/28] " Kalle Valo
2020-08-19  7:23 ` Lee Jones [this message]
2020-08-19  7:23 ` [PATCH 03/28] wireless: rsi_91x_core: File header should not be kernel-doc Lee Jones
2020-08-19  7:23 ` [PATCH 04/28] wireless: marvell: libertas_tf: Demote non-conformant kernel-doc headers Lee Jones
2020-08-19  7:23 ` [PATCH 05/28] wireless: intel: dvm: Demote non-compliant " Lee Jones
2020-08-19  7:23 ` [PATCH 06/28] wireless: ti: wlcore: cmd: Fix some parameter description disparities Lee Jones
2020-08-19  7:23 ` [PATCH 07/28] wireless: marvell: libertas_tf: Fix a bunch of function doc formatting issues Lee Jones
2020-08-19  7:23 ` [PATCH 08/28] wireless: intel: iwlwifi: rs: Demote non-compliant kernel-doc headers Lee Jones
2020-08-19  7:23 ` [PATCH 09/28] wireless: intel: iwlegacy: debug: Demote seemingly unintentional kerneldoc header Lee Jones
2020-08-19  7:23 ` [PATCH 10/28] wireless: intel: iwlwifi: dvm: tx: Demote non-compliant kernel-doc headers Lee Jones
2020-08-19  7:23 ` [PATCH 11/28] wireless: intersil: hostap: hostap_ap: Mark 'txt' as __always_unused Lee Jones
2020-08-19  7:23 ` [PATCH 12/28] wireless: intel: iwlwifi: dvm: lib: Demote non-compliant kernel-doc headers Lee Jones
2020-08-19  7:23 ` [PATCH 13/28] wireless: st: cw1200: wsm: Remove 'dummy' variables Lee Jones
2020-08-19  7:23 ` [PATCH 14/28] wireless: marvell: libertas: Fix 'timer_list' stored private data related dot-rot Lee Jones
2020-08-19  7:23 ` [PATCH 15/28] wireless: mediatek: mt7601u: phy: Fix misnaming when documented function parameter 'dac' Lee Jones
2020-08-19  7:23   ` Lee Jones
2020-08-19 16:31   ` Jakub Kicinski
2020-08-19 16:31     ` Jakub Kicinski
2020-09-01  9:07   ` [15/28] " Kalle Valo
2020-09-01  9:07   ` Kalle Valo
2020-08-19  7:23 ` [PATCH 16/28] wireless: marvell: mwifiex: init: Move 'tos_to_tid_inv' to where it's used Lee Jones
2020-08-31 15:51   ` Kalle Valo
2020-09-08  8:49     ` Lee Jones
2020-09-08 12:02       ` Kalle Valo
     [not found]       ` <010101746d98d278-67bb0cbd-fe22-4344-8c2a-9c65e04ff501-000000@us-west-2.amazonses.com>
2020-09-08 12:17         ` Lee Jones
2020-08-19  7:23 ` [PATCH 17/28] wireless: rsi: rsi_91x_main: Fix misnamed function parameter 'rx_pkt' Lee Jones
2020-08-19  7:23 ` [PATCH 18/28] wireless: rsi: rsi_91x_mac80211: Fix a few kerneldoc misdemeanours Lee Jones
2020-08-19  7:23 ` [PATCH 19/28] wireless: intel: iwlwifi: calib: Demote seemingly unintentional kerneldoc header Lee Jones
2020-08-19  7:23 ` [PATCH 20/28] wireless: rsi: rsi_91x_mgmt: Fix a myriad of documentation issues Lee Jones
2020-08-19  7:23 ` [PATCH 21/28] wireless: ath: wil6210: debugfs: Fix a couple of formatting issues in 'wil6210_debugfs_init' Lee Jones
2020-08-25 20:56   ` merez
2020-08-27 10:21   ` Kalle Valo
2020-08-19  7:23 ` [PATCH 22/28] wireless: intel: iwlwifi: dvm: sta: Demote a bunch of nonconformant kernel-doc headers Lee Jones
2020-08-19  7:23 ` [PATCH 23/28] wireless: rsi: rsi_91x_hal: File header comments should not be kernel-doc Lee Jones
2020-08-19  7:23 ` [PATCH 24/28] wireless: intel: iwlegacy: 4965: Demote a bunch of nonconformant kernel-doc headers Lee Jones
2020-08-19  7:23 ` [PATCH 25/28] wireless: broadcom: brcmfmac: p2p: Deal with set but unused variables Lee Jones
2020-08-19  7:24 ` [PATCH 26/28] wireless: marvell: libertas: firmware: Fix misnaming for function param 'device' Lee Jones
2020-08-19  7:24 ` [PATCH 27/28] wireless: marvell: libertas_tf: if_usb: Fix function documentation formatting errors Lee Jones
2020-08-19  7:24 ` [PATCH 28/28] wireless: intersil: hostap_ioctl: Remove set but unused variable 'hostscan' Lee Jones

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20200819072402.3085022-3-lee.jones@linaro.org \
    --to=lee.jones@linaro.org \
    --cc=amitkarwar@gmail.com \
    --cc=davem@davemloft.net \
    --cc=kuba@kernel.org \
    --cc=kvalo@codeaurora.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-wireless@vger.kernel.org \
    --cc=netdev@vger.kernel.org \
    --cc=siva8118@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.