[Qemu-devel] [PATCH v1 1/1] qom: Correct object_property_get_int() description

[Qemu-devel] [PATCH v1 1/1] qom: Correct object_property_get_int() description

[Alistair Francis]

The description of object_property_get_int() stated that on an error
it returns NULL. This is not the case and the function will return -1
if an error occurs. Update the commented documentation accordingly.

Reported-By: Christian Liebhardt <christian.liebhardt@keysight.com>
Signed-off-by: Christian Liebhardt <christian.liebhardt@keysight.com>
Signed-off-by: Alistair Francis <alistair.francis@xilinx.com>
---
 include/qom/object.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/qom/object.h b/include/qom/object.h
index 4509166..2848f5e 100644
--- a/include/qom/object.h
+++ b/include/qom/object.h
@@ -1107,7 +1107,7 @@ void object_property_set_int(Object *obj, int64_t value,
  * @name: the name of the property
  * @errp: returns an error if this function fails
  *
- * Returns: the value of the property, converted to an integer, or NULL if
+ * Returns: the value of the property, converted to an integer, or negative if
  * an error occurs (including when the property value is not an integer).
  */
 int64_t object_property_get_int(Object *obj, const char *name,
-- 
2.5.0

Re: [Qemu-devel] [PATCH v1 1/1] qom: Correct object_property_get_int() description

[Markus Armbruster]

Copying maintainer.  Always do that even for trivial patches.

Alistair Francis <alistair.francis@xilinx.com> writes:

> The description of object_property_get_int() stated that on an error
> it returns NULL. This is not the case and the function will return -1
> if an error occurs. Update the commented documentation accordingly.
>
> Reported-By: Christian Liebhardt <christian.liebhardt@keysight.com>
> Signed-off-by: Christian Liebhardt <christian.liebhardt@keysight.com>
> Signed-off-by: Alistair Francis <alistair.francis@xilinx.com>
> ---
>  include/qom/object.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/include/qom/object.h b/include/qom/object.h
> index 4509166..2848f5e 100644
> --- a/include/qom/object.h
> +++ b/include/qom/object.h
> @@ -1107,7 +1107,7 @@ void object_property_set_int(Object *obj, int64_t value,
>   * @name: the name of the property
>   * @errp: returns an error if this function fails
>   *
> - * Returns: the value of the property, converted to an integer, or NULL if
> + * Returns: the value of the property, converted to an integer, or negative if
>   * an error occurs (including when the property value is not an integer).
>   */
>  int64_t object_property_get_int(Object *obj, const char *name,

Re: [Qemu-devel] [PATCH v1 1/1] qom: Correct object_property_get_int() description

[Michael Tokarev]

18.01.2016 21:42, Alistair Francis wrote:
> The description of object_property_get_int() stated that on an error
> it returns NULL. This is not the case and the function will return -1
> if an error occurs. Update the commented documentation accordingly.

Applied to -trivial, thanks!

/mjt

Re: [Qemu-devel] [PATCH v1 1/1] qom: Correct object_property_get_int() description

[Alistair Francis]

On Sat, Jan 30, 2016 at 1:35 AM, Michael Tokarev <mjt@tls.msk.ru> wrote:
> 18.01.2016 21:42, Alistair Francis wrote:
>> The description of object_property_get_int() stated that on an error
>> it returns NULL. This is not the case and the function will return -1
>> if an error occurs. Update the commented documentation accordingly.
>
> Applied to -trivial, thanks!

Thanks!

Alistair

>
> /mjt
>