diff options
| author | Markus Armbruster <armbru@redhat.com> | 2017-08-10 12:06:28 +0200 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2018-02-06 18:24:43 +0100 |
| commit | 508de4780c69d967868afa926215a662791e8b50 (patch) | |
| tree | fee715981c1c0e58fe401db116fa10db80bdd158 /include/qapi | |
| parent | 20e0d439a6ded635ec89f6135c08cd5541c68962 (diff) | |
error: Improve documentation of error_append_hint()
Suggested-by: Halil Pasic <pasic@linux.vnet.ibm.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <1502359588-29451-1-git-send-email-armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Reviewed-by: Halil Pasic <pasic@linux.vnet.ibm.com>
Diffstat (limited to 'include/qapi')
| -rw-r--r-- | include/qapi/error.h | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/include/qapi/error.h b/include/qapi/error.h index 341b229066..c2115a6a4a 100644 --- a/include/qapi/error.h +++ b/include/qapi/error.h @@ -230,6 +230,12 @@ void error_prepend(Error **errp, const char *fmt, ...) /* * Append a printf-style human-readable explanation to an existing error. + * If the error is later reported to a human user with + * error_report_err() or warn_report_err(), the hints will be shown, + * too. If it's reported via QMP, the hints will be ignored. + * Intended use is adding helpful hints on the human user interface, + * e.g. a list of valid values. It's not for clarifying a confusing + * error message. * @errp may be NULL, but not &error_fatal or &error_abort. * Trivially the case if you call it only after error_setg() or * error_propagate(). @@ -267,11 +273,13 @@ void error_free_or_abort(Error **errp); /* * Convenience function to warn_report() and free @err. + * The report includes hints added with error_append_hint(). */ void warn_report_err(Error *err); /* * Convenience function to error_report() and free @err. + * The report includes hints added with error_append_hint(). */ void error_report_err(Error *err); |