openkylin
/
qemu
mirror of https://gitee.com/openkylin/qemu.git
9
0
Fork 0
Code Issues Projects Releases Wiki Activity

qemu-common: Document qemu_find_file() 

Document qemu_find_file(), in particular the returned
value which must be freed.

Signed-off-by: Philippe Mathieu-Daudé <f4bug@amsat.org>
Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
Reviewed-by: Li Qiang <liq3ea@gmail.com>
Reviewed-by: Michael Rolnik <mrolnik@gmail.com>
Tested-by: Michael Rolnik <mrolnik@gmail.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
Message-Id: <20200714164257.23330-4-f4bug@amsat.org>
This commit is contained in:
Philippe Mathieu-Daudé 2020-07-14 18:10:10 +02:00
parent d450cccc9a
commit b6c61f6934
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
include/qemu-common.h
View File

@ -110,6 +110,23 @@ 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: Relative or absolute file name
*
* If @name exists on disk as an absolute path, or a path relative
* to the current directory, then returns @name unchanged.
* Otherwise searches 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: a path that can access @name, or NULL if no matching file exists.
*/
char *qemu_find_file(int type, const char *name);
/* OS specific functions */