Commit b6c61f69 authored by Philippe Mathieu-Daudé's avatar Philippe Mathieu-Daudé
Browse files

qemu-common: Document qemu_find_file() 



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

Signed-off-by: default avatarPhilippe Mathieu-Daudé <f4bug@amsat.org>
Reviewed-by: default avatarPeter Maydell <peter.maydell@linaro.org>
Reviewed-by: default avatarLi Qiang <liq3ea@gmail.com>
Reviewed-by: default avatarMichael Rolnik <mrolnik@gmail.com>
Tested-by: default avatarMichael Rolnik <mrolnik@gmail.com>
Reviewed-by: default avatarDaniel P. Berrangé <berrange@redhat.com>
Message-Id: <20200714164257.23330-4-f4bug@amsat.org>
parent d450cccc

include/qemu-common.h

+17 −0
Original line number Diff line number Diff line
@@ -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 */