main loop: add missing documentation links to GS/IO macros
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>
This commit is contained in:
parent
e13fe274bf
commit
21b1d97459
|
@ -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 */ \
|
||||
|
|
Loading…
Reference in New Issue