[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PULL 01/14] error: Improve documentation of error_append_h
From: |
Markus Armbruster |
Subject: |
[Qemu-devel] [PULL 01/14] error: Improve documentation of error_append_hint() |
Date: |
Tue, 6 Feb 2018 20:50:31 +0100 |
Suggested-by: Halil Pasic <address@hidden>
Signed-off-by: Markus Armbruster <address@hidden>
Message-Id: <address@hidden>
Reviewed-by: Eric Blake <address@hidden>
Reviewed-by: Halil Pasic <address@hidden>
---
include/qapi/error.h | 8 ++++++++
1 file changed, 8 insertions(+)
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);
--
2.13.6
- [Qemu-devel] [PULL 00/14] Error reporting patches for 2018-02-06, Markus Armbruster, 2018/02/06
- [Qemu-devel] [PULL 07/14] hw/moxie: Replace fprintf(stderr, "*\n" with error_report(), Markus Armbruster, 2018/02/06
- [Qemu-devel] [PULL 05/14] hw/lm32: Replace fprintf(stderr, "*\n" with error_report(), Markus Armbruster, 2018/02/06
- [Qemu-devel] [PULL 09/14] hw/pci*: Replace fprintf(stderr, "*\n" with error_report(), Markus Armbruster, 2018/02/06
- [Qemu-devel] [PULL 04/14] hw/dma: Replace fprintf(stderr, "*\n" with error_report(), Markus Armbruster, 2018/02/06
- [Qemu-devel] [PULL 11/14] hw/sd: Replace fprintf(stderr, "*\n" with DPRINTF(), Markus Armbruster, 2018/02/06
- [Qemu-devel] [PULL 01/14] error: Improve documentation of error_append_hint(),
Markus Armbruster <=
- [Qemu-devel] [PULL 08/14] hw/openrisc: Replace fprintf(stderr, "*\n" with error_report(), Markus Armbruster, 2018/02/06
- [Qemu-devel] [PULL 03/14] hw/arm: Replace fprintf(stderr, "*\n" with error_report(), Markus Armbruster, 2018/02/06
- [Qemu-devel] [PULL 13/14] hw/xen*: Replace fprintf(stderr, "*\n" with error_report(), Markus Armbruster, 2018/02/06
- [Qemu-devel] [PULL 12/14] hw/sparc*: Replace fprintf(stderr, "*\n" with error_report(), Markus Armbruster, 2018/02/06
- [Qemu-devel] [PULL 06/14] hw/mips: Replace fprintf(stderr, "*\n" with error_report(), Markus Armbruster, 2018/02/06
- [Qemu-devel] [PULL 10/14] hw/ppc: Replace fprintf(stderr, "*\n" with error_report(), Markus Armbruster, 2018/02/06
- [Qemu-devel] [PULL 14/14] tcg: Replace fprintf(stderr, "*\n" with error_report(), Markus Armbruster, 2018/02/06
- [Qemu-devel] [PULL 02/14] audio: Replace AUDIO_FUNC with __func__, Markus Armbruster, 2018/02/06
- Re: [Qemu-devel] [PULL 00/14] Error reporting patches for 2018-02-06, Peter Maydell, 2018/02/07