diff mbox series

[v2,2/5] hw/qdev: Correct qdev_init_gpio_out_named() documentation

Message ID 20211218130437.1516929-3-f4bug@amsat.org (mailing list archive)
State New, archived
Headers show
Series hw/qdev: Clarify qdev_connect_gpio_out() documentation | expand

Commit Message

Philippe Mathieu-Daudé Dec. 18, 2021, 1:04 p.m. UTC
qdev_init_gpio_out_named() is described as qdev_init_gpio_out(),
and referring to itself in an endless loop, which is confusing. Fix.

Reported-by: Yanan Wang <wangyanan55@huawei.com>
Signed-off-by: Philippe Mathieu-Daudé <f4bug@amsat.org>
---
 include/hw/qdev-core.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Zhijian Li (Fujitsu)" via Dec. 20, 2021, 1:48 a.m. UTC | #1
On 2021/12/18 21:04, Philippe Mathieu-Daudé wrote:
> qdev_init_gpio_out_named() is described as qdev_init_gpio_out(),
> and referring to itself in an endless loop, which is confusing. Fix.
>
> Reported-by: Yanan Wang <wangyanan55@huawei.com>
> Signed-off-by: Philippe Mathieu-Daudé <f4bug@amsat.org>
> ---
>   include/hw/qdev-core.h | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
Reviewed-by: Yanan Wang <wangyanan55@huawei.com>

Thanks,
Yanan
> diff --git a/include/hw/qdev-core.h b/include/hw/qdev-core.h
> index 59a822ffceb..dcf20c69b89 100644
> --- a/include/hw/qdev-core.h
> +++ b/include/hw/qdev-core.h
> @@ -621,7 +621,7 @@ void qdev_init_gpio_in(DeviceState *dev, qemu_irq_handler handler, int n);
>   void qdev_init_gpio_out(DeviceState *dev, qemu_irq *pins, int n);
>   
>   /**
> - * qdev_init_gpio_out: create an array of named output GPIO lines
> + * qdev_init_gpio_out_named: create an array of named output GPIO lines
>    * @dev: Device to create output GPIOs for
>    * @pins: Pointer to qemu_irq or qemu_irq array for the GPIO lines
>    * @name: Name to give this array of GPIO lines
diff mbox series

Patch

diff --git a/include/hw/qdev-core.h b/include/hw/qdev-core.h
index 59a822ffceb..dcf20c69b89 100644
--- a/include/hw/qdev-core.h
+++ b/include/hw/qdev-core.h
@@ -621,7 +621,7 @@  void qdev_init_gpio_in(DeviceState *dev, qemu_irq_handler handler, int n);
 void qdev_init_gpio_out(DeviceState *dev, qemu_irq *pins, int n);
 
 /**
- * qdev_init_gpio_out: create an array of named output GPIO lines
+ * qdev_init_gpio_out_named: create an array of named output GPIO lines
  * @dev: Device to create output GPIOs for
  * @pins: Pointer to qemu_irq or qemu_irq array for the GPIO lines
  * @name: Name to give this array of GPIO lines