| Message ID | 20200714164257.23330-4-f4bug@amsat.org |
|---|---|
| State | New |
| Headers | show |
| Series | misc: Document qemu_find_file and fix memory leak in avr_load_firmware | expand |
On Tue, 14 Jul 2020 at 17:43, Philippe Mathieu-Daudé <f4bug@amsat.org> 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(+) > > 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); Reviewed-by: Peter Maydell <peter.maydell@linaro.org> thanks -- PMM
Philippe Mathieu-Daudé <f4bug@amsat.org> 于2020年7月15日周三 上午12:48写道： > > Document qemu_find_file(), in particular the returned > value which must be freed. > > Signed-off-by: Philippe Mathieu-Daudé <f4bug@amsat.org> Reviewed-by: Li Qiang <liq3ea@gmail.com> > --- > 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 > >
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. Regards, Daniel
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 >
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 */
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(+)