Skip to content

Commit f4618f1

Browse files
committed
Update libkrun.h documentation
Adds documentation stating it is supported to use Qcow2 disk images in addition to Raw disk images. Signed-off-by: Jake Correnti <[email protected]>
1 parent 7a61c07 commit f4618f1

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

include/libkrun.h

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ int32_t krun_set_root(uint32_t ctx_id, const char *root_path);
6666
* DEPRECATED. Use krun_add_disk instead.
6767
*
6868
* Sets the path to the disk image that contains the file-system to be used as root for the microVM.
69-
* The only supported image format is "raw".
69+
* The supported image formats are: "raw" and "qcow2".
7070
*
7171
* Arguments:
7272
* "ctx_id" - the configuration context ID.
@@ -82,7 +82,7 @@ int32_t krun_set_root_disk(uint32_t ctx_id, const char *disk_path);
8282
* DEPRECATED. Use krun_add_disk instead.
8383
*
8484
* Sets the path to the disk image that contains the file-system to be used as
85-
* a data partition for the microVM. The only supported image format is "raw".
85+
* a data partition for the microVM. The supported image formats are: "raw" and "qcow2".
8686
*
8787
* Arguments:
8888
* "ctx_id" - the configuration context ID.
@@ -95,7 +95,8 @@ int32_t krun_set_root_disk(uint32_t ctx_id, const char *disk_path);
9595
int32_t krun_set_data_disk(uint32_t ctx_id, const char *disk_path);
9696

9797
/**
98-
* Adds a disk image to be used as a general partition for the microVM.
98+
* Adds a disk image to be used as a general partition for the microVM. The supported image
99+
* formats are: "raw" and "qcow2".
99100
*
100101
* This API is mutually exclusive with the deprecated krun_set_root_disk and
101102
* krun_set_data_disk methods and must not be used together.

0 commit comments

Comments
 (0)