[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 7/7] main loop: add missing documentation links to GS/IO macros
From: |
Kevin Wolf |
Subject: |
[PULL 7/7] main loop: add missing documentation links to GS/IO macros |
Date: |
Tue, 2 Aug 2022 15:37:57 +0200 |
From: Emanuele Giuseppe Esposito <eesposit@redhat.com>
If we go directly to GLOBAL_STATE_CODE, IO_CODE or IO_OR_GS_CODE
definition, we just find that they "mark and check that the function
is part of the {category} API".
However, ther is no definition on what {category} API is, they are
in include/block/block-*.h
Therefore, add a comment that refers to such documentation.
Signed-off-by: Emanuele Giuseppe Esposito <eesposit@redhat.com>
Message-Id: <20220609122206.1016936-1-eesposit@redhat.com>
Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
---
include/qemu/main-loop.h | 18 +++++++++++++++---
1 file changed, 15 insertions(+), 3 deletions(-)
diff --git a/include/qemu/main-loop.h b/include/qemu/main-loop.h
index 5518845299..c50d1b7e3a 100644
--- a/include/qemu/main-loop.h
+++ b/include/qemu/main-loop.h
@@ -279,7 +279,11 @@ bool qemu_mutex_iothread_locked(void);
*/
bool qemu_in_main_thread(void);
-/* Mark and check that the function is part of the global state API. */
+/*
+ * Mark and check that the function is part of the Global State API.
+ * Please refer to include/block/block-global-state.h for more
+ * information about GS API.
+ */
#ifdef CONFIG_COCOA
/*
* When using the Cocoa UI, addRemovableDevicesMenuItems() is called from
@@ -298,13 +302,21 @@ bool qemu_in_main_thread(void);
} while (0)
#endif /* CONFIG_COCOA */
-/* Mark and check that the function is part of the I/O API. */
+/*
+ * Mark and check that the function is part of the I/O API.
+ * Please refer to include/block/block-io.h for more
+ * information about IO API.
+ */
#define IO_CODE() \
do { \
/* nop */ \
} while (0)
-/* Mark and check that the function is part of the "I/O OR GS" API. */
+/*
+ * Mark and check that the function is part of the "I/O OR GS" API.
+ * Please refer to include/block/block-io.h for more
+ * information about "IO or GS" API.
+ */
#define IO_OR_GS_CODE() \
do { \
/* nop */ \
--
2.35.3
- [PULL 0/7] Block layer patches, Kevin Wolf, 2022/08/02
- [PULL 4/7] libvduse: Pass positive value to strerror(), Kevin Wolf, 2022/08/02
- [PULL 2/7] libvduse: Fix the incorrect function name, Kevin Wolf, 2022/08/02
- [PULL 1/7] block/io_uring: add missing include file, Kevin Wolf, 2022/08/02
- [PULL 3/7] libvduse: Replace strcpy() with strncpy(), Kevin Wolf, 2022/08/02
- [PULL 6/7] qemu-iotests: Discard stderr when probing devices, Kevin Wolf, 2022/08/02
- [PULL 7/7] main loop: add missing documentation links to GS/IO macros,
Kevin Wolf <=
- [PULL 5/7] hw/block/hd-geometry: Do not override specified bios-chs-trans, Kevin Wolf, 2022/08/02
- Re: [PULL 0/7] Block layer patches, Richard Henderson, 2022/08/02