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]>
containers · Nov 12, 2024 · 330ed41 · 330ed41
1 parent 2478195
commit 330ed41
Showing 1 changed file with 4 additions and 3 deletions.
diff --git a/include/libkrun.h b/include/libkrun.h
@@ -66,7 +66,7 @@ int32_t krun_set_root(uint32_t ctx_id, const char *root_path);
  * DEPRECATED. Use krun_add_disk instead.
  *
  * Sets the path to the disk image that contains the file-system to be used as root for the microVM.
- * The only supported image format is "raw".
+ * The supported image formats are: "raw" and "qcow2".
  *
  * Arguments:
  *  "ctx_id"    - the configuration context ID.
@@ -82,7 +82,7 @@ int32_t krun_set_root_disk(uint32_t ctx_id, const char *disk_path);
  * DEPRECATED. Use krun_add_disk instead.
  *
  * Sets the path to the disk image that contains the file-system to be used as
- * a data partition for the microVM.  The only supported image format is "raw".
+ * a data partition for the microVM.  The supported image formats are: "raw" and "qcow2".
  *
  * Arguments:
  *  "ctx_id"    - the configuration context ID.
@@ -95,7 +95,8 @@ int32_t krun_set_root_disk(uint32_t ctx_id, const char *disk_path);
 int32_t krun_set_data_disk(uint32_t ctx_id, const char *disk_path);
 
 /**
- * Adds a disk image to be used as a general partition for the microVM.
+ * Adds a disk image to be used as a general partition for the microVM. The supported image
+ * formats are: "raw" and "qcow2".
  *
  * This API is mutually exclusive with the deprecated krun_set_root_disk and
  * krun_set_data_disk methods and must not be used together.