From nobody Sat Nov 23 18:11:06 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of lists.libvirt.org designates 8.43.85.245 as permitted sender) client-ip=8.43.85.245; envelope-from=devel-bounces@lists.libvirt.org; helo=lists.libvirt.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of lists.libvirt.org designates 8.43.85.245 as permitted sender) smtp.mailfrom=devel-bounces@lists.libvirt.org; dmarc=pass(p=reject dis=none) header.from=lists.libvirt.org ARC-Seal: i=1; a=rsa-sha256; t=1723847180; cv=none; d=zohomail.com; s=zohoarc; b=YssIVP7ae09xyu5cHcEuwXdA19Iyc2uAFQecS6xWZtwIn3KseFOmcq4DYEHpxsGp2bj0aRou3AR8/11EVJOLBtFSq6jIGsNvZMIssZVPk3PF1BFwj5SmOaC0P9W6KvPydoxYkAzHr+ynYI/GxsEyFMmfOOHPt77ZqKG3yeViF2U= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1723847180; h=Content-Transfer-Encoding:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:Reply-To:Reply-To:References:Subject:Subject:To:To:Message-Id:Cc; bh=MGB5ws6gv/iRBtPgZRmVcE7aIvzUYQwSTiQpGqrQ7RA=; b=GPEDlo08q1rNEmfsxgGxPvixJE0Y6cKileDyjWZXa91la8FVks+RjQptzaH5oEVEq/9pINClYBXzgDMAVAkxT7dCaFRm/pwmJpMNjEtqBOoyxuh3MlQhSE2EOi/G2TkU13QypKoMMO9PIcyRBgooMsy38u9Hok0rO7RZ72pk0BQ= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of lists.libvirt.org designates 8.43.85.245 as permitted sender) smtp.mailfrom=devel-bounces@lists.libvirt.org; dmarc=pass header.from= (p=reject dis=none) Return-Path: Received: from lists.libvirt.org (lists.libvirt.org [8.43.85.245]) by mx.zohomail.com with SMTPS id 1723847180281376.11163687456576; Fri, 16 Aug 2024 15:26:20 -0700 (PDT) Received: by lists.libvirt.org (Postfix, from userid 996) id 1BF231456; Fri, 16 Aug 2024 18:26:19 -0400 (EDT) Received: from lists.libvirt.org (localhost [IPv6:::1]) by lists.libvirt.org (Postfix) with ESMTP id AFD22157F; Fri, 16 Aug 2024 18:25:37 -0400 (EDT) Received: by lists.libvirt.org (Postfix, from userid 996) id 07A4C13AD; Fri, 16 Aug 2024 18:25:33 -0400 (EDT) Received: from mail-wr1-f43.google.com (mail-wr1-f43.google.com [209.85.221.43]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by lists.libvirt.org (Postfix) with ESMTPS id 305411276 for ; Fri, 16 Aug 2024 18:25:32 -0400 (EDT) Received: by mail-wr1-f43.google.com with SMTP id ffacd0b85a97d-37186c2278bso1378755f8f.1 for ; Fri, 16 Aug 2024 15:25:32 -0700 (PDT) Received: from localhost ([69.51.98.148]) by smtp.gmail.com with ESMTPSA id 8926c6da1cb9f-4ccd6f74c38sm1496478173.135.2024.08.16.15.25.29 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 16 Aug 2024 15:25:30 -0700 (PDT) X-Spam-Checker-Version: SpamAssassin 3.4.4 (2020-01-24) on lists.libvirt.org X-Spam-Level: X-Spam-Status: No, score=-0.8 required=5.0 tests=DKIM_INVALID,DKIM_SIGNED, MAILING_LIST_MULTI,RCVD_IN_DNSWL_NONE,RCVD_IN_MSPIKE_H2,SPF_HELO_NONE, T_SCC_BODY_TEXT_LINE autolearn=unavailable autolearn_force=no version=3.4.4 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=suse.com; s=google; t=1723847131; x=1724451931; darn=lists.libvirt.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:to:from:from:to:cc:subject:date:message-id :reply-to; bh=1PXGh1vBYYJeBZrRN8LQG0i+JamNi3g98nZEl1uEjDw=; b=aKBvQ8ZLrM8D8ovf0R04v5zGVsu8u7trxylrOgdFUFTMNhJ2oyTcOaBsWws9pburX2 2x7c29tRLClcL89Fxfj9/fDHaU6gXAM8Ip3yuz0PqJ7YdH55UO62Ew+blGXfpXvBUm08 JNt276eV5A7MiYWDhX3LgyUqWrgdCqV1DJ+6rEBiTMb3EipMPJFFwRK/HsZaQwaHxSkb ifXlAdd33ZF/h6x6vAogDnz++MjH718yH88hUOfRASFvsGZyOs6PzbV0LhCXycQ9j4zP e+PN+dexj473dOGcoH05IN3gwXxMaqLzgWIMPq7Q9cToIh8sZq/kA2T5ftVhxaTesR50 LOeg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1723847131; x=1724451931; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=1PXGh1vBYYJeBZrRN8LQG0i+JamNi3g98nZEl1uEjDw=; b=ZkG3W5ywkxhe0ZzA2dEjwwgLLbbGJZH6NIHcXD1XM+m/jGoTwhfX9b75nAd7JN8/xu ItVhqjZfAkojAshFd6GBd9zL6Lw+/QNw8EW//EOv7tL0aIiuFQK9Rl1xzbpp3JQXt3Qt hF7yz9N/3nQ2ttQjscJiZCycszgIXmvqVrY+W4oEZLvzBJgfYWNPILp5UEeMCJPYHpty T5LOhLsmLd1AosUNLlCG/zHat2MIUKkksFsItMWcV1lDSrSAsrFdbieMVFnG5NFFbWN/ VsC5YrZoiHPb6vOegHb2knmcbaPR4AJrwXFr1DTJVyuJnVgL0AZhbC9GwX/DHieQ7Vr0 AmYA== X-Gm-Message-State: AOJu0YyehLMWdV9q1RgxhSmJRUVOr8VZhs7nDmKOgAkGqKAOmTOTGHDp u8BL2p1lTES5Oh6TrCkzO9dtFBXShHxjUnGABH0bO/QKlq5DzhqH6bXbz6uQfZYogXbJhTNHGpV v X-Google-Smtp-Source: AGHT+IHVpzN/e2Re+cGjJVA3By9CmplblJlj+pKYE3fl5/cfqiUQDDTxViYjYcJKapN/0+8OwCH/1w== X-Received: by 2002:a5d:4f03:0:b0:368:4467:c23e with SMTP id ffacd0b85a97d-37186df4026mr4116852f8f.30.1723847130780; Fri, 16 Aug 2024 15:25:30 -0700 (PDT) To: devel@lists.libvirt.org Subject: [PATCH V2 1/2] qemu: conf: Improve the foo_image_format setting descriptions Date: Fri, 16 Aug 2024 16:25:25 -0600 Message-Id: <20240816222526.21199-2-jfehlig@suse.com> X-Mailer: git-send-email 2.35.3 In-Reply-To: <20240816222526.21199-1-jfehlig@suse.com> References: <20240816222526.21199-1-jfehlig@suse.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Message-ID-Hash: FQ6FFV4PXSIUVZFK4PPS3CLCWIYFS65N X-Message-ID-Hash: FQ6FFV4PXSIUVZFK4PPS3CLCWIYFS65N X-MailFrom: jfehlig@suse.com X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; emergency; loop; banned-address; member-moderation; header-match-config-1; header-match-config-2; header-match-config-3; header-match-devel.lists.libvirt.org-0; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; suspicious-header X-Mailman-Version: 3.2.2 Precedence: list List-Id: Development discussions about the libvirt library & tools Archived-At: List-Archive: List-Help: List-Post: List-Subscribe: List-Unsubscribe: From: Jim Fehlig via Devel Reply-To: Jim Fehlig X-ZohoMail-DKIM: fail (Header signature does not verify) X-ZM-MESSAGEID: 1723847181544116600 Content-Type: text/plain; charset="utf-8" The current description of the various foo_image_format settings can be construded to imply the setting is only used to control compression of the image. Improve the documentation to clarify that format describes the representation of guest memory blocks on disk, which includes compression among other possible layouts. Signed-off-by: Jim Fehlig Reviewed-by: Martin Kletzander --- src/qemu/qemu.conf.in | 40 ++++++++++++++++++++++++---------------- 1 file changed, 24 insertions(+), 16 deletions(-) diff --git a/src/qemu/qemu.conf.in b/src/qemu/qemu.conf.in index 6bc2140dcb..d4fdd717ba 100644 --- a/src/qemu/qemu.conf.in +++ b/src/qemu/qemu.conf.in @@ -578,27 +578,35 @@ # "/dev/infiniband/uverbs0" =20 =20 -# The default format for QEMU/KVM guest save images is raw; that is, the -# memory from the domain is dumped out directly to a file. If you have -# guests with a large amount of memory, however, this can take up quite -# a bit of space. If you would like to compress the images while they -# are being saved to disk, you can also set "zstd", "lzop", "gzip", "bzip2= ", -# or "xz" for save_image_format. Note that this means you slow down the pr= ocess -# of saving a domain in order to save disk space. +# The libvirt QEMU driver supports serveral different save image formats. +# The term "format" is used loosely to describe how the save image data is +# represented on disk. It could be a continguous stream of guest memory bl= ocks, +# or a stream of compressed memory blocks. # -# save_image_format is used when you use 'virsh save' or 'virsh managedsav= e' -# at scheduled saving, and it is an error if the specified save_image_form= at -# is not valid, or the requested compression program can't be found. +# A continguous stream of guest memory blocks is the default format for QE= MU/KVM +# guest save images and is termed "raw". The raw format can consume consid= erable +# disk space when saving large memory guests. Various compression formats = are +# available for specifying a save image compressed by the named algorithm. +# Supported compression formats are "zstd", "lzop", "gzip", "bzip2", and "= xz". + +# save_image_format can be used to select the desired save format. "raw" is +# the traditional format used by libvirt and is also the default. The +# compression formats can be used to save disk space, although this typica= lly +# results in longer save and restore times. # -# dump_image_format is used when you use 'virsh dump' at emergency -# crashdump, and if the specified dump_image_format is not valid, or -# the requested compression program can't be found, this falls -# back to "raw" compression. +# save_image_format is used with 'virsh save' or 'virsh managedsave'. It is +# an error if the specified save_image_format is not valid, or cannot be +# supported by the system. # -# snapshot_image_format specifies the compression algorithm of the memory = save +# dump_image_format is analogous to save_image_format and is used with +# 'virsh dump' at emergency crashdump. If the specified dump_image_format = is +# not valid or cannot be supported by the system, this falls back to the +# "raw" format. +# +# Likewise, snapshot_image_format specifies the format of the memory save # image when an external snapshot of a domain is taken. This does not apply # on disk image format. It is an error if the specified format isn't valid, -# or the requested compression program can't be found. +# or the system cannot support the requested format. # #save_image_format =3D "raw" #dump_image_format =3D "raw" --=20 2.35.3