linux-hyperv.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH] PCI: hv: Document missing hv_pci_protocol_negotiation() parameter
@ 2020-09-25 23:47 Krzysztof Wilczyński
  2020-09-27  0:16 ` Michael Kelley
  2020-09-28  9:02 ` Wei Liu
  0 siblings, 2 replies; 3+ messages in thread
From: Krzysztof Wilczyński @ 2020-09-25 23:47 UTC (permalink / raw)
  To: K. Y. Srinivasan
  Cc: Haiyang Zhang, Stephen Hemminger, Wei Liu, Bjorn Helgaas,
	linux-hyperv, linux-pci

Add missing documentation for the parameter "version" and "num_version"
of the hv_pci_protocol_negotiation() function and resolve build time
kernel-doc warnings:

  drivers/pci/controller/pci-hyperv.c:2535: warning: Function parameter
  or member 'version' not described in 'hv_pci_protocol_negotiation'

  drivers/pci/controller/pci-hyperv.c:2535: warning: Function parameter
  or member 'num_version' not described in 'hv_pci_protocol_negotiation'

No change to functionality intended.

Signed-off-by: Krzysztof Wilczyński <kw@linux.com>
---
 drivers/pci/controller/pci-hyperv.c | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/drivers/pci/controller/pci-hyperv.c b/drivers/pci/controller/pci-hyperv.c
index fc4c3a15e570..6102330e27e1 100644
--- a/drivers/pci/controller/pci-hyperv.c
+++ b/drivers/pci/controller/pci-hyperv.c
@@ -2515,7 +2515,10 @@ static void hv_pci_onchannelcallback(void *context)
 
 /**
  * hv_pci_protocol_negotiation() - Set up protocol
- * @hdev:	VMBus's tracking struct for this root PCI bus
+ * @hdev:		VMBus's tracking struct for this root PCI bus.
+ * @version:		Array of supported channel protocol versions in
+ *			the order of probing - highest go first.
+ * @num_version:	Number of elements in the version array.
  *
  * This driver is intended to support running on Windows 10
  * (server) and later versions. It will not run on earlier
-- 
2.28.0


^ permalink raw reply related	[flat|nested] 3+ messages in thread

* RE: [PATCH] PCI: hv: Document missing hv_pci_protocol_negotiation() parameter
  2020-09-25 23:47 [PATCH] PCI: hv: Document missing hv_pci_protocol_negotiation() parameter Krzysztof Wilczyński
@ 2020-09-27  0:16 ` Michael Kelley
  2020-09-28  9:02 ` Wei Liu
  1 sibling, 0 replies; 3+ messages in thread
From: Michael Kelley @ 2020-09-27  0:16 UTC (permalink / raw)
  To: Krzysztof Wilczyński, KY Srinivasan
  Cc: Haiyang Zhang, Stephen Hemminger, Wei Liu, Bjorn Helgaas,
	linux-hyperv, linux-pci

From: Krzysztof Wilczyński <kw@linux.com> Sent: Friday, September 25, 2020 4:48 PM
> To: KY Srinivasan <kys@microsoft.com>
> Cc: Haiyang Zhang <haiyangz@microsoft.com>; Stephen Hemminger
> <sthemmin@microsoft.com>; Wei Liu <wei.liu@kernel.org>; Bjorn Helgaas
> <bhelgaas@google.com>; linux-hyperv@vger.kernel.org; linux-pci@vger.kernel.org
> Subject: [PATCH] PCI: hv: Document missing hv_pci_protocol_negotiation() parameter
> 
> Add missing documentation for the parameter "version" and "num_version"
> of the hv_pci_protocol_negotiation() function and resolve build time
> kernel-doc warnings:
> 
>   drivers/pci/controller/pci-hyperv.c:2535: warning: Function parameter
>   or member 'version' not described in 'hv_pci_protocol_negotiation'
> 
>   drivers/pci/controller/pci-hyperv.c:2535: warning: Function parameter
>   or member 'num_version' not described in 'hv_pci_protocol_negotiation'
> 
> No change to functionality intended.
> 
> Signed-off-by: Krzysztof Wilczyński <kw@linux.com>
> ---
>  drivers/pci/controller/pci-hyperv.c | 5 ++++-
>  1 file changed, 4 insertions(+), 1 deletion(-)
> 
> diff --git a/drivers/pci/controller/pci-hyperv.c b/drivers/pci/controller/pci-hyperv.c
> index fc4c3a15e570..6102330e27e1 100644
> --- a/drivers/pci/controller/pci-hyperv.c
> +++ b/drivers/pci/controller/pci-hyperv.c
> @@ -2515,7 +2515,10 @@ static void hv_pci_onchannelcallback(void *context)
> 
>  /**
>   * hv_pci_protocol_negotiation() - Set up protocol
> - * @hdev:	VMBus's tracking struct for this root PCI bus
> + * @hdev:		VMBus's tracking struct for this root PCI bus.
> + * @version:		Array of supported channel protocol versions in
> + *			the order of probing - highest go first.
> + * @num_version:	Number of elements in the version array.
>   *
>   * This driver is intended to support running on Windows 10
>   * (server) and later versions. It will not run on earlier
> --
> 2.28.0

Reviewed-by:  Michael Kelley <mikelley@microsoft.com>

^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCH] PCI: hv: Document missing hv_pci_protocol_negotiation() parameter
  2020-09-25 23:47 [PATCH] PCI: hv: Document missing hv_pci_protocol_negotiation() parameter Krzysztof Wilczyński
  2020-09-27  0:16 ` Michael Kelley
@ 2020-09-28  9:02 ` Wei Liu
  1 sibling, 0 replies; 3+ messages in thread
From: Wei Liu @ 2020-09-28  9:02 UTC (permalink / raw)
  To: Krzysztof Wilczyński
  Cc: K. Y. Srinivasan, Haiyang Zhang, Stephen Hemminger, Wei Liu,
	Bjorn Helgaas, linux-hyperv, linux-pci

On Fri, Sep 25, 2020 at 11:47:53PM +0000, Krzysztof Wilczyński wrote:
> Add missing documentation for the parameter "version" and "num_version"
> of the hv_pci_protocol_negotiation() function and resolve build time
> kernel-doc warnings:
> 
>   drivers/pci/controller/pci-hyperv.c:2535: warning: Function parameter
>   or member 'version' not described in 'hv_pci_protocol_negotiation'
> 
>   drivers/pci/controller/pci-hyperv.c:2535: warning: Function parameter
>   or member 'num_version' not described in 'hv_pci_protocol_negotiation'
> 
> No change to functionality intended.
> 
> Signed-off-by: Krzysztof Wilczyński <kw@linux.com>

Applied to hyperv-next. Thanks.

^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2020-09-28  9:02 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-09-25 23:47 [PATCH] PCI: hv: Document missing hv_pci_protocol_negotiation() parameter Krzysztof Wilczyński
2020-09-27  0:16 ` Michael Kelley
2020-09-28  9:02 ` Wei Liu

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).