From: Eric Blake <ebl...@redhat.com> 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 <ebl...@redhat.com> Reviewed-by: Stefan Hajnoczi <stefa...@redhat.com> Reviewed-by: Markus Armbruster <arm...@redhat.com> [Rebased, comment wording tweaked, commit message rewritten] Signed-off-by: Markus Armbruster <arm...@redhat.com> Message-Id: <20180806065344.7103-6-arm...@redhat.com> --- 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
