[PULL 07/17] qom: Correct error values in two contracts

Eduardo Habkost posted 17 patches 5 years, 4 months ago
Maintainers: Max Reitz <mreitz@redhat.com>, "Michael S. Tsirkin" <mst@redhat.com>, Marek Vasut <marex@denx.de>, Juan Quintela <quintela@redhat.com>, Pavel Dovgalyuk <pavel.dovgaluk@ispras.ru>, Aleksandar Rikalo <aleksandar.rikalo@syrmia.com>, Aleksandar Markovic <aleksandar.qemu.devel@gmail.com>, Andrew Jeffery <andrew@aj.id.au>, Peter Chubb <peter.chubb@nicta.com.au>, Eric Auger <eric.auger@redhat.com>, John Snow <jsnow@redhat.com>, Peter Maydell <peter.maydell@linaro.org>, BALATON Zoltan <balaton@eik.bme.hu>, Thomas Huth <huth@tuxfamily.org>, Laurent Vivier <lvivier@redhat.com>, Michael Rolnik <mrolnik@gmail.com>, Sarah Harris <S.E.Harris@kent.ac.uk>, "Dr. David Alan Gilbert" <dgilbert@redhat.com>, Jason Wang <jasowang@redhat.com>, Li Zhijian <lizhijian@cn.fujitsu.com>, Alistair Francis <alistair@alistair23.me>, Kevin Wolf <kwolf@redhat.com>, Beniamino Galvani <b.galvani@gmail.com>, Thomas Huth <thuth@redhat.com>, Andrey Smirnov <andrew.smirnov@gmail.com>, Greg Kurz <groug@kaod.org>, Michael Walle <michael@walle.cc>, Igor Mitsyanko <i.mitsyanko@gmail.com>, KONRAD Frederic <frederic.konrad@adacore.com>, Stefan Hajnoczi <stefanha@redhat.com>, Cornelia Huck <cohuck@redhat.com>, Corey Minyard <cminyard@mvista.com>, Chris Wulff <crwulff@gmail.com>, Mark Cave-Ayland <mark.cave-ayland@ilande.co.uk>, Stefano Stabellini <sstabellini@kernel.org>, Samuel Thibault <samuel.thibault@ens-lyon.org>, Ben Warren <ben@skyportsystems.com>, Joel Stanley <joel@jms.id.au>, Yoshinori Sato <ysato@users.sourceforge.jp>, Zhang Chen <chen.zhang@intel.com>, Matthew Rosato <mjrosato@linux.ibm.com>, Jan Kiszka <jan.kiszka@web.de>, Rob Herring <robh@kernel.org>, Amit Shah <amit@kernel.org>, Pierre Morel <pmorel@linux.ibm.com>, Christian Borntraeger <borntraeger@de.ibm.com>, Bastian Koppelmann <kbastian@mail.uni-paderborn.de>, Aurelien Jarno <aurelien@aurel32.net>, Niek Linnenbank <nieklinnenbank@gmail.com>, Gerd Hoffmann <kraxel@redhat.com>, Raphael Norwitz <raphael.norwitz@nutanix.com>, Igor Mammedov <imammedo@redhat.com>, Helge Deller <deller@gmx.de>, Palmer Dabbelt <palmer@dabbelt.com>, David Hildenbrand <david@redhat.com>, Alberto Garcia <berto@igalia.com>, Jean-Christophe Dubois <jcd@tribudubois.net>, "Daniel P. Berrangé" <berrange@redhat.com>, Sagar Karandikar <sagark@eecs.berkeley.edu>, Richard Henderson <rth@twiddle.net>, Radoslaw Biernacki <rad@semihalf.com>, Fabien Chouteau <chouteau@adacore.com>, Max Filippov <jcmvbkbc@gmail.com>, Andrzej Zaborowski <balrogg@gmail.com>, Paolo Bonzini <pbonzini@redhat.com>, Halil Pasic <pasic@linux.ibm.com>, "Edgar E. Iglesias" <edgar.iglesias@gmail.com>, Antony Pavlov <antonynpavlov@gmail.com>, Tony Krowiak <akrowiak@linux.ibm.com>, Anthony Perard <anthony.perard@citrix.com>, Artyom Tarasenko <atar4qemu@gmail.com>, "Cédric Le Goater" <clg@kaod.org>, Eric Farman <farman@linux.ibm.com>, Andrew Baumann <Andrew.Baumann@microsoft.com>, "Marc-André Lureau" <marcandre.lureau@redhat.com>, Christian Schoenebeck <qemu_oss@crudebyte.com>, Huacai Chen <chenhc@lemote.com>, Jiaxun Yang <jiaxun.yang@flygoat.com>, David Gibson <david@gibson.dropbear.id.au>, "Hervé Poussineau" <hpoussin@reactos.org>, Paul Burton <paulburton@kernel.org>, Sven Schnelle <svens@stackframe.org>, "Philippe Mathieu-Daudé" <f4bug@amsat.org>, Peter Xu <peterx@redhat.com>, Eduardo Habkost <ehabkost@redhat.com>, Anup Patel <anup.patel@wdc.com>, Fam Zheng <fam@euphon.net>, Laszlo Ersek <lersek@redhat.com>, Alistair Francis <Alistair.Francis@wdc.com>, Alex Williamson <alex.williamson@redhat.com>, Leif Lindholm <leif@nuviainc.com>, Stefan Berger <stefanb@linux.ibm.com>, Subbaraya Sundeep <sundeep.lkml@gmail.com>, Dmitry Fleytman <dmitry.fleytman@gmail.com>, Guan Xuetao <gxt@mprc.pku.edu.cn>, Marcel Apfelbaum <marcel.apfelbaum@gmail.com>, "Gonglei (Arei)" <arei.gonglei@huawei.com>, Paul Durrant <paul@xen.org>
[PULL 07/17] qom: Correct error values in two contracts
Posted by Eduardo Habkost 5 years, 4 months ago
From: Markus Armbruster <armbru@redhat.com>

object_property_get_bool()'s contract claims it returns NULL on error.
Pasto; it returns false.

object_property_get_int()'s contract claims it returns "negative".  It
actually returns -1.  All the other object_property_get_FOO()
contracts specify the exact error value, so do the same here.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Greg Kurz <groug@kaod.org>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
Message-Id: <20200917125540.597786-3-armbru@redhat.com>
Signed-off-by: Eduardo Habkost <ehabkost@redhat.com>
---
 include/qom/object.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/include/qom/object.h b/include/qom/object.h
index 494827b4d1..32524d72cc 100644
--- a/include/qom/object.h
+++ b/include/qom/object.h
@@ -1624,7 +1624,7 @@ bool object_property_set_bool(Object *obj, const char *name,
  * @name: the name of the property
  * @errp: returns an error if this function fails
  *
- * Returns: the value of the property, converted to a boolean, or NULL if
+ * Returns: the value of the property, converted to a boolean, or false if
  * an error occurs (including when the property value is not a bool).
  */
 bool object_property_get_bool(Object *obj, const char *name,
@@ -1649,7 +1649,7 @@ bool object_property_set_int(Object *obj, const char *name,
  * @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 negative if
+ * Returns: the value of the property, converted to an integer, or -1 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.26.2