1
0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2025-01-14 23:24:23 +03:00

util: bitmap: Mention the size == 0 handling

As there is an explicit constructor for the special case of empty
bitmaps, we should mention that the generic constructors rejects the
creation of empty bitmaps.

Reviewed-by: Boris Fiuczynski <fiuczy@linux.vnet.ibm.com>
Reviewed-by: Sascha Silbe <silbe@linux.vnet.ibm.com>
Reviewed-by: Bjoern Walk <bwalk@linux.vnet.ibm.com>
Signed-off-by: Marc Hartmayer <mhartmay@linux.vnet.ibm.com>
This commit is contained in:
Marc Hartmayer 2016-07-06 14:02:27 +02:00 committed by Michal Privoznik
parent 7cd01a248b
commit bd125c28b7

View File

@ -60,8 +60,8 @@ struct _virBitmap {
*
* Allocate a bitmap capable of containing @size bits.
*
* Returns a pointer to the allocated bitmap or NULL if memory cannot be
* allocated. Does not report libvirt errors.
* Returns a pointer to the allocated bitmap or NULL if either memory cannot be
* allocated or size is 0. Does not report libvirt errors.
*/
virBitmapPtr
virBitmapNewQuiet(size_t size)
@ -95,8 +95,8 @@ virBitmapNewQuiet(size_t size)
*
* Allocate a bitmap capable of containing @size bits.
*
* Returns a pointer to the allocated bitmap or NULL if memory cannot be
* allocated. Reports libvirt errors.
* Returns a pointer to the allocated bitmap or NULL if either memory cannot be
* allocated or size is 0. Reports libvirt errors.
*/
virBitmapPtr
virBitmapNew(size_t size)