[PATCH] of: describe third arg of of_property_write_bool in kerneldoc

[PATCH] of: describe third arg of of_property_write_bool in kerneldoc

[Ahmad Fatoum]

of_property_write_bool takes a third argument describing whether to
unset (delete) the property or to set it. Describe it in the kerneldoc.

Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de>
---
 drivers/of/base.c | 1 +
 1 file changed, 1 insertion(+)

diff --git a/drivers/of/base.c b/drivers/of/base.c
index 937847f44ab7..1d8b207b1528 100644
--- a/drivers/of/base.c
+++ b/drivers/of/base.c
@@ -1130,6 +1130,7 @@ EXPORT_SYMBOL_GPL(of_prop_next_string);
  *
  * @np:		device node from which the property is to be set.
  * @propname:	name of the property to be set.
+ * @value	true to set, false to delete
  *
  * Search for a property in a device node and create or delete the property.
  * If the property already exists and write value is false, the property is
-- 
2.30.2

Re: [PATCH] of: describe third arg of of_property_write_bool in kerneldoc

[Sascha Hauer]

On Thu, Feb 16, 2023 at 11:57:22AM +0100, Ahmad Fatoum wrote:
> of_property_write_bool takes a third argument describing whether to
> unset (delete) the property or to set it. Describe it in the kerneldoc.
> 
> Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de>
> ---
>  drivers/of/base.c | 1 +
>  1 file changed, 1 insertion(+)

Applied, thanks

Sascha

> 
> diff --git a/drivers/of/base.c b/drivers/of/base.c
> index 937847f44ab7..1d8b207b1528 100644
> --- a/drivers/of/base.c
> +++ b/drivers/of/base.c
> @@ -1130,6 +1130,7 @@ EXPORT_SYMBOL_GPL(of_prop_next_string);
>   *
>   * @np:		device node from which the property is to be set.
>   * @propname:	name of the property to be set.
> + * @value	true to set, false to delete
>   *
>   * Search for a property in a device node and create or delete the property.
>   * If the property already exists and write value is false, the property is
> -- 
> 2.30.2
> 
> 
> 

-- 
Pengutronix e.K.                           |                             |
Steuerwalder Str. 21                       | http://www.pengutronix.de/  |
31137 Hildesheim, Germany                  | Phone: +49-5121-206917-0    |
Amtsgericht Hildesheim, HRA 2686           | Fax:   +49-5121-206917-5555 |