[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PULL 05/25] libqtest: Document calling conventions
From: |
Markus Armbruster |
Subject: |
[Qemu-devel] [PULL 05/25] libqtest: Document calling conventions |
Date: |
Thu, 16 Aug 2018 10:36:41 +0200 |
From: Eric Blake <address@hidden>
We have two flavors of vararg usage in qtest: qtest_hmp() etc. work
like sprintf(), and qtest_qmp() etc. work like qobject_from_jsonf().
Spell that out in the comments.
Also add GCC_FMT_ATTR() to qtest_hmp() etc. so that the compiler can
flag incorrect use.
We have some cleanup work to do before we can do the same for
qtest_qmp() etc. This would get us the same better-than-nothing
checking we already have for qobject_from_jsonf(): common incorrect
uses of supported conversion specifications will be flagged
(e.g. passing a double for %d), but use of unsupported ones won't.
Signed-off-by: Eric Blake <address@hidden>
Reviewed-by: Stefan Hajnoczi <address@hidden>
Reviewed-by: Markus Armbruster <address@hidden>
[Rebased, comment wording tweaked, commit message rewritten]
Signed-off-by: Markus Armbruster <address@hidden>
Message-Id: <address@hidden>
---
tests/libqtest.h | 29 +++++++++++++++++++++--------
1 file changed, 21 insertions(+), 8 deletions(-)
diff --git a/tests/libqtest.h b/tests/libqtest.h
index 3eecd5e9a7..da13ea00ef 100644
--- a/tests/libqtest.h
+++ b/tests/libqtest.h
@@ -76,7 +76,9 @@ void qtest_quit(QTestState *s);
/**
* qtest_qmp:
* @s: #QTestState instance to operate on.
- * @fmt...: QMP message to send to qemu
+ * @fmt...: QMP message to send to qemu, formatted like
+ * qobject_from_jsonf(). See parse_escape() for what's supported
+ * after '%'.
*
* Sends a QMP message to QEMU and returns the response.
*/
@@ -85,7 +87,9 @@ QDict *qtest_qmp(QTestState *s, const char *fmt, ...);
/**
* qtest_qmp_send:
* @s: #QTestState instance to operate on.
- * @fmt...: QMP message to send to qemu
+ * @fmt...: QMP message to send to qemu, formatted like
+ * qobject_from_jsonf(). See parse_escape() for what's supported
+ * after '%'.
*
* Sends a QMP message to QEMU and leaves the response in the stream.
*/
@@ -94,7 +98,9 @@ void qtest_qmp_send(QTestState *s, const char *fmt, ...);
/**
* qtest_qmpv:
* @s: #QTestState instance to operate on.
- * @fmt: QMP message to send to QEMU
+ * @fmt: QMP message to send to QEMU, formatted like
+ * qobject_from_jsonf(). See parse_escape() for what's supported
+ * after '%'.
* @ap: QMP message arguments
*
* Sends a QMP message to QEMU and returns the response.
@@ -104,7 +110,9 @@ QDict *qtest_qmpv(QTestState *s, const char *fmt, va_list
ap);
/**
* qtest_qmp_vsend:
* @s: #QTestState instance to operate on.
- * @fmt: QMP message to send to QEMU
+ * @fmt: QMP message to send to QEMU, formatted like
+ * qobject_from_jsonf(). See parse_escape() for what's supported
+ * after '%'.
* @ap: QMP message arguments
*
* Sends a QMP message to QEMU and leaves the response in the stream.
@@ -153,7 +161,7 @@ char *qtest_hmp(QTestState *s, const char *fmt, ...)
GCC_FMT_ATTR(2, 3);
/**
* qtest_hmpv:
* @s: #QTestState instance to operate on.
- * @fmt: HMP command to send to QEMU
+ * @fmt: HMP command to send to QEMU, formats arguments like vsprintf().
* @ap: HMP command arguments
*
* Send HMP command to QEMU via QMP's human-monitor-command.
@@ -161,7 +169,8 @@ char *qtest_hmp(QTestState *s, const char *fmt, ...)
GCC_FMT_ATTR(2, 3);
*
* Returns: the command's output. The caller should g_free() it.
*/
-char *qtest_hmpv(QTestState *s, const char *fmt, va_list ap);
+char *qtest_hmpv(QTestState *s, const char *fmt, va_list ap)
+ GCC_FMT_ATTR(2, 0);
/**
* qtest_get_irq:
@@ -542,7 +551,9 @@ static inline void qtest_end(void)
/**
* qmp:
- * @fmt...: QMP message to send to qemu
+ * @fmt...: QMP message to send to qemu, formatted like
+ * qobject_from_jsonf(). See parse_escape() for what's supported
+ * after '%'.
*
* Sends a QMP message to QEMU and returns the response.
*/
@@ -550,7 +561,9 @@ QDict *qmp(const char *fmt, ...);
/**
* qmp_send:
- * @fmt...: QMP message to send to qemu
+ * @fmt...: QMP message to send to qemu, formatted like
+ * qobject_from_jsonf(). See parse_escape() for what's supported
+ * after '%'.
*
* Sends a QMP message to QEMU and leaves the response in the stream.
*/
--
2.17.1
- [Qemu-devel] [PULL 00/25] Testing patches for 2018-08-16, Markus Armbruster, 2018/08/16
- [Qemu-devel] [PULL 01/25] libqtest: Rename functions to send QMP messages, Markus Armbruster, 2018/08/16
- [Qemu-devel] [PULL 08/25] libqtest: Simplify qmp_fd_vsend() a bit, Markus Armbruster, 2018/08/16
- [Qemu-devel] [PULL 04/25] libqtest: Remove qtest_qmp_discard_response() & friends, Markus Armbruster, 2018/08/16
- [Qemu-devel] [PULL 25/25] libqtest: Improve error reporting for bad read from QEMU, Markus Armbruster, 2018/08/16
- [Qemu-devel] [PULL 07/25] qobject: New qobject_from_vjsonf_nofail(), qdict_from_vjsonf_nofail(), Markus Armbruster, 2018/08/16
- [Qemu-devel] [PULL 02/25] libqtest: Clean up how we read device_del messages, Markus Armbruster, 2018/08/16
- [Qemu-devel] [PULL 03/25] libqtest: Clean up how we read the QMP greeting, Markus Armbruster, 2018/08/16
- [Qemu-devel] [PULL 10/25] qobject: qobject_from_jsonv() is dangerous, hide it away, Markus Armbruster, 2018/08/16
- [Qemu-devel] [PULL 05/25] libqtest: Document calling conventions,
Markus Armbruster <=
- [Qemu-devel] [PULL 06/25] qobject: Replace qobject_from_jsonf() by qobject_from_jsonf_nofail(), Markus Armbruster, 2018/08/16
- [Qemu-devel] [PULL 18/25] migration-test: Clean up string interpolation into QMP, part 1, Markus Armbruster, 2018/08/16
- [Qemu-devel] [PULL 22/25] libqtest: Replace qtest_startf() by qtest_initf(), Markus Armbruster, 2018/08/16
- [Qemu-devel] [PULL 17/25] migration-test: Make wait_command() cope with '%', Markus Armbruster, 2018/08/16
- [Qemu-devel] [PULL 23/25] libqtest: Rename qtest_FOOv() to qtest_vFOO() for consistency, Markus Armbruster, 2018/08/16
- [Qemu-devel] [PULL 09/25] test-qobject-input-visitor: Avoid format string ambiguity, Markus Armbruster, 2018/08/16
- [Qemu-devel] [PULL 20/25] migration-test: Clean up string interpolation into QMP, part 3, Markus Armbruster, 2018/08/16
- [Qemu-devel] [PULL 13/25] cpu-plug-test: Don't pass integers as strings to device_add, Markus Armbruster, 2018/08/16
- [Qemu-devel] [PULL 11/25] tests: Pass literal format strings directly to qmp_FOO(), Markus Armbruster, 2018/08/16
- [Qemu-devel] [PULL 15/25] migration-test: Make wait_command() return the "return" member, Markus Armbruster, 2018/08/16