Document qemu_find_file(), in particular the returned value which must be freed.
Signed-off-by: Philippe Mathieu-Daudé <f4...@amsat.org> --- include/qemu-common.h | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/include/qemu-common.h b/include/qemu-common.h index d0142f29ac..d6a08259d3 100644 --- a/include/qemu-common.h +++ b/include/qemu-common.h @@ -110,6 +110,20 @@ const char *qemu_get_vm_name(void); #define QEMU_FILE_TYPE_BIOS 0 #define QEMU_FILE_TYPE_KEYMAP 1 +/** + * qemu_find_file: + * @type: QEMU_FILE_TYPE_BIOS (for BIOS, VGA BIOS) + * or QEMU_FILE_TYPE_KEYMAP (for keymaps). + * @name: File name + * + * Search for @name file in the data directories, either configured at + * build time (DATADIR) or registered with the -L command line option. + * + * The caller must use g_free() to free the returned data when it is + * no longer required. + * + * Returns: absolute path to the file or NULL on error. + */ char *qemu_find_file(int type, const char *name); /* OS specific functions */ -- 2.21.3