[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH-for-5.1 3/4] qemu-common: Document qemu_find_file()
From: |
Philippe Mathieu-Daudé |
Subject: |
Re: [PATCH-for-5.1 3/4] qemu-common: Document qemu_find_file() |
Date: |
Mon, 20 Jul 2020 20:43:26 +0200 |
User-agent: |
Mozilla/5.0 (X11; Linux x86_64; rv:68.0) Gecko/20100101 Thunderbird/68.5.0 |
On 7/20/20 4:16 PM, Daniel P. Berrangé wrote:
> On Tue, Jul 14, 2020 at 06:42:56PM +0200, Philippe Mathieu-Daudé wrote:
>> 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(+)
>
> Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
>
>>
>> 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
>
> s/File name/relative or absolute file name/
>
>> + *
>
> Insert:
>
> "If @name exists on disk as an absolute path, or a path relative
> to the current directory, then returns @name unchanged.
>
>
>> + * Search for @name file in the data directories, either configured at
>> + * build time (DATADIR) or registered with the -L command line option.
>
> s/Search/Otherwise searches/
>
>
>> + *
>> + * 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.
>
> It doesn't always return an absolute path. It can return a path
> relative to the currently working directory via the initial
> short-circuit access() check.
>
> Returns: a path that can access @name, or NULL if no matching
> file exists.
>
Thanks for the corrections!
>
> Regards,
> Daniel
>
- [PATCH-for-5.1 2/4] qemu/osdep: Reword qemu_get_exec_dir() documentation, (continued)
- [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é, 2020/07/14
- 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