From patchwork Wed Jul 17 17:29:16 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Saeed Mahameed X-Patchwork-Id: 13735669 X-Patchwork-Delegate: kuba@kernel.org Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 7AE331E4A6 for ; Wed, 17 Jul 2024 17:29:36 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=10.30.226.201 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1721237376; cv=none; b=eXXt7wrtZ9cNwIOtJXSwNpjcGscOhVUlSoFrovHEvCVD+GsDRrcUbhMcWnLeGm5kABaa8cEMu8dsrS5HisEoUBuk+Vt5fUXrh3QztSJVSgv5aBWM1UvxFamPdNZCbfcEoQzVcE0AhZLxi+VB3/0naDOi9FdbnmxIRw0v0hHsO3M= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1721237376; c=relaxed/simple; bh=Ml2bcml28aoeNE00ipDrA8uHTGL++Vh8ShvQ9yl2PTw=; h=From:To:Cc:Subject:Date:Message-ID:MIME-Version; b=blRnoRYD6kM5oVx61dXk7t7+eIlPuIQWqOhTshGwLWEdg7u9fvMzwiLurBEdq062SAchayKcFvLMZe81dKTXDta6/e0om/ugx5YDb6K+Fpj24Bbji9re91cau45LqdGSzQjF9z4PmEzVQdcn94ssVXvRUlKc1+VslVrphHSpmNc= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=idT2ikCO; arc=none smtp.client-ip=10.30.226.201 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b="idT2ikCO" Received: by smtp.kernel.org (Postfix) with ESMTPSA id DF2D0C2BD10; Wed, 17 Jul 2024 17:29:35 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1721237376; bh=Ml2bcml28aoeNE00ipDrA8uHTGL++Vh8ShvQ9yl2PTw=; h=From:To:Cc:Subject:Date:From; b=idT2ikCOaS0G0SqaV+d9HRmY4O+7xApFXfgv3Iny5/othQn5E5+V1Ze7sq4XkRev6 RVLWIJRAvwWhAz7j9iFrvXufx+uYQhPwM72NpnhZKw45YWdZYcUplSVht4K+6n/4wx oUjjwpwTSdXpxHDk/VB4Ckuv+fl0OTgcyhY3Bm+QCInq0d4WSFMgovFIEHGDLfPPv4 iD7lQTZ28bf0O2MwhkfVJrvsAZywqpGv9O8X3bBfrbczRN6vPkvfbjv/dZXnPNX0rE qkkUC4QxUz5FQW2oRTGwk/mzY9xQNBUkfYXWw48xpORjkHeXuHfaA3WPrm7wwJZsTX fMKOSkbXmW50Q== From: Saeed Mahameed To: "David S. Miller" , Jakub Kicinski , Paolo Abeni , Eric Dumazet Cc: Saeed Mahameed , netdev@vger.kernel.org, Tariq Toukan , Gal Pressman , Leon Romanovsky , Shay Drory , Stephen Rothwell Subject: [PATCH net-next] driver core: auxiliary bus: Fix documentation of auxiliary_device Date: Wed, 17 Jul 2024 10:29:16 -0700 Message-ID: <20240717172916.595808-1-saeed@kernel.org> X-Mailer: git-send-email 2.45.2 Precedence: bulk X-Mailing-List: netdev@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 X-Patchwork-Delegate: kuba@kernel.org From: Shay Drory Fix the documentation of the below field of struct auxiliary_device include/linux/auxiliary_bus.h:150: warning: Function parameter or struct member 'sysfs' not described in 'auxiliary_device' include/linux/auxiliary_bus.h:150: warning: Excess struct member 'irqs' description in 'auxiliary_device' include/linux/auxiliary_bus.h:150: warning: Excess struct member 'lock' description in 'auxiliary_device' include/linux/auxiliary_bus.h:150: warning: Excess struct member 'irq_dir_exists' description in 'auxiliary_device' Fixes: a808878308a8 ("driver core: auxiliary bus: show auxiliary device IRQs") Reported-by: Stephen Rothwell Signed-off-by: Shay Drory Signed-off-by: Saeed Mahameed --- include/linux/auxiliary_bus.h | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/include/linux/auxiliary_bus.h b/include/linux/auxiliary_bus.h index 3ba4487c9cd9..1539bbd263d2 100644 --- a/include/linux/auxiliary_bus.h +++ b/include/linux/auxiliary_bus.h @@ -58,9 +58,10 @@ * in * @name: Match name found by the auxiliary device driver, * @id: unique identitier if multiple devices of the same name are exported, - * @irqs: irqs xarray contains irq indices which are used by the device, - * @lock: Synchronize irq sysfs creation, - * @irq_dir_exists: whether "irqs" directory exists, + * @sysfs: embedded struct which hold all sysfs related fields, + * @sysfs.irqs: irqs xarray contains irq indices which are used by the device, + * @sysfs.lock: Synchronize irq sysfs creation, + * @sysfs.irq_dir_exists: whether "irqs" directory exists, * * An auxiliary_device represents a part of its parent device's functionality. * It is given a name that, combined with the registering drivers