From 2eada815b577e9811fc62f98bad6b31bde560421 Mon Sep 17 00:00:00 2001 From: Peter Krempa Date: Thu, 1 Oct 2020 15:52:34 +0200 Subject: [PATCH] virBitmapToString|virBitmapNewString: Clarify semantics of the 'string' MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Clarify which bit is considered most significant in the bitmap and resulting string. Also be explicit that it's a hex string. Signed-off-by: Peter Krempa Reviewed-by: Ján Tomko --- src/util/virbitmap.c | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/src/util/virbitmap.c b/src/util/virbitmap.c index ad5213f216..ed28427736 100644 --- a/src/util/virbitmap.c +++ b/src/util/virbitmap.c @@ -328,7 +328,9 @@ virBitmapGetBit(virBitmapPtr bitmap, * virBitmapToString: * @bitmap: Pointer to bitmap * - * Convert @bitmap to printable string. + * Convert @bitmap to a number where the bit with highest position/index in + * @bitmap represents the most significant bit and return the number in form + * of a hexadecimal string. * * Returns pointer to the string or NULL on error. */ @@ -1117,10 +1119,14 @@ virBitmapCountBits(virBitmapPtr bitmap) * virBitmapNewString: * @string: the string to be converted to a bitmap * - * Allocate a bitmap from a string of hexadecimal data. + * Allocate a bitmap and populate it from @string representing a number in + * hexadecimal format. Note that the most significant bit of the number + * represented by @string will correspond to the highest index/position in the + * bitmap. The size of the returned bitmap corresponds to 4 * the length of + * @string. * - * Returns a pointer to the allocated bitmap or NULL if - * memory cannot be allocated. + * Returns a pointer to the allocated bitmap or NULL and reports an error if + * @string can't be converted. */ virBitmapPtr virBitmapNewString(const char *string) -- 2.47.2