Message ID | 20240111162850.2177655-1-helgaas@kernel.org |
---|---|
State | New |
Headers |
Return-Path: <linux-kernel+bounces-23867-ouuuleilei=gmail.com@vger.kernel.org> Delivered-To: ouuuleilei@gmail.com Received: by 2002:a05:7300:2411:b0:101:2151:f287 with SMTP id m17csp1565353dyi; Thu, 11 Jan 2024 08:29:20 -0800 (PST) X-Google-Smtp-Source: AGHT+IGW4SdnnQiLzSMQdo2itwS4TM2CEmlZXoIyHPifRQdOsr0maI7XtYcir2UZvS6XcPiydzHh X-Received: by 2002:a05:620a:122f:b0:783:2e69:fa43 with SMTP id v15-20020a05620a122f00b007832e69fa43mr30864qkj.54.1704990560024; Thu, 11 Jan 2024 08:29:20 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1704990560; cv=none; d=google.com; s=arc-20160816; b=CiAW186wBq+37uQv8t5JcO7CRrhXpTNe9eY8JKzB3KPKEhWaLsyhg9gfcMWohiQVsB 1oZtFZz5KqRAIZvupnjHYqPBPxb6p3ZWUGQnArwD9DdGxzC7PZozTvBzncu71fzSBPxX WyP1+rgRqpf71pV4crfIvCyV9GZnMHhfoH3zBCmTJqTi9+Lo33OWf+wZ3KNCPhiYXizH FAUIm8xFFaPO6M9yNbEtGOepCEVNzvIeK3s0IzGezNbyNlaUDUFEBtDLOg4wD5GrbPfd C03MiS0Gzlh/J+sbXrUDDUF8YrEkcizBKmLnyGxb2lKd7/Zm5j3ND10WS3Icjf9AN19i b7Kg== 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=yjGaf1cJOANIqJ/JP4yWwWVE0SRw3KcuColR6vJ+Tg8=; fh=VSQi0zmb8K+pTmWC99hDg3gBllQwzp0x43gyHVyrkGk=; b=F2FpkSwqFh4XSCj2cuFVOxwhA6tC6Lm3zWCyddGu0oA5xSMUKQbU44CwVfSDkT10UL Ns72BclqjxdrjMCtxwpJod5waNlKF0t4m2ILAh9G4OjwIpX0HfpBqKwFaZioUqK6QrNO L9+6makIsPl1MbIvNw8Ubtx/X55oo3fjNILRpCamDvI+nmKiA4NeX33usqBEk0qq/Jg0 Q/MyzFnR36heAkgStZG7Q/jo5v8ab3Acog+TlQPqUoZ/+dsK3AHOBU5YNunxr7sok+sJ NGaVHpweK8lBgSjYFzIGgfgUKZCm7f4kXNIIsWdN2xzW9Q7oayRmY3iol5VhRRX9X5Il 8eFQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@kernel.org header.s=k20201202 header.b=WVEldWFo; spf=pass (google.com: domain of linux-kernel+bounces-23867-ouuuleilei=gmail.com@vger.kernel.org designates 147.75.199.223 as permitted sender) smtp.mailfrom="linux-kernel+bounces-23867-ouuuleilei=gmail.com@vger.kernel.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=kernel.org Received: from ny.mirrors.kernel.org (ny.mirrors.kernel.org. [147.75.199.223]) by mx.google.com with ESMTPS id dc33-20020a05620a522100b007832549cf01si1153092qkb.643.2024.01.11.08.29.19 for <ouuuleilei@gmail.com> (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 11 Jan 2024 08:29:20 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel+bounces-23867-ouuuleilei=gmail.com@vger.kernel.org designates 147.75.199.223 as permitted sender) client-ip=147.75.199.223; Authentication-Results: mx.google.com; dkim=pass header.i=@kernel.org header.s=k20201202 header.b=WVEldWFo; spf=pass (google.com: domain of linux-kernel+bounces-23867-ouuuleilei=gmail.com@vger.kernel.org designates 147.75.199.223 as permitted sender) smtp.mailfrom="linux-kernel+bounces-23867-ouuuleilei=gmail.com@vger.kernel.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=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 ny.mirrors.kernel.org (Postfix) with ESMTPS id CC1CF1C22FBA for <ouuuleilei@gmail.com>; Thu, 11 Jan 2024 16:29:19 +0000 (UTC) Received: from localhost.localdomain (localhost.localdomain [127.0.0.1]) by smtp.subspace.kernel.org (Postfix) with ESMTP id 8E2435024F; Thu, 11 Jan 2024 16:28:58 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b="WVEldWFo" 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 F0DA14F8A1; Thu, 11 Jan 2024 16:28:55 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id 956CDC433C7; Thu, 11 Jan 2024 16:28:55 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1704990535; bh=dAHvLx4ykQf5j2gmvDOelggdw+uJittaxBF6vTFPQlA=; h=From:To:Cc:Subject:Date:From; b=WVEldWFox6syrS6zUzvNTMrBFhW2gYoUG/N9/7C3yay5Ed1fW1wu0DG2oEjwsmu6k xTLjDE052qpQVeHv89aCkAgs6v6noXP3C95oU32nitwBRorLUqti/5UXhUFKzU2ILX sPD71yRza8ffO04dv0GGzTqfr0yfLf+SN11jGqm9WFkiABrcXf8Xo7dsg9QHL3JxJz m4sJgIfwHZdB3C6ZtDRWUS5sv7n9gAmsu1CjhkKxMT6zJ7kF+cqEkm1c5WmSnYMi1N BtpRo/KmtrAog1Ebt6MuPgs9XpZRMtBzoG/JgEMD/syLPXp0DTwdbAx3tCjXUxmpNe QOGnmD0kMSEzg== From: Bjorn Helgaas <helgaas@kernel.org> To: linux-pci@vger.kernel.org Cc: Sui Jingfeng <suijingfeng@loongson.cn>, Manivannan Sadhasivam <mani@kernel.org>, linux-kernel@vger.kernel.org, Bjorn Helgaas <bhelgaas@google.com> Subject: [PATCH] PCI: Fix kernel-doc issues Date: Thu, 11 Jan 2024 10:28:50 -0600 Message-Id: <20240111162850.2177655-1-helgaas@kernel.org> X-Mailer: git-send-email 2.34.1 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-Transfer-Encoding: 8bit X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1787812181675280155 X-GMAIL-MSGID: 1787812181675280155 |
Series |
PCI: Fix kernel-doc issues
|
|
Commit Message
Bjorn Helgaas
Jan. 11, 2024, 4:28 p.m. UTC
From: Bjorn Helgaas <bhelgaas@google.com> Fix kernel-doc issues reported by "find include -name \*pci\* | xargs scripts/kernel-doc -none": include/linux/pci.h:731: warning: Function parameter or member 'pdev' not described in 'pci_is_vga' include/linux/pci-epc.h:154: warning: Function parameter or member 'list_lock' not described in 'pci_epc' include/linux/pci-epf.h:83: warning: expecting prototype for struct pci_epf_event_ops. Prototype was for struct pci_epc_event_ops instead Signed-off-by: Bjorn Helgaas <bhelgaas@google.com> --- include/linux/pci-epc.h | 2 +- include/linux/pci-epf.h | 2 +- include/linux/pci.h | 1 + 3 files changed, 3 insertions(+), 2 deletions(-)
Comments
On 1/11/24 08:28, Bjorn Helgaas wrote: > From: Bjorn Helgaas <bhelgaas@google.com> > > Fix kernel-doc issues reported by > "find include -name \*pci\* | xargs scripts/kernel-doc -none": > > include/linux/pci.h:731: warning: Function parameter or member 'pdev' not described in 'pci_is_vga' > include/linux/pci-epc.h:154: warning: Function parameter or member 'list_lock' not described in 'pci_epc' > include/linux/pci-epf.h:83: warning: expecting prototype for struct pci_epf_event_ops. Prototype was for struct pci_epc_event_ops instead > > Signed-off-by: Bjorn Helgaas <bhelgaas@google.com> Acked-by: Randy Dunlap <rdunlap@infradead.org> Tested-by: Randy Dunlap <rdunlap@infradead.org> Thanks. > --- > include/linux/pci-epc.h | 2 +- > include/linux/pci-epf.h | 2 +- > include/linux/pci.h | 1 + > 3 files changed, 3 insertions(+), 2 deletions(-) > > diff --git a/include/linux/pci-epc.h b/include/linux/pci-epc.h > index 5cb694031072..bfe41b03b70c 100644 > --- a/include/linux/pci-epc.h > +++ b/include/linux/pci-epc.h > @@ -122,7 +122,7 @@ struct pci_epc_mem { > * struct pci_epc - represents the PCI EPC device > * @dev: PCI EPC device > * @pci_epf: list of endpoint functions present in this EPC device > - * list_lock: Mutex for protecting pci_epf list > + * @list_lock: Mutex for protecting pci_epf list > * @ops: function pointers for performing endpoint operations > * @windows: array of address space of the endpoint controller > * @mem: first window of the endpoint controller, which corresponds to > diff --git a/include/linux/pci-epf.h b/include/linux/pci-epf.h > index 3f44b6aec477..92d0b71d33d7 100644 > --- a/include/linux/pci-epf.h > +++ b/include/linux/pci-epf.h > @@ -68,7 +68,7 @@ struct pci_epf_ops { > }; > > /** > - * struct pci_epf_event_ops - Callbacks for capturing the EPC events > + * struct pci_epc_event_ops - Callbacks for capturing the EPC events > * @core_init: Callback for the EPC initialization complete event > * @link_up: Callback for the EPC link up event > * @link_down: Callback for the EPC link down event > diff --git a/include/linux/pci.h b/include/linux/pci.h > index 1a89dc66f89a..eb45087d7e00 100644 > --- a/include/linux/pci.h > +++ b/include/linux/pci.h > @@ -715,6 +715,7 @@ static inline bool pci_is_bridge(struct pci_dev *dev) > > /** > * pci_is_vga - check if the PCI device is a VGA device > + * @pdev: PCI device > * > * The PCI Code and ID Assignment spec, r1.15, secs 1.4 and 1.1, define > * VGA Base Class and Sub-Classes:
Hi, On 2024/1/12 00:28, Bjorn Helgaas wrote: > From: Bjorn Helgaas <bhelgaas@google.com> > > Fix kernel-doc issues reported by > "find include -name \*pci\* | xargs scripts/kernel-doc -none": > > include/linux/pci.h:731: warning: Function parameter or member 'pdev' not described in 'pci_is_vga' > include/linux/pci-epc.h:154: warning: Function parameter or member 'list_lock' not described in 'pci_epc' > include/linux/pci-epf.h:83: warning: expecting prototype for struct pci_epf_event_ops. Prototype was for struct pci_epc_event_ops instead Thanks a lot for the fix. > Signed-off-by: Bjorn Helgaas <bhelgaas@google.com> Acked-by: Sui Jingfeng <suijingfeng@loongson.cn>
On Thu, Jan 11, 2024 at 10:28:50AM -0600, Bjorn Helgaas wrote: > From: Bjorn Helgaas <bhelgaas@google.com> > > Fix kernel-doc issues reported by > "find include -name \*pci\* | xargs scripts/kernel-doc -none": > > include/linux/pci.h:731: warning: Function parameter or member 'pdev' not described in 'pci_is_vga' > include/linux/pci-epc.h:154: warning: Function parameter or member 'list_lock' not described in 'pci_epc' > include/linux/pci-epf.h:83: warning: expecting prototype for struct pci_epf_event_ops. Prototype was for struct pci_epc_event_ops instead > > Signed-off-by: Bjorn Helgaas <bhelgaas@google.com> Reviewed-by: Manivannan Sadhasivam <manivannan.sadhasivam@linaro.org> - Mani > --- > include/linux/pci-epc.h | 2 +- > include/linux/pci-epf.h | 2 +- > include/linux/pci.h | 1 + > 3 files changed, 3 insertions(+), 2 deletions(-) > > diff --git a/include/linux/pci-epc.h b/include/linux/pci-epc.h > index 5cb694031072..bfe41b03b70c 100644 > --- a/include/linux/pci-epc.h > +++ b/include/linux/pci-epc.h > @@ -122,7 +122,7 @@ struct pci_epc_mem { > * struct pci_epc - represents the PCI EPC device > * @dev: PCI EPC device > * @pci_epf: list of endpoint functions present in this EPC device > - * list_lock: Mutex for protecting pci_epf list > + * @list_lock: Mutex for protecting pci_epf list > * @ops: function pointers for performing endpoint operations > * @windows: array of address space of the endpoint controller > * @mem: first window of the endpoint controller, which corresponds to > diff --git a/include/linux/pci-epf.h b/include/linux/pci-epf.h > index 3f44b6aec477..92d0b71d33d7 100644 > --- a/include/linux/pci-epf.h > +++ b/include/linux/pci-epf.h > @@ -68,7 +68,7 @@ struct pci_epf_ops { > }; > > /** > - * struct pci_epf_event_ops - Callbacks for capturing the EPC events > + * struct pci_epc_event_ops - Callbacks for capturing the EPC events > * @core_init: Callback for the EPC initialization complete event > * @link_up: Callback for the EPC link up event > * @link_down: Callback for the EPC link down event > diff --git a/include/linux/pci.h b/include/linux/pci.h > index 1a89dc66f89a..eb45087d7e00 100644 > --- a/include/linux/pci.h > +++ b/include/linux/pci.h > @@ -715,6 +715,7 @@ static inline bool pci_is_bridge(struct pci_dev *dev) > > /** > * pci_is_vga - check if the PCI device is a VGA device > + * @pdev: PCI device > * > * The PCI Code and ID Assignment spec, r1.15, secs 1.4 and 1.1, define > * VGA Base Class and Sub-Classes: > -- > 2.34.1 > >
On Thu, Jan 11, 2024 at 10:28:50AM -0600, Bjorn Helgaas wrote: > From: Bjorn Helgaas <bhelgaas@google.com> > > Fix kernel-doc issues reported by > "find include -name \*pci\* | xargs scripts/kernel-doc -none": > > include/linux/pci.h:731: warning: Function parameter or member 'pdev' not described in 'pci_is_vga' > include/linux/pci-epc.h:154: warning: Function parameter or member 'list_lock' not described in 'pci_epc' > include/linux/pci-epf.h:83: warning: expecting prototype for struct pci_epf_event_ops. Prototype was for struct pci_epc_event_ops instead > > Signed-off-by: Bjorn Helgaas <bhelgaas@google.com> Applied with Randy's Acked-by and Tested-by for v6.8. Thanks for the other replies; I would certainly add them but for the fact that I've already tagged what I intend to ask Linus to pull for v6.8. Bjorn
diff --git a/include/linux/pci-epc.h b/include/linux/pci-epc.h index 5cb694031072..bfe41b03b70c 100644 --- a/include/linux/pci-epc.h +++ b/include/linux/pci-epc.h @@ -122,7 +122,7 @@ struct pci_epc_mem { * struct pci_epc - represents the PCI EPC device * @dev: PCI EPC device * @pci_epf: list of endpoint functions present in this EPC device - * list_lock: Mutex for protecting pci_epf list + * @list_lock: Mutex for protecting pci_epf list * @ops: function pointers for performing endpoint operations * @windows: array of address space of the endpoint controller * @mem: first window of the endpoint controller, which corresponds to diff --git a/include/linux/pci-epf.h b/include/linux/pci-epf.h index 3f44b6aec477..92d0b71d33d7 100644 --- a/include/linux/pci-epf.h +++ b/include/linux/pci-epf.h @@ -68,7 +68,7 @@ struct pci_epf_ops { }; /** - * struct pci_epf_event_ops - Callbacks for capturing the EPC events + * struct pci_epc_event_ops - Callbacks for capturing the EPC events * @core_init: Callback for the EPC initialization complete event * @link_up: Callback for the EPC link up event * @link_down: Callback for the EPC link down event diff --git a/include/linux/pci.h b/include/linux/pci.h index 1a89dc66f89a..eb45087d7e00 100644 --- a/include/linux/pci.h +++ b/include/linux/pci.h @@ -715,6 +715,7 @@ static inline bool pci_is_bridge(struct pci_dev *dev) /** * pci_is_vga - check if the PCI device is a VGA device + * @pdev: PCI device * * The PCI Code and ID Assignment spec, r1.15, secs 1.4 and 1.1, define * VGA Base Class and Sub-Classes: