From nobody Sat May 18 15:49:45 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) client-ip=170.10.129.124; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-124.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1692966894; cv=none; d=zohomail.com; s=zohoarc; b=H817P7+P76GpUQMOFP44RtMWXYXy/egV/YJL6DlJpjts1d/CUs0TlbsZyr74inLp8GaS7OP7WEaoKJu7kPSFAljeoHs8sCLcWkscWHV3+Lzi3lPv0aPQPv4rgtJ3nKdoqBciltogRqLxGV+BxNvm8N2dN+Cu8qm5dom7mVMgGko= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1692966894; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:Sender:Subject:To; bh=h+5DzzO7myM9CKSssVjgLyCcYygrrLiGxkGHYYBiHtE=; b=Yy77nYlvqYQHamyx8UjbO6QP95CpWjIcl+bNNuyLPV777FTKO5X5UZaYhacc9d4wERdudqGrE29FuTghcOAiXNYGbsFRFwdlO44E08KAHAtqfnPbAT2R98vRZLfDzBDwpQNkgSflVk3g7nWOv0m41xj2nuCWcYSQ8qgbuFZK1P4= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) by mx.zohomail.com with SMTPS id 1692966894470985.6341600176061; Fri, 25 Aug 2023 05:34:54 -0700 (PDT) Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-85-VMGMAuxrO7C0papoGp-zJQ-1; Fri, 25 Aug 2023 08:34:50 -0400 Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.rdu2.redhat.com [10.11.54.4]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 53202800270; Fri, 25 Aug 2023 12:34:48 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com [10.30.29.100]) by smtp.corp.redhat.com (Postfix) with ESMTP id 321CF2026D68; Fri, 25 Aug 2023 12:34:47 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (localhost [IPv6:::1]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id C7B7F19465B1; Fri, 25 Aug 2023 12:34:46 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.rdu2.redhat.com [10.11.54.4]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id A0CF019465B2 for ; Fri, 25 Aug 2023 12:34:08 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id ACA302026D68; Fri, 25 Aug 2023 12:34:08 +0000 (UTC) Received: from speedmetal.lan (unknown [10.45.242.14]) by smtp.corp.redhat.com (Postfix) with ESMTP id 0CF512026D76; Fri, 25 Aug 2023 12:34:07 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1692966893; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=h+5DzzO7myM9CKSssVjgLyCcYygrrLiGxkGHYYBiHtE=; b=azkTfH12h+c6l3vvW17/YHxxNP1Wo7q0YEEJrXGMIDfr3XCc1Jasc0EpiGXl3or2+CjGvy h6Ee+swL6vLvjtCgSzocCF6xOFPhroiEShS41N609nz7CQfZ1pRbnifl6AXit+c8aYr1KB fXAIghxbdowpL2y9E5ze6jd3fXhUcsc= X-MC-Unique: VMGMAuxrO7C0papoGp-zJQ-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Peter Krempa To: libvir-list@redhat.com Subject: [PATCH] docs: Improve documentation of Date: Fri, 25 Aug 2023 14:34:04 +0200 Message-ID: <4a1a0547b25ff5fe3d2cbc3c5cf9af0119de694d.1692966844.git.pkrempa@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.1 on 10.11.54.4 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Peter Krempa Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" X-Scanned-By: MIMEDefang 3.1 on 10.11.54.4 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1692966896778100001 Content-Type: text/plain; charset="utf-8" Note the implications and caveats of . Closes: https://gitlab.com/libvirt/libvirt/-/issues/519 Signed-off-by: Peter Krempa Reviewed-by: J=C3=A1n Tomko Reviewed-by: Pavel Hrdina --- docs/formatdomain.rst | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst index cd9cb02bf8..9787933d4d 100644 --- a/docs/formatdomain.rst +++ b/docs/formatdomain.rst @@ -2634,6 +2634,12 @@ paravirtualized driver is specified via the ``disk``= element. + + + + + + @@ -2757,6 +2763,18 @@ paravirtualized driver is specified via the ``disk``= element. ``dir`` The ``dir`` attribute specifies the fully-qualified path to the dire= ctory to use as the disk. :since:`Since 0.7.5` + + Note that most hypervisors that support ``dir`` disks do that by exp= osing + an emulated block device with an emulated filesystem populated with + contents of the configured directory. As guest operating system may = cache + the filesystem metadata, outside changes to the directory may not ap= pear + in the guest and/or may result in corrupted data being observable fr= om + the VM. + + The format of the emulated filesystem is controlled by the ``format`` + attribute of the ```` driver element. Currently only the ``f= at`` + format is supported. Hypervisors may only support ```` mo= de. + ``network`` The ``protocol`` attribute specifies the protocol to access to the requested image. Possible values are "nbd", "iscsi", "rbd", "sheepdo= g", --=20 2.41.0