qemu/docs
Markus Armbruster 297a3646c2 qapi: Replace uncommon use of the error API by the common one
We commonly use the error API like this:

    err = NULL;
    foo(..., &err);
    if (err) {
        goto out;
    }
    bar(..., &err);

Every error source is checked separately.  The second function is only
called when the first one succeeds.  Both functions are free to pass
their argument to error_set().  Because error_set() asserts no error
has been set, this effectively means they must not be called with an
error set.

The qapi-generated code uses the error API differently:

    // *errp was initialized to NULL somewhere up the call chain
    frob(..., errp);
    gnat(..., errp);

Errors accumulate in *errp: first error wins, subsequent errors get
dropped.  To make this work, the second function does nothing when
called with an error set.  Requires non-null errp, or else the second
function can't see the first one fail.

This usage has also bled into visitor tests, and two device model
object property getters rtc_get_date() and balloon_stats_get_all().

With the "accumulate" technique, you need fewer error checks in
callers, and buy that with an error check in every callee.  Can be
nice.

However, mixing the two techniques is confusing.  You can't use the
"accumulate" technique with functions designed for the "check
separately" technique.  You can use the "check separately" technique
with functions designed for the "accumulate" technique, but then
error_set() can't catch you setting an error more than once.

Standardize on the "check separately" technique for now, because it's
overwhelmingly prevalent.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Signed-off-by: Luiz Capitulino <lcapitulino@redhat.com>
2014-05-15 14:00:46 -04:00
..
qmp qmp: Make Quorum error events more palatable. 2014-02-28 18:59:06 +01:00
specs vga: add secondary stdvga variant 2014-04-28 11:03:32 +02:00
atomics.txt add a header file for atomic operations 2013-07-04 17:42:49 +02:00
blkverify.txt blkverify: Add block driver for verifying I/O 2010-09-21 17:00:53 +02:00
bootindex.txt Typo, spelling and grammatical fixes 2013-04-12 14:33:20 +02:00
ccid.txt docs/ccid.txt: fix the typo 2013-10-26 13:04:12 +04:00
ich9-ehci-uhci.cfg usb: update documentation 2011-07-08 11:25:56 +02:00
libcacard.txt libcacard: Spelling and grammar fixes in documentation 2012-03-08 15:22:11 +00:00
live-block-ops.txt docs: describe live block operations 2012-01-26 14:49:18 +01:00
memory.txt docs/memory.txt: Fix document on MMIO operations 2014-05-07 21:00:44 +04:00
migration.txt savevm: Remove all the unneeded version_minimum_id_old (rest) 2014-05-14 15:24:51 +02:00
q35-chipset.cfg q35: Add PCIe switch to example q35 configuration 2013-08-21 12:39:15 +03:00
qapi-code-gen.txt qapi: Replace uncommon use of the error API by the common one 2014-05-15 14:00:46 -04:00
qdev-device-use.txt docs: Fix qdev-device-use.txt typo in -chardev serial, path=COM<NUM> 2011-09-09 09:43:17 +01:00
qemupciserial.inf Docs: Introduce multiport serial support in qemupciserial.inf. 2014-03-12 10:33:23 +01:00
rdma.txt rdma: rename 'x-rdma' => 'rdma' 2014-02-25 14:30:28 +01:00
spice-port-fqdn.txt docs: add spice-port-fqdn.txt 2012-12-17 14:01:41 +01:00
tracing.txt Update documentation for LTTng ust tracing 2014-02-19 11:08:54 +01:00
usb-storage.txt Fix typos and misspellings 2013-03-22 13:25:07 +01:00
usb2.txt usb: update docs for bus name change 2013-04-03 11:39:43 +02:00
virtio-balloon-stats.txt docs: document virtio-balloon stats 2013-01-25 10:49:46 -02:00
vnc-ledstate-Pseudo-encoding.txt doc: document the Pseudo-encoding of LED state 2013-04-29 08:28:51 -05:00
writing-qmp-commands.txt qmp hmp: Consistently name Error * objects err, and not errp 2014-05-08 14:20:00 -04:00
xbzrle.txt Add XBZRLE documentation 2012-08-08 13:51:11 +02:00
xen-save-devices-state.txt Introduce "xen-save-devices-state" 2012-03-19 18:21:00 +00:00