| Message ID | 20190104181208.7809-2-philmd@redhat.com |
|---|---|
| State | New |
| Headers | show |
| Series | cutils: Cleanup, improve documentation | expand |
On 1/4/19 12:12 PM, Philippe Mathieu-Daudé wrote: > The size_to_str() function doesn't need to be in a generic header. > > It makes also sens to find this function in the same header than s/sens/sense/ s/than/as/ > the opposite string to size functions: qemu_strtosz*(). > Note than this function is already implemented in util/cutils.c. s/than/that/ > > Since we introduce a new function in a header, we document it, > using the previous comment from the source file. > > Signed-off-by: Philippe Mathieu-Daudé <philmd@redhat.com> > --- Reviewed-by: Eric Blake <eblake@redhat.com>
On Fri, Jan 04, 2019 at 07:12:06PM +0100, Philippe Mathieu-Daudé wrote: > The size_to_str() function doesn't need to be in a generic header. > > It makes also sens to find this function in the same header than > the opposite string to size functions: qemu_strtosz*(). > Note than this function is already implemented in util/cutils.c. > > Since we introduce a new function in a header, we document it, > using the previous comment from the source file. > > Signed-off-by: Philippe Mathieu-Daudé <philmd@redhat.com> Reviewed-by: David Gibson <david@gibson.dropbear.id.au> > --- > include/qemu-common.h | 1 - > include/qemu/cutils.h | 13 +++++++++++++ > qapi/string-output-visitor.c | 2 +- > util/cutils.c | 6 ------ > 4 files changed, 14 insertions(+), 8 deletions(-) > > diff --git a/include/qemu-common.h b/include/qemu-common.h > index ed60ba251d..760527294f 100644 > --- a/include/qemu-common.h > +++ b/include/qemu-common.h > @@ -153,7 +153,6 @@ void qemu_hexdump(const char *buf, FILE *fp, const char *prefix, size_t size); > int parse_debug_env(const char *name, int max, int initial); > > const char *qemu_ether_ntoa(const MACAddr *mac); > -char *size_to_str(uint64_t val); > void page_size_init(void); > > /* returns non-zero if dump is in progress, otherwise zero is > diff --git a/include/qemu/cutils.h b/include/qemu/cutils.h > index d2dad3057c..9ee40470e3 100644 > --- a/include/qemu/cutils.h > +++ b/include/qemu/cutils.h > @@ -157,6 +157,19 @@ int qemu_strtosz(const char *nptr, const char **end, uint64_t *result); > int qemu_strtosz_MiB(const char *nptr, const char **end, uint64_t *result); > int qemu_strtosz_metric(const char *nptr, const char **end, uint64_t *result); > > +/** > + * size_to_str: > + * > + * Return human readable string for size @val. > + * Use IEC binary units like KiB, MiB, and so forth. > + * > + * @val: The value to format. > + * Can be anything that uint64_t allows (no more than "16 EiB"). > + * > + * Caller is responsible for passing it to g_free(). > + */ > +char *size_to_str(uint64_t val); > + > /* used to print char* safely */ > #define STR_OR_NULL(str) ((str) ? (str) : "null") > > diff --git a/qapi/string-output-visitor.c b/qapi/string-output-visitor.c > index 7ab64468d9..edf268b373 100644 > --- a/qapi/string-output-visitor.c > +++ b/qapi/string-output-visitor.c > @@ -11,9 +11,9 @@ > */ > > #include "qemu/osdep.h" > -#include "qemu-common.h" > #include "qapi/string-output-visitor.h" > #include "qapi/visitor-impl.h" > +#include "qemu/cutils.h" > #include "qemu/host-utils.h" > #include <math.h> > #include "qemu/range.h" > diff --git a/util/cutils.c b/util/cutils.c > index e098debdc0..a8a3a3ba3b 100644 > --- a/util/cutils.c > +++ b/util/cutils.c > @@ -816,12 +816,6 @@ const char *qemu_ether_ntoa(const MACAddr *mac) > return ret; > } > > -/* > - * Return human readable string for size @val. > - * @val can be anything that uint64_t allows (no more than "16 EiB"). > - * Use IEC binary units like KiB, MiB, and so forth. > - * Caller is responsible for passing it to g_free(). > - */ > char *size_to_str(uint64_t val) > { > static const char *suffixes[] = { "", "Ki", "Mi", "Gi", "Ti", "Pi", "Ei" };
On Fri, Jan 4, 2019 at 7:12 PM Philippe Mathieu-Daudé <philmd@redhat.com> wrote: > > The size_to_str() function doesn't need to be in a generic header. > > It makes also sens to find this function in the same header than > the opposite string to size functions: qemu_strtosz*(). > Note than this function is already implemented in util/cutils.c. > > Since we introduce a new function in a header, we document it, > using the previous comment from the source file. > > Signed-off-by: Philippe Mathieu-Daudé <philmd@redhat.com> > --- > include/qemu-common.h | 1 - > include/qemu/cutils.h | 13 +++++++++++++ > qapi/string-output-visitor.c | 2 +- > util/cutils.c | 6 ------ > 4 files changed, 14 insertions(+), 8 deletions(-) Reviewed-by: Stefano Garzarella <sgarzare@redhat.com> > > diff --git a/include/qemu-common.h b/include/qemu-common.h > index ed60ba251d..760527294f 100644 > --- a/include/qemu-common.h > +++ b/include/qemu-common.h > @@ -153,7 +153,6 @@ void qemu_hexdump(const char *buf, FILE *fp, const char *prefix, size_t size); > int parse_debug_env(const char *name, int max, int initial); > > const char *qemu_ether_ntoa(const MACAddr *mac); > -char *size_to_str(uint64_t val); > void page_size_init(void); > > /* returns non-zero if dump is in progress, otherwise zero is > diff --git a/include/qemu/cutils.h b/include/qemu/cutils.h > index d2dad3057c..9ee40470e3 100644 > --- a/include/qemu/cutils.h > +++ b/include/qemu/cutils.h > @@ -157,6 +157,19 @@ int qemu_strtosz(const char *nptr, const char **end, uint64_t *result); > int qemu_strtosz_MiB(const char *nptr, const char **end, uint64_t *result); > int qemu_strtosz_metric(const char *nptr, const char **end, uint64_t *result); > > +/** > + * size_to_str: > + * > + * Return human readable string for size @val. > + * Use IEC binary units like KiB, MiB, and so forth. > + * > + * @val: The value to format. > + * Can be anything that uint64_t allows (no more than "16 EiB"). > + * > + * Caller is responsible for passing it to g_free(). > + */ > +char *size_to_str(uint64_t val); > + > /* used to print char* safely */ > #define STR_OR_NULL(str) ((str) ? (str) : "null") > > diff --git a/qapi/string-output-visitor.c b/qapi/string-output-visitor.c > index 7ab64468d9..edf268b373 100644 > --- a/qapi/string-output-visitor.c > +++ b/qapi/string-output-visitor.c > @@ -11,9 +11,9 @@ > */ > > #include "qemu/osdep.h" > -#include "qemu-common.h" > #include "qapi/string-output-visitor.h" > #include "qapi/visitor-impl.h" > +#include "qemu/cutils.h" > #include "qemu/host-utils.h" > #include <math.h> > #include "qemu/range.h" > diff --git a/util/cutils.c b/util/cutils.c > index e098debdc0..a8a3a3ba3b 100644 > --- a/util/cutils.c > +++ b/util/cutils.c > @@ -816,12 +816,6 @@ const char *qemu_ether_ntoa(const MACAddr *mac) > return ret; > } > > -/* > - * Return human readable string for size @val. > - * @val can be anything that uint64_t allows (no more than "16 EiB"). > - * Use IEC binary units like KiB, MiB, and so forth. > - * Caller is responsible for passing it to g_free(). > - */ > char *size_to_str(uint64_t val) > { > static const char *suffixes[] = { "", "Ki", "Mi", "Gi", "Ti", "Pi", "Ei" }; > -- > 2.17.2 >
On Fri, 4 Jan 2019 19:12:06 +0100 Philippe Mathieu-Daudé <philmd@redhat.com> wrote: > The size_to_str() function doesn't need to be in a generic header. > > It makes also sens to find this function in the same header than > the opposite string to size functions: qemu_strtosz*(). > Note than this function is already implemented in util/cutils.c. > > Since we introduce a new function in a header, we document it, > using the previous comment from the source file. > > Signed-off-by: Philippe Mathieu-Daudé <philmd@redhat.com> > --- > include/qemu-common.h | 1 - > include/qemu/cutils.h | 13 +++++++++++++ > qapi/string-output-visitor.c | 2 +- > util/cutils.c | 6 ------ > 4 files changed, 14 insertions(+), 8 deletions(-) With the patch description fixed (as noted by Eric): Reviewed-by: Cornelia Huck <cohuck@redhat.com>
On 04/01/2019 19:12, Philippe Mathieu-Daudé wrote: > The size_to_str() function doesn't need to be in a generic header. > > It makes also sens to find this function in the same header than > the opposite string to size functions: qemu_strtosz*(). > Note than this function is already implemented in util/cutils.c. > > Since we introduce a new function in a header, we document it, > using the previous comment from the source file. > > Signed-off-by: Philippe Mathieu-Daudé <philmd@redhat.com> > --- > include/qemu-common.h | 1 - > include/qemu/cutils.h | 13 +++++++++++++ > qapi/string-output-visitor.c | 2 +- > util/cutils.c | 6 ------ > 4 files changed, 14 insertions(+), 8 deletions(-) > > diff --git a/include/qemu-common.h b/include/qemu-common.h > index ed60ba251d..760527294f 100644 > --- a/include/qemu-common.h > +++ b/include/qemu-common.h > @@ -153,7 +153,6 @@ void qemu_hexdump(const char *buf, FILE *fp, const char *prefix, size_t size); > int parse_debug_env(const char *name, int max, int initial); > > const char *qemu_ether_ntoa(const MACAddr *mac); > -char *size_to_str(uint64_t val); > void page_size_init(void); > > /* returns non-zero if dump is in progress, otherwise zero is > diff --git a/include/qemu/cutils.h b/include/qemu/cutils.h > index d2dad3057c..9ee40470e3 100644 > --- a/include/qemu/cutils.h > +++ b/include/qemu/cutils.h > @@ -157,6 +157,19 @@ int qemu_strtosz(const char *nptr, const char **end, uint64_t *result); > int qemu_strtosz_MiB(const char *nptr, const char **end, uint64_t *result); > int qemu_strtosz_metric(const char *nptr, const char **end, uint64_t *result); > > +/** > + * size_to_str: > + * > + * Return human readable string for size @val. > + * Use IEC binary units like KiB, MiB, and so forth. > + * > + * @val: The value to format. > + * Can be anything that uint64_t allows (no more than "16 EiB"). > + * > + * Caller is responsible for passing it to g_free(). > + */ > +char *size_to_str(uint64_t val); > + > /* used to print char* safely */ > #define STR_OR_NULL(str) ((str) ? (str) : "null") > > diff --git a/qapi/string-output-visitor.c b/qapi/string-output-visitor.c > index 7ab64468d9..edf268b373 100644 > --- a/qapi/string-output-visitor.c > +++ b/qapi/string-output-visitor.c > @@ -11,9 +11,9 @@ > */ > > #include "qemu/osdep.h" > -#include "qemu-common.h" > #include "qapi/string-output-visitor.h" > #include "qapi/visitor-impl.h" > +#include "qemu/cutils.h" > #include "qemu/host-utils.h" > #include <math.h> > #include "qemu/range.h" > diff --git a/util/cutils.c b/util/cutils.c > index e098debdc0..a8a3a3ba3b 100644 > --- a/util/cutils.c > +++ b/util/cutils.c > @@ -816,12 +816,6 @@ const char *qemu_ether_ntoa(const MACAddr *mac) > return ret; > } > > -/* > - * Return human readable string for size @val. > - * @val can be anything that uint64_t allows (no more than "16 EiB"). > - * Use IEC binary units like KiB, MiB, and so forth. > - * Caller is responsible for passing it to g_free(). > - */ > char *size_to_str(uint64_t val) > { > static const char *suffixes[] = { "", "Ki", "Mi", "Gi", "Ti", "Pi", "Ei" }; > Applied to my trivial-patches branch with updated patch description. Thanks, Laurent
diff --git a/include/qemu-common.h b/include/qemu-common.h index ed60ba251d..760527294f 100644 --- a/include/qemu-common.h +++ b/include/qemu-common.h @@ -153,7 +153,6 @@ void qemu_hexdump(const char *buf, FILE *fp, const char *prefix, size_t size); int parse_debug_env(const char *name, int max, int initial); const char *qemu_ether_ntoa(const MACAddr *mac); -char *size_to_str(uint64_t val); void page_size_init(void); /* returns non-zero if dump is in progress, otherwise zero is diff --git a/include/qemu/cutils.h b/include/qemu/cutils.h index d2dad3057c..9ee40470e3 100644 --- a/include/qemu/cutils.h +++ b/include/qemu/cutils.h @@ -157,6 +157,19 @@ int qemu_strtosz(const char *nptr, const char **end, uint64_t *result); int qemu_strtosz_MiB(const char *nptr, const char **end, uint64_t *result); int qemu_strtosz_metric(const char *nptr, const char **end, uint64_t *result); +/** + * size_to_str: + * + * Return human readable string for size @val. + * Use IEC binary units like KiB, MiB, and so forth. + * + * @val: The value to format. + * Can be anything that uint64_t allows (no more than "16 EiB"). + * + * Caller is responsible for passing it to g_free(). + */ +char *size_to_str(uint64_t val); + /* used to print char* safely */ #define STR_OR_NULL(str) ((str) ? (str) : "null") diff --git a/qapi/string-output-visitor.c b/qapi/string-output-visitor.c index 7ab64468d9..edf268b373 100644 --- a/qapi/string-output-visitor.c +++ b/qapi/string-output-visitor.c @@ -11,9 +11,9 @@ */ #include "qemu/osdep.h" -#include "qemu-common.h" #include "qapi/string-output-visitor.h" #include "qapi/visitor-impl.h" +#include "qemu/cutils.h" #include "qemu/host-utils.h" #include <math.h> #include "qemu/range.h" diff --git a/util/cutils.c b/util/cutils.c index e098debdc0..a8a3a3ba3b 100644 --- a/util/cutils.c +++ b/util/cutils.c @@ -816,12 +816,6 @@ const char *qemu_ether_ntoa(const MACAddr *mac) return ret; } -/* - * Return human readable string for size @val. - * @val can be anything that uint64_t allows (no more than "16 EiB"). - * Use IEC binary units like KiB, MiB, and so forth. - * Caller is responsible for passing it to g_free(). - */ char *size_to_str(uint64_t val) { static const char *suffixes[] = { "", "Ki", "Mi", "Gi", "Ti", "Pi", "Ei" };
The size_to_str() function doesn't need to be in a generic header. It makes also sens to find this function in the same header than the opposite string to size functions: qemu_strtosz*(). Note than this function is already implemented in util/cutils.c. Since we introduce a new function in a header, we document it, using the previous comment from the source file. Signed-off-by: Philippe Mathieu-Daudé <philmd@redhat.com> --- include/qemu-common.h | 1 - include/qemu/cutils.h | 13 +++++++++++++ qapi/string-output-visitor.c | 2 +- util/cutils.c | 6 ------ 4 files changed, 14 insertions(+), 8 deletions(-)