From nobody Tue Feb 10 00:58:48 2026 Delivered-To: importer@patchew.org Received-SPF: none (zohomail.com: 8.43.85.245 is neither permitted nor denied by domain of lists.libvirt.org) client-ip=8.43.85.245; envelope-from=devel-bounces@lists.libvirt.org; helo=lists.libvirt.org; Authentication-Results: mx.zohomail.com; spf=none (zohomail.com: 8.43.85.245 is neither permitted nor denied by domain of lists.libvirt.org) smtp.mailfrom=devel-bounces@lists.libvirt.org; dmarc=fail(p=none dis=none) header.from=redhat.com Return-Path: Received: from lists.libvirt.org (lists.libvirt.org [8.43.85.245]) by mx.zohomail.com with SMTPS id 1708422840139418.46783380369163; Tue, 20 Feb 2024 01:54:00 -0800 (PST) Received: by lists.libvirt.org (Postfix, from userid 996) id B9A9619A5; Tue, 20 Feb 2024 04:53:58 -0500 (EST) Received: from lists.libvirt.org (localhost [IPv6:::1]) by lists.libvirt.org (Postfix) with ESMTP id 8748F1DAE; Tue, 20 Feb 2024 04:42:45 -0500 (EST) Received: by lists.libvirt.org (Postfix, from userid 996) id B7E6D1B4B; Tue, 20 Feb 2024 04:41:45 -0500 (EST) Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) (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 049FD187C for ; Tue, 20 Feb 2024 04:41:43 -0500 (EST) Received: from mimecast-mx02.redhat.com (mx-ext.redhat.com [66.187.233.73]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-74-KSGgfiPnPzqPgkwO27vNQQ-1; Tue, 20 Feb 2024 04:41:41 -0500 Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.rdu2.redhat.com [10.11.54.5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 6A26A285F981 for ; Tue, 20 Feb 2024 09:41:41 +0000 (UTC) Received: from harajuku.usersys.redhat.com.homenet.telecomitalia.it (unknown [10.45.224.52]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 018461074A for ; Tue, 20 Feb 2024 09:41:40 +0000 (UTC) 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=HEADER_FROM_DIFFERENT_DOMAINS, MAILING_LIST_MULTI,RCVD_IN_DNSWL_NONE,RCVD_IN_MSPIKE_H4, RCVD_IN_MSPIKE_WL,SPF_HELO_NONE,T_SCC_BODY_TEXT_LINE autolearn=unavailable autolearn_force=no version=3.4.4 X-MC-Unique: KSGgfiPnPzqPgkwO27vNQQ-1 From: Andrea Bolognani To: devel@lists.libvirt.org Subject: [PATCH 5/9] docs: Fix a few weird :since: tags Date: Tue, 20 Feb 2024 10:41:31 +0100 Message-ID: <20240220094135.359112-6-abologna@redhat.com> In-Reply-To: <20240220094135.359112-1-abologna@redhat.com> References: <20240220094135.359112-1-abologna@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.4.1 on 10.11.54.5 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Message-ID-Hash: QURQSO5WRBFGPNUP27NLORPGD6AA7D75 X-Message-ID-Hash: QURQSO5WRBFGPNUP27NLORPGD6AA7D75 X-MailFrom: abologna@redhat.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: Content-Type: text/plain; charset="utf-8"; x-default="true" Content-Transfer-Encoding: quoted-printable X-ZM-MESSAGEID: 1708422841951100001 These either mention libvirt explicitly, which is something that we generally don't do, or lack the word "since", which makes the resulting HTML awkward. Signed-off-by: Andrea Bolognani --- docs/formatdomain.rst | 38 ++++++++++++++++++-------------------- 1 file changed, 18 insertions(+), 20 deletions(-) diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst index f56f40d5cc..10aa0bcebe 100644 --- a/docs/formatdomain.rst +++ b/docs/formatdomain.rst @@ -2962,7 +2962,7 @@ paravirtualized driver is specified via the ``disk`` = element. the client of a networked storage protocol. Supported for 'rbd' :since:`since 1.2.11 (QEMU only).` ``auth`` - :since:`Since libvirt 3.9.0` , the ``auth`` element is supported for= a + :since:`Since 3.9.0`, the ``auth`` element is supported for a disk ``type`` "network" that is using a ``source`` element with the ``protocol`` attributes "rbd", "iscsi", or "ssh". If present, the ``auth`` element provides the authentication credentials needed to a= ccess @@ -2978,14 +2978,14 @@ paravirtualized driver is specified via the ``disk`= ` element. ``usage`` attribute matching the key that was specified in the secret object. ``encryption`` - :since:`Since libvirt 3.9.0` , the ``encryption`` can be a sub-eleme= nt of + :since:`Since 3.9.0`, the ``encryption`` can be a sub-element of the ``source`` element for encrypted storage sources. If present, specifies how the storage source is encrypted See the `Storage Encryption `__ page for more informati= on. Note that the 'qcow' format of encryption is broken and thus is no l= onger - supported for use with disk images. ( :since:`Since libvirt 4.5.0` ) + supported for use with disk images. ( :since:`Since 4.5.0` ) ``reservations`` - :since:`Since libvirt 4.4.0` , the ``reservations`` can be a sub-ele= ment + :since:`Since 4.4.0`, the ``reservations`` can be a sub-element of the ``source`` element for storage sources (QEMU driver only). If present it enables persistent reservations for SCSI based disks. The element has one mandatory attribute ``managed`` with accepted values @@ -2998,7 +2998,7 @@ paravirtualized driver is specified via the ``disk`` = element. specifying the role of hypervisor. It's recommended to allow libvirt manage the persistent reservations. ``initiator`` - :since:`Since libvirt 4.7.0` , the ``initiator`` element is supporte= d for + :since:`Since 4.7.0`, the ``initiator`` element is supported for a disk ``type`` "network" that is using a ``source`` element with the ``protocol`` attribute "iscsi". If present, the ``initiator`` element provides the initiator IQN needed to access the source via mandatory @@ -3430,7 +3430,7 @@ paravirtualized driver is specified via the ``disk`` = element. together with general boot elements in `BIOS bootloader`_ section. :since:`Since 0.8.8` ``encryption`` - Starting with :since:`libvirt 3.9.0` the ``encryption`` element is pref= erred + since:`Since 3.9.0` the ``encryption`` element is preferred to be a sub-element of the ``source`` element. If present, specifies ho= w the volume is encrypted using "qcow". See the `Storage Encryption `__ page for more information. @@ -3487,20 +3487,20 @@ paravirtualized driver is specified via the ``disk`= ` element. The ``type`` attribute is mandatory, and is typically "pci" or "drive".= For a "pci" controller, additional attributes for ``bus``, ``slot``, and ``function`` must be present, as well as optional ``domain`` and - ``multifunction``. Multifunction defaults to 'off'; any other value req= uires - QEMU 0.1.3 and :since:`libvirt 0.9.7` . For a "drive" controller, addit= ional - attributes ``controller``, ``bus``, ``target`` ( :since:`libvirt 0.9.11= ` ), - and ``unit`` are available, each defaulting to 0. + ``multifunction`` (:since:`since 0.9.7`). Multifunction defaults to 'of= f'. + For a "drive" controller, additional attributes ``controller``, ``bus``, + ``target`` (:since:`since 0.9.11`), and ``unit`` are available, each + defaulting to 0. ``auth`` - Starting with :since:`libvirt 3.9.0` the ``auth`` element is preferred = to be + :since:`Since 3.9.0`, the ``auth`` element is preferred to be a sub-element of the ``source`` element. The element is still read and managed as a ``disk`` sub-element. It is invalid to use ``auth`` as bot= h a - sub-element of ``disk`` and ``source``. The ``auth`` element was introd= uced - as a ``disk`` sub-element in :since:`libvirt 0.9.7.` + sub-element of ``disk`` and ``source``. + :since:`Since 0.9.7` ``geometry`` The optional ``geometry`` element provides the ability to override geom= etry settings. This mostly useful for S390 DASD-disks or older DOS-disks. - :since:`0.10.0` + :since:`Since 0.10.0` =20 ``cyls`` The ``cyls`` attribute is the number of cylinders. @@ -4572,10 +4572,8 @@ or: ``shareable`` If present, this indicates the device is expected to be shared between domains (assuming the hypervisor and OS support this). Only supported b= y SCSI - host device. :since:`Since 1.0.6` - - Note: Although ``shareable`` was introduced :since:`in 1.0.6` , it did = not - work as as expected until :since:`1.2.2` . + host device. :since:`Since 1.0.6`, but only works as expected + :since:`since 1.2.2`. =20 Block / character devices ^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -6460,8 +6458,8 @@ interaction with the admin. has better performance). Since this display type doesn't provide any window or graphical console like the other types, for practical reas= ons it should be paired with either ``vnc`` or ``spice`` graphics types. Th= is - display type is only supported by QEMU domains (needs QEMU :since:`2= .10` - or newer). :since:`5.0.0` this element accepts a ```` sub-eleme= nt + display type is only supported by QEMU domains (needs QEMU 2.10 or + newer). :since:`Since 5.0.0` this element accepts a ```` sub-el= ement with an optional attribute ``rendernode`` which can be used to speci= fy an absolute path to a host's DRI device to be used for OpenGL rendering. =20 --=20 2.43.2 _______________________________________________ Devel mailing list -- devel@lists.libvirt.org To unsubscribe send an email to devel-leave@lists.libvirt.org