diff options
| author | Alex Bennée <alex.bennee@linaro.org> | 2022-01-05 13:49:59 +0000 |
|---|---|---|
| committer | Alex Bennée <alex.bennee@linaro.org> | 2022-01-18 16:42:42 +0000 |
| commit | 3918fe16b0f8c6657928a14f41b7ff50061e33e1 (patch) | |
| tree | 344efd6081f54abcf605507ce70baf050aa057e6 /include/glib-compat.h | |
| parent | a68e025bf5103280be6cfeab19452491b793e679 (diff) | |
docs/devel: more documentation on the use of suffixes
Using _qemu is a little confusing. Let's use _compat for these sorts
of things. We should also mention _impl which is another common suffix
in the code base.
Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>
Message-Id: <20220105135009.1584676-25-alex.bennee@linaro.org>
Diffstat (limited to 'include/glib-compat.h')
| -rw-r--r-- | include/glib-compat.h | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/include/glib-compat.h b/include/glib-compat.h index 8d01a8c01f..3113a7d2af 100644 --- a/include/glib-compat.h +++ b/include/glib-compat.h @@ -46,9 +46,9 @@ * int g_foo(const char *wibble) * * We must define a static inline function with the same signature that does - * what we need, but with a "_qemu" suffix e.g. + * what we need, but with a "_compat" suffix e.g. * - * static inline void g_foo_qemu(const char *wibble) + * static inline void g_foo_compat(const char *wibble) * { * #if GLIB_CHECK_VERSION(X, Y, 0) * g_foo(wibble) @@ -61,7 +61,7 @@ * ensuring this wrapper function impl doesn't trigger the compiler warning * about using too new glib APIs. Finally we can do * - * #define g_foo(a) g_foo_qemu(a) + * #define g_foo(a) g_foo_compat(a) * * So now the code elsewhere in QEMU, which *does* have the * -Wdeprecated-declarations warning active, can call g_foo(...) as normal, |