[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH-for-5.1 3/4] qemu-common: Document qemu_find_file()
From: |
Philippe Mathieu-Daudé |
Subject: |
[PATCH-for-5.1 3/4] qemu-common: Document qemu_find_file() |
Date: |
Tue, 14 Jul 2020 18:42:56 +0200 |
Document qemu_find_file(), in particular the returned
value which must be freed.
Signed-off-by: Philippe Mathieu-Daudé <f4bug@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
- [PATCH-for-5.1 0/4] misc: Document qemu_find_file and fix memory leak in avr_load_firmware, Philippe Mathieu-Daudé, 2020/07/14
- [PATCH-for-5.1 1/4] qemu/osdep: Document os_find_datadir() return value, Philippe Mathieu-Daudé, 2020/07/14
- [PATCH-for-5.1 2/4] qemu/osdep: Reword qemu_get_exec_dir() documentation, Philippe Mathieu-Daudé, 2020/07/14
- [PATCH-for-5.1 4/4] hw/avr/boot: Fix memory leak in avr_load_firmware(), Philippe Mathieu-Daudé, 2020/07/14
- [PATCH-for-5.1 3/4] qemu-common: Document qemu_find_file(),
Philippe Mathieu-Daudé <=
- Re: [PATCH-for-5.1 0/4] misc: Document qemu_find_file and fix memory leak in avr_load_firmware, Michael Rolnik, 2020/07/20
- Re: [PATCH-for-5.1 0/4] misc: Document qemu_find_file and fix memory leak in avr_load_firmware, Philippe Mathieu-Daudé, 2020/07/20