[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 24/31] docs/devel: more documentation on the use of suffixes
From: |
Alex Bennée |
Subject: |
[PULL 24/31] docs/devel: more documentation on the use of suffixes |
Date: |
Wed, 12 Jan 2022 11:27:15 +0000 |
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>
diff --git a/docs/devel/style.rst b/docs/devel/style.rst
index 4f770002a7..793a8d4280 100644
--- a/docs/devel/style.rst
+++ b/docs/devel/style.rst
@@ -151,6 +151,12 @@ If there are two versions of a function to be called with
or without a
lock held, the function that expects the lock to be already held
usually uses the suffix ``_locked``.
+If a function is a shim designed to deal with compatibility
+workarounds we use the suffix ``_compat``. These are generally not
+called directly and aliased to the plain function name via the
+pre-processor. Another common suffix is ``_impl``; it is used for the
+concrete implementation of a function that will not be called
+directly, but rather through a macro or an inline function.
Block structure
===============
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,
--
2.30.2
- [PULL 22/31] monitor: move x-query-profile into accel/tcg to fix build, (continued)
- [PULL 22/31] monitor: move x-query-profile into accel/tcg to fix build, Alex Bennée, 2022/01/12
- [PULL 23/31] docs/devel: update C standard to C11, Alex Bennée, 2022/01/12
- [PULL 25/31] linux-user/elfload: add extra logging for hole finding, Alex Bennée, 2022/01/12
- [PULL 31/31] linux-user: Remove the deprecated ppc64abi32 target, Alex Bennée, 2022/01/12
- [PULL 11/31] tests/docker: auto-generate ubuntu2004.docker with lcitool, Alex Bennée, 2022/01/12
- [PULL 30/31] docker: include bison in debian-tricore-cross, Alex Bennée, 2022/01/12
- [PULL 19/31] tests/tcg: use CONFIG_LINUX_USER, not CONFIG_LINUX, Alex Bennée, 2022/01/12
- [PULL 26/31] linux-user: don't adjust base of found hole, Alex Bennée, 2022/01/12
- [PULL 29/31] FreeBSD: Upgrade to 12.3 release, Alex Bennée, 2022/01/12
- [PULL 28/31] test/tcg/ppc64le: Add float reference files, Alex Bennée, 2022/01/12
- [PULL 24/31] docs/devel: more documentation on the use of suffixes,
Alex Bennée <=
- [PULL 27/31] tests/tcg/multiarch: Read fp flags before printf, Alex Bennée, 2022/01/12
- Re: [PULL 00/31] testing/next and other misc fixes, Peter Maydell, 2022/01/12