aboutsummaryrefslogtreecommitdiff
path: root/include/qapi
diff options
context:
space:
mode:
authorMarkus Armbruster <armbru@redhat.com>2016-02-03 19:03:47 +0100
committerMarkus Armbruster <armbru@redhat.com>2016-02-09 13:19:41 +0100
commit10303f04b98efa76e638b9ae4632688f56f088fc (patch)
tree36d2dc30f2e584379b7c113976bb21d30b185a9d /include/qapi
parent07d04a0219b9f385de5884717e3e7fb0c6623979 (diff)
error: Improve documentation some more
Don't claim error_report_err() always reports to stderr. It actually reports to the current monitor when we have one. Clarify intended use of error_abort and error_fatal. Signed-off-by: Markus Armbruster <armbru@redhat.com> Message-Id: <1454522628-28294-2-git-send-email-armbru@redhat.com> Reviewed-by: LluĂ­s Vilanova <vilanova@ac.upc.edu>
Diffstat (limited to 'include/qapi')
-rw-r--r--include/qapi/error.h15
1 files changed, 11 insertions, 4 deletions
diff --git a/include/qapi/error.h b/include/qapi/error.h
index 45d6c72dee..e64fe54cf9 100644
--- a/include/qapi/error.h
+++ b/include/qapi/error.h
@@ -27,11 +27,11 @@
* error_setg(&err, "invalid quark\n"
* "Valid quarks are up, down, strange, charm, top, bottom.");
*
- * Report an error to stderr:
+ * Report an error to the current monitor if we have one, else stderr:
* error_report_err(err);
* This frees the error object.
*
- * Report an error to stderr with additional text prepended:
+ * Likewise, but with additional text prepended:
* error_reportf_err(err, "Could not frobnicate '%s': ", name);
*
* Report an error somewhere else:
@@ -162,6 +162,9 @@ ErrorClass error_get_class(const Error *err);
* human-readable error message is made from printf-style @fmt, ...
* The resulting message should be a single phrase, with no newline or
* trailing punctuation.
+ * Please don't error_setg(&error_fatal, ...), use error_report() and
+ * exit(), because that's more obvious.
+ * Likewise, don't error_setg(&error_abort, ...), use assert().
*/
#define error_setg(errp, fmt, ...) \
error_setg_internal((errp), __FILE__, __LINE__, __func__, \
@@ -213,6 +216,8 @@ void error_setg_win32_internal(Error **errp,
* the error object.
* Else, move the error object from @local_err to *@dst_errp.
* On return, @local_err is invalid.
+ * Please don't error_propagate(&error_fatal, ...), use
+ * error_report_err() and exit(), because that's more obvious.
*/
void error_propagate(Error **dst_errp, Error *local_err);
@@ -291,12 +296,14 @@ void error_set_internal(Error **errp,
GCC_FMT_ATTR(6, 7);
/*
- * Pass to error_setg() & friends to abort() on error.
+ * Special error destination to abort on error.
+ * See error_setg() and error_propagate() for details.
*/
extern Error *error_abort;
/*
- * Pass to error_setg() & friends to exit(1) on error.
+ * Special error destination to exit(1) on error.
+ * See error_setg() and error_propagate() for details.
*/
extern Error *error_fatal;