From 330ed419d0391a96502585d7685dfa1fbc0d12f9 Mon Sep 17 00:00:00 2001 From: Jake Correnti Date: Tue, 12 Nov 2024 17:57:35 -0500 Subject: [PATCH] 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 --- include/libkrun.h | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/include/libkrun.h b/include/libkrun.h index 16619aac..cb6477fd 100644 --- 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.