yuzu/unicorn
1
0
Fork 0
mirror of https://github.com/yuzu-emu/unicorn.git synced 2025-01-25 18:41:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

error: Improve documentation

Browse source 
While there, tighten error_append_hint()'s assertion.

Backports commit f4d0064afcff4c38b379800674938cde8f069dcd from qemu
This commit is contained in:
Markus Armbruster 2018-02-17 20:51:28 -05:00 committed by Lioncash
parent 9398bd49fe
commit e4976f4597
No known key found for this signature in database
GPG key ID: 4E3C3CC1031BA9C7
2 changed files with 17 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
qemu/include/qapi/error.h
View file

@ -18,6 +18,16 @@
* Create an error: * Create an error:
* error_setg(&err, "situation normal, all fouled up"); * error_setg(&err, "situation normal, all fouled up");
* *
* Create an error and add additional explanation:
* error_setg(&err, "invalid quark");
* error_append_hint(&err, "Valid quarks are up, down, strange, "
* "charm, top, bottom.\n");
*
* Do *not* contract this to
* error_setg(&err, "invalid quark\n"
* "Valid quarks are up, down, strange, charm, top, bottom.");
*
*
* Report an error to stderr: * Report an error to stderr:
* error_report_err(err); * error_report_err(err);
* This frees the error object. * This frees the error object.
@ -26,6 +36,7 @@
* const char *msg = error_get_pretty(err); * const char *msg = error_get_pretty(err);
* do with msg what needs to be done... * do with msg what needs to be done...
* error_free(err); * error_free(err);
* Note that this loses hints added with error_append_hint().
* *
* Handle an error without reporting it (just for completeness): * Handle an error without reporting it (just for completeness):
* error_free(err); * error_free(err);
@ -128,6 +139,8 @@ void error_set_errno(Error **errp, int os_error, ErrorClass err_class,
* If @errp is anything else, *@errp must be NULL. * If @errp is anything else, *@errp must be NULL.
* The new error's class is ERROR_CLASS_GENERIC_ERROR, and its * The new error's class is ERROR_CLASS_GENERIC_ERROR, and its
* human-readable error message is made from printf-style @fmt, ... * human-readable error message is made from printf-style @fmt, ...
* The resulting message should be a single phrase, with no newline or
* trailing punctuation.
*/ */
#define error_setg(errp, fmt, ...) \ #define error_setg(errp, fmt, ...) \
error_setg_internal((errp), __FILE__, __LINE__, __func__, \ error_setg_internal((errp), __FILE__, __LINE__, __func__, \

8
qemu/util/qemu-error.c
View file

@ -39,8 +39,8 @@ static void error_print_loc(void)
/* /*
* Print an error message to current monitor if we have one, else to stderr. * Print an error message to current monitor if we have one, else to stderr.
* Format arguments like vsprintf(). The result should not contain * Format arguments like vsprintf(). The resulting message should be
* newlines. * a single phrase, with no newline or trailing punctuation.
* Prepend the current location and append a newline. * Prepend the current location and append a newline.
* It's wrong to call this in a QMP monitor. Use qerror_report() there. * It's wrong to call this in a QMP monitor. Use qerror_report() there.
*/ */
@ -65,8 +65,8 @@ void error_vreport(const char *fmt, va_list ap)
/* /*
* Print an error message to current monitor if we have one, else to stderr. * Print an error message to current monitor if we have one, else to stderr.
* Format arguments like sprintf(). The result should not contain * Format arguments like sprintf(). The resulting message should be a
* newlines. * single phrase, with no newline or trailing punctuation.
* Prepend the current location and append a newline. * Prepend the current location and append a newline.
* It's wrong to call this in a QMP monitor. Use qerror_report() there. * It's wrong to call this in a QMP monitor. Use qerror_report() there.
*/ */