| Message ID | 20231223050656.14068-1-rdunlap@infradead.org |
|---|---|
| State | New |
| Headers |
Return-Path: <linux-kernel+bounces-10304-ouuuleilei=gmail.com@vger.kernel.org>
Delivered-To: ouuuleilei@gmail.com
Received: by 2002:a05:7300:2483:b0:fb:cd0c:d3e with SMTP id q3csp1496587dyi;
Fri, 22 Dec 2023 21:09:32 -0800 (PST)
X-Google-Smtp-Source:
AGHT+IHn2/2MXkf5yzxSezO8Hs0c9JBN0PgqiIKvuA7+uX+WTbDrd+Y7i0HpvPA0h3xgGRZtDAwu
X-Received: by 2002:a05:6808:3097:b0:3bb:634f:66ed with SMTP id
bl23-20020a056808309700b003bb634f66edmr2067708oib.11.1703308171998;
Fri, 22 Dec 2023 21:09:31 -0800 (PST)
ARC-Seal: i=1; a=rsa-sha256; t=1703308171; cv=none;
d=google.com; s=arc-20160816;
b=sArrLHJ8oq4HeVHpDBW/HE32Lf9VOh0893dA3e739md3UPctM15oCJ+409pmSU1wTW
YYe8NsY5/mquS7/CKtah/4glDIAluhyPdkAhs950om+Dy0vnDmjeCoJ9y+U+0npZlurX
pltU5KJ1HOMzDKk/VY+6DtdLwO2q6ArrrrOEoOxjFnXWMY/CDfu8yoqspdljADR5wCCt
OJ1w0H6SNm6OR7QEcjqWc3ReefBwk4XNBATa2lb8+5WI6tz0XhgXyxeqOsps9Y9Lo5wk
LXN0YoZTkPTlkzbd1sAfTiOYj7gVyucYdoWuPUCjAjS1B9+9orOxnpF+Ut+Oi3IeO7dB
ZSXg==
ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com;
s=arc-20160816;
h=content-transfer-encoding:mime-version:list-unsubscribe
:list-subscribe:list-id:precedence:message-id:date:subject:cc:to
:from:dkim-signature;
bh=0IQ6eY5t7H4CQgzSB2rccly8JDANanOLav3vAFYUpa8=;
fh=biMvvI+bkQLQDMIqFYGnV3mISTqR5EHroQE4OAti5to=;
b=dZXDHsfUAypS9lQkhGDiu71rQoSGtOmZN0A/6Q+NArRB/79LUgf74LClh/zYGgm7yX
z8bx6bagK3ONP9B+hLg4uYGlZaZtmNhApZNohzQ64EX2iGtE7FALBlSVd+uFyuuyMXBv
Sjfoypyj44shc8QuyhP0wvOr1ZTrUOJaY5yCO9vXWbgjyod4dBtHvMmi20keHXioBb+D
OUXyjjnrIceO2rPcsrlj6FcwkybnRtzraFZeeOMl+cEPCQW+M7WXgYa0U05XOsYqEpn0
QNEi2hTc1E4M7pAmw2CUzp4Ewmp4dDgrteGQ9WOsUSPFdi1Ebr0biH0+GghnuJ3TLf2s
VDgg==
ARC-Authentication-Results: i=1; mx.google.com;
dkim=pass header.i=@infradead.org header.s=bombadil.20210309
header.b="iJbC/nHq";
spf=pass (google.com: domain of
linux-kernel+bounces-10304-ouuuleilei=gmail.com@vger.kernel.org designates
2604:1380:40f1:3f00::1 as permitted sender)
smtp.mailfrom="linux-kernel+bounces-10304-ouuuleilei=gmail.com@vger.kernel.org"
Received: from sy.mirrors.kernel.org (sy.mirrors.kernel.org.
[2604:1380:40f1:3f00::1])
by mx.google.com with ESMTPS id
fa4-20020a056a002d0400b006d9619ecdb9si4452470pfb.229.2023.12.22.21.09.31
for <ouuuleilei@gmail.com>
(version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256);
Fri, 22 Dec 2023 21:09:31 -0800 (PST)
Received-SPF: pass (google.com: domain of
linux-kernel+bounces-10304-ouuuleilei=gmail.com@vger.kernel.org designates
2604:1380:40f1:3f00::1 as permitted sender) client-ip=2604:1380:40f1:3f00::1;
Authentication-Results: mx.google.com;
dkim=pass header.i=@infradead.org header.s=bombadil.20210309
header.b="iJbC/nHq";
spf=pass (google.com: domain of
linux-kernel+bounces-10304-ouuuleilei=gmail.com@vger.kernel.org designates
2604:1380:40f1:3f00::1 as permitted sender)
smtp.mailfrom="linux-kernel+bounces-10304-ouuuleilei=gmail.com@vger.kernel.org"
Received: from smtp.subspace.kernel.org (wormhole.subspace.kernel.org
[52.25.139.140])
(using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits))
(No client certificate requested)
by sy.mirrors.kernel.org (Postfix) with ESMTPS id E2554B231A1
for <ouuuleilei@gmail.com>; Sat, 23 Dec 2023 05:08:01 +0000 (UTC)
Received: from localhost.localdomain (localhost.localdomain [127.0.0.1])
by smtp.subspace.kernel.org (Postfix) with ESMTP id 05A188F79;
Sat, 23 Dec 2023 05:07:02 +0000 (UTC)
Authentication-Results: smtp.subspace.kernel.org;
dkim=pass (2048-bit key) header.d=infradead.org header.i=@infradead.org
header.b="iJbC/nHq"
X-Original-To: linux-kernel@vger.kernel.org
Received: from bombadil.infradead.org (bombadil.infradead.org
[198.137.202.133])
(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 4AB54D270;
Sat, 23 Dec 2023 05:06:58 +0000 (UTC)
Authentication-Results: smtp.subspace.kernel.org;
dmarc=none (p=none dis=none) header.from=infradead.org
Authentication-Results: smtp.subspace.kernel.org;
spf=none smtp.mailfrom=infradead.org
DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed;
d=infradead.org; s=bombadil.20210309; h=Content-Transfer-Encoding:
Content-Type:MIME-Version:Message-ID:Date:Subject:Cc:To:From:Sender:Reply-To:
Content-ID:Content-Description:In-Reply-To:References;
bh=0IQ6eY5t7H4CQgzSB2rccly8JDANanOLav3vAFYUpa8=; b=iJbC/nHq48kzd602Cpsynv12sd
m8RRjJpv0aNtdCYj4NQK/L1ZaXdeEeBF3O5qAAmQv4ljkFQq2GwHEezpzLMLnhVdG0hPOAuRqfY2d
45z03FdOfrZszkUSAurI/nAAtqZ9ksjSt3SDns+o/2kqLzBqdwodhw4BYhA+3+Xn3mEhzWthqXOQg
cePmfj9M3O58+eWmySxWkRxTEf1n+xzO6X90+C869DgRJI4IHDzVrKo+jFRlJ741uhVMISI+GbgvC
viWxjZabNAN+9Ge3DQlF1nIaSj0LidGiLlaLCSUX7GuR1RAnw000tpa34qbOzu6l1SHxYjWYuPg3U
sF33+WeQ==;
Received: from [50.53.46.231] (helo=bombadil.infradead.org)
by bombadil.infradead.org with esmtpsa (Exim 4.96 #2 (Red Hat Linux))
id 1rGuDw-007Opp-2L;
Sat, 23 Dec 2023 05:06:56 +0000
From: Randy Dunlap <rdunlap@infradead.org>
To: linux-kernel@vger.kernel.org
Cc: Randy Dunlap <rdunlap@infradead.org>, Armin Wolf <W_Armin@gmx.de>,
Hans de Goede <hdegoede@redhat.com>,
=?utf-8?q?Ilpo_J=C3=A4rvinen?= <ilpo.jarvinen@linux.intel.com>,
platform-driver-x86@vger.kernel.org
Subject: [PATCH] platform/x86: wmi: linux/wmi.h: fix Excess kernel-doc
description warning
Date: Fri, 22 Dec 2023 21:06:55 -0800
Message-ID: <20231223050656.14068-1-rdunlap@infradead.org>
X-Mailer: git-send-email 2.43.0
Precedence: bulk
X-Mailing-List: linux-kernel@vger.kernel.org
List-Id: <linux-kernel.vger.kernel.org>
List-Subscribe: <mailto:linux-kernel+subscribe@vger.kernel.org>
List-Unsubscribe: <mailto:linux-kernel+unsubscribe@vger.kernel.org>
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
X-getmail-retrieved-from-mailbox: INBOX
X-GMAIL-THRID: 1786048069745718616
X-GMAIL-MSGID: 1786048069745718616
|
| Series |
platform/x86: wmi: linux/wmi.h: fix Excess kernel-doc description warning
|
|
Commit Message
Randy Dunlap
Dec. 23, 2023, 5:06 a.m. UTC
Remove the "private:" comment to prevent the kernel-doc warning:
include/linux/wmi.h:27: warning: Excess struct member 'setable' description in 'wmi_device'
Either a struct member is documented (via kernel-doc) or it's private,
but not both.
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Armin Wolf <W_Armin@gmx.de>
Cc: Hans de Goede <hdegoede@redhat.com>
Cc: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com>
Cc: platform-driver-x86@vger.kernel.org
---
include/linux/wmi.h | 2 --
1 file changed, 2 deletions(-)
Comments
Hi Armin, On 12/22/23 22:48, Armin Wolf wrote: > Am 23.12.23 um 06:06 schrieb Randy Dunlap: > >> Remove the "private:" comment to prevent the kernel-doc warning: >> >> include/linux/wmi.h:27: warning: Excess struct member 'setable' description in 'wmi_device' >> >> Either a struct member is documented (via kernel-doc) or it's private, >> but not both. > > Hi, > > i am not encountering this kernel doc warning, but your argument is still valid. I also seem to > have missed the fact that WMI drivers may want to know whether their WMI data block is setable > during runtime when i added those kernel-doc comments. The warning comes from 2 new patches in linux-next. > Please add a Fixes: b4cc979588ee ("platform/x86: wmi: Add kernel doc comments") tag so that > this patch can reach the stable kernels. With that addressed, you may also add: > > Reviewed-by: Armin Wolf <W_Armin@gmx.de> Thanks. patch v2 is on the way. > Thanks, > Armin Wolf > >> Signed-off-by: Randy Dunlap <rdunlap@infradead.org> >> Cc: Armin Wolf <W_Armin@gmx.de> >> Cc: Hans de Goede <hdegoede@redhat.com> >> Cc: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com> >> Cc: platform-driver-x86@vger.kernel.org >> --- >> include/linux/wmi.h | 2 -- >> 1 file changed, 2 deletions(-) >> >> diff -- a/include/linux/wmi.h b/include/linux/wmi.h >> --- a/include/linux/wmi.h >> +++ b/include/linux/wmi.h >> @@ -21,8 +21,6 @@ >> */ >> struct wmi_device { >> struct device dev; >> - >> - /* private: used by the WMI driver core */ >> bool setable; >> }; >>
diff -- a/include/linux/wmi.h b/include/linux/wmi.h --- a/include/linux/wmi.h +++ b/include/linux/wmi.h @@ -21,8 +21,6 @@ */ struct wmi_device { struct device dev; - - /* private: used by the WMI driver core */ bool setable; };