diff mbox series

PCI: hv: Document missing hv_pci_protocol_negotiation() parameter

Message ID 20200925234753.1767227-1-kw@linux.com
State New
Headers show
Series PCI: hv: Document missing hv_pci_protocol_negotiation() parameter | expand

Commit Message

Krzysztof Wilczyński Sept. 25, 2020, 11:47 p.m. UTC
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(-)

Comments

Michael Kelley Sept. 27, 2020, 12:16 a.m. UTC | #1
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>
Wei Liu Sept. 28, 2020, 9:02 a.m. UTC | #2
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.
diff mbox series

Patch

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