[07/25] HID: intel-ish-hid: Fix a little doc-rot

Message ID	20210326143458.508959-9-lee.jones@linaro.org
State	New
Headers	show Delivered-To: patch@linaro.org Received-SPF: pass (google.com: domain of linux-input-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18; From: Lee Jones <lee.jones@linaro.org> To: lee.jones@linaro.org Cc: linux-kernel@vger.kernel.org, Srinivas Pandruvada <srinivas.pandruvada@linux.intel.com>, Jiri Kosina <jikos@kernel.org>, Benjamin Tissoires <benjamin.tissoires@redhat.com>, linux-input@vger.kernel.org Subject: [PATCH 07/25] HID: intel-ish-hid: Fix a little doc-rot Date: Fri, 26 Mar 2021 14:34:40 +0000 Message-Id: <20210326143458.508959-9-lee.jones@linaro.org> In-Reply-To: <20210326143458.508959-1-lee.jones@linaro.org> References: <20210326143458.508959-1-lee.jones@linaro.org> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Precedence: bulk
Series	Rid W=1 warnings from HID \| expand [RESEND,00/25] Rid W=1 warnings from HID [01/25] HID: intel-ish-hid: Remove unused variable 'err' [02/25] HID: ishtp-hid-client: Move variable to where it's actually used [03/25] HID: intel-ish-hid: pci-ish: Remove unused variable 'ret' [04/25] HID: intel-ish: Supply some missing param descriptions [05/25] HID: intel-ish: Fix a naming disparity and a formatting error [07/25] HID: intel-ish-hid: Fix a little doc-rot [08/25] HID: usbhid: hid-pidff: Demote a couple kernel-doc abuses [09/25] HID: hid-alps: Correct struct misnaming [10/25] HID: intel-ish-hid: Fix potential copy/paste error [11/25] HID: hid-core: Fix incorrect function name in header [12/25] HID: intel-ish-hid: ipc: Correct fw_reset_work_fn() function name in header [13/25] HID: ishtp-hid-client: Fix incorrect function name report_bad_packet() [14/25] HID: hid-kye: Fix incorrect function name for kye_tablet_enable() [15/25] HID: hid-picolcd_core: Remove unused variable 'ret' [16/25] HID: hid-logitech-hidpp: Fix conformant kernel-doc header and demote abuses [17/25] HID: hid-uclogic-rdesc: Kernel-doc is for functions and structs [18/25] HID: hid-thrustmaster: Demote a bunch of kernel-doc abuses [19/25] HID: hid-uclogic-params: Ensure function names are present and correct in kernel-doc headers [20/25] HID: hid-sensor-custom: Remove unused variable 'ret' [21/25] HID: wacom_sys: Demote kernel-doc abuse [22/25] HID: hid-sensor-hub: Remove unused struct member 'quirks' [23/25] HID: hid-sensor-hub: Move 'hsdev' description to correct struct definition [25/25] HID: ishtp-hid-client: Fix 'suggest-attribute=format' compiler warning

Message ID

20210326143458.508959-9-lee.jones@linaro.org

State

New

Headers

Received-SPF: pass (google.com: domain of linux-input-owner@vger.kernel.org
	designates 23.128.96.18 as permitted sender)
	client-ip=23.128.96.18; 
From: Lee Jones <lee.jones@linaro.org>
To: lee.jones@linaro.org
Cc: linux-kernel@vger.kernel.org,
	Srinivas Pandruvada <srinivas.pandruvada@linux.intel.com>,
	Jiri Kosina <jikos@kernel.org>,
	Benjamin Tissoires <benjamin.tissoires@redhat.com>,
	linux-input@vger.kernel.org
Subject: [PATCH 07/25] HID: intel-ish-hid: Fix a little doc-rot
Date: Fri, 26 Mar 2021 14:34:40 +0000
Message-Id: <20210326143458.508959-9-lee.jones@linaro.org>
In-Reply-To: <20210326143458.508959-1-lee.jones@linaro.org>
References: <20210326143458.508959-1-lee.jones@linaro.org>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Precedence: bulk

Series

Rid W=1 warnings from HID | expand

Commit Message

Lee Jones March 26, 2021, 2:34 p.m. UTC

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

 drivers/hid/intel-ish-hid/ishtp/client.c:121: warning: Function parameter or member 'cl_device' not described in 'ishtp_cl_allocate'
 drivers/hid/intel-ish-hid/ishtp/client.c:121: warning: Excess function parameter 'dev' description in 'ishtp_cl_allocate'

Cc: Srinivas Pandruvada <srinivas.pandruvada@linux.intel.com>
Cc: Jiri Kosina <jikos@kernel.org>
Cc: Benjamin Tissoires <benjamin.tissoires@redhat.com>
Cc: Lee Jones <lee.jones@linaro.org>
Cc: linux-input@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>

Acked-by: Srinivas Pandruvada <srinivas.pandruvada@linux.intel.com>

---
 drivers/hid/intel-ish-hid/ishtp/client.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

-- 
2.27.0

diff --git a/drivers/hid/intel-ish-hid/ishtp/client.c b/drivers/hid/intel-ish-hid/ishtp/client.c
index c81a1f8a92685..585a5c4066cb3 100644
--- a/drivers/hid/intel-ish-hid/ishtp/client.c
+++ b/drivers/hid/intel-ish-hid/ishtp/client.c
@@ -111,7 +111,7 @@  static void ishtp_cl_init(struct ishtp_cl *cl, struct ishtp_device *dev)
 
 /**
  * ishtp_cl_allocate() - allocates client structure and sets it up.
- * @dev: ishtp device
+ * @cl_device: ishtp client device
  *
  * Allocate memory for new client device and call to initialize each field.
  *

[07/25] HID: intel-ish-hid: Fix a little doc-rot

Commit Message

Patch