From nobody Sun Feb 8 22:49:31 2026 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) client-ip=170.10.133.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.133.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=1654009728; cv=none; d=zohomail.com; s=zohoarc; b=kaw4/zEjS9wei5HOHuMBeJj1yIPHdFDTCLHARiR2G0t/mMiupux+2Jw3+vXDZenXHQhJktrSqneWgulSYJwPe3HcXxa301Fno+r+dhNdygsd2acd7zS6zqw3zVikxpDOgUuyJCdqyi0I4pf5nEnXDrG3dJ2sblwZyjOU9dZTAyY= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1654009728; h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=sHfqTePQqetRXFrWOVXptDrlNrxWErMjnPLmgZZXxwI=; b=cVxB8ORzfbcLZa4mGB2fVMF59C17UGUDziFKdUr7FadEMYWAcgxHcxAOg1NsMksmyPdZEg7R436/NuDnRmxN9PPYL+/sjnkHNbYEutb7Q3z9fsQCNe3U7nLlh1kQ4Dq/8pG5ht9lVrpKYJpRWufi/OOWT2BzQDgo5eqR3WP3Pxc= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.133.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.133.124]) by mx.zohomail.com with SMTPS id 1654009728723231.6492954725819; Tue, 31 May 2022 08:08:48 -0700 (PDT) Received: from mimecast-mx02.redhat.com (mx3-rdu2.redhat.com [66.187.233.73]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-88-Lfom0EmnO8KwWdrPuUpZtw-1; Tue, 31 May 2022 11:08:31 -0400 Received: from smtp.corp.redhat.com (int-mx09.intmail.prod.int.rdu2.redhat.com [10.11.54.9]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 3917A3C60551; Tue, 31 May 2022 15:07:04 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (unknown [10.30.29.100]) by smtp.corp.redhat.com (Postfix) with ESMTP id E0369492C3B; Tue, 31 May 2022 15:07:03 +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 7526C19451EF; Tue, 31 May 2022 15:07:03 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.rdu2.redhat.com [10.11.54.5]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id D40EF194705C for ; Tue, 31 May 2022 15:07:01 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id C459D5F245; Tue, 31 May 2022 15:07:01 +0000 (UTC) Received: from speedmetal.lan (unknown [10.40.208.21]) by smtp.corp.redhat.com (Postfix) with ESMTP id 471141131A for ; Tue, 31 May 2022 15:07:01 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1654009727; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=sHfqTePQqetRXFrWOVXptDrlNrxWErMjnPLmgZZXxwI=; b=bghoVM9f2Xor4KCTXMXYDdfTbIWMCGy0S45Zs/LwKJLryIWBamCIuds4kSwQWzRadHDMN0 ZNd0FiozBIsx715vJS99i+7NBLV0CwK7m4V3AkXK7dF5gd4xjzL/ICEWKvjshHy/9SMdrv 8oM3ktlNIsaWw9qKYlxB9poEqzUe0FM= X-MC-Unique: Lfom0EmnO8KwWdrPuUpZtw-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Peter Krempa To: libvir-list@redhat.com Subject: [PATCH 21/67] docs: formatdomain: Remove 'elementsAddress' anchor Date: Tue, 31 May 2022 17:05:56 +0200 Message-Id: <024d4e6e0a30a105f4aab3f58ba01ed9ac6b2720.1654008136.git.pkrempa@redhat.com> In-Reply-To: References: MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.11.54.5 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: , Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" X-Scanned-By: MIMEDefang 2.85 on 10.11.54.9 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=libvir-list-bounces@redhat.com 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: 1654009729544100008 Content-Type: text/plain; charset="utf-8" All local links were reformulated to make sense with local references. Signed-off-by: Peter Krempa --- docs/formatdomain.rst | 28 +++++++++++++--------------- 1 file changed, 13 insertions(+), 15 deletions(-) diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst index d1134c523f..9d3960e7ad 100644 --- a/docs/formatdomain.rst +++ b/docs/formatdomain.rst @@ -3473,7 +3473,6 @@ A directory on the host that can be accessed directly= from the guest. permitted to exceed its soft limits for a grace period of time. Afterwa= rds the hard limit is enforced. :since:`Since 0.9.13` -:anchor:`` Device Addresses ~~~~~~~~~~~~~~~~ @@ -3715,7 +3714,7 @@ Note: The PowerPC64 "spapr-vio" addresses do not have= an associated controller. For controllers that are themselves devices on a PCI or USB bus, an option= al sub-element ``
`` can specify the exact relationship of the contro= ller -to its master bus, with semantics `given above <#elementsAddress>`__. +to its master bus, with semantics described in the `Device Addresses`_ sec= tion. An optional sub-element ``driver`` can specify the driver specific options: @@ -4255,7 +4254,7 @@ or: the address type used must conform to the ``model`` attribute of element ``hostdev``, e.g. any address type other than PCI for ``vfio-pci`` devi= ce API or any address type other than CCW for ``vfio-ccw`` device API will res= ult in - an error. `See above <#elementsAddress>`__ for more details on the addr= ess + an error. See the `Device Addresses`_ section for more details on the a= ddress element. ``driver`` PCI devices can have an optional ``driver`` subelement that specifies w= hich @@ -4445,10 +4444,9 @@ behaves like a physical USB CCID (Chip/Smart Card In= terface Device) card. of the character device is the hypervisor itself, rather than a device visible in the guest). -Each mode supports an optional sub-element ``
``, which fine-tunes= the -correlation between the smartcard and a ccid bus controller, `documented -above <#elementsAddress>`__. For now, qemu only supports at most one smart= card, -with an address of bus=3D0 slot=3D0. +Each mode supports an optional sub-element ``
`` (See `Device Addr= esses`_), +which fine-tunes the correlation between the smartcard and a ccid bus cont= roller. +For now, qemu only supports at most one smartcard, with an address of bus= =3D0 slot=3D0. :anchor:`` @@ -4484,7 +4482,7 @@ the host. Each ```` element has an optional ``
`` sub-element tha= t can tie the interface to a particular pci slot, with attribute ``type=3D'pci'`= ` as -`documented above <#elementsAddress>`__. +documented in the `Device Addresses`_ section. :since:`Since 6.6.0` , one can force libvirt to keep the provided MAC addr= ess when it's in the reserved VMware range by adding a ``type=3D"static"`` att= ribute @@ -5808,7 +5806,7 @@ to provide a graphics tablet for absolute cursor move= ment. :since:`since 1.3.0` ) "virtio". The ``input`` element has an optional sub-element ``
`` which can = tie -the device to a particular PCI slot, `documented above <#elementsAddress>`= __. +the device to a particular PCI slot, documented in the `Device Addresses`_= section. On S390, ``address`` can be used to provide a CCW address for an input dev= ice ( :since:`since 4.2.0` ). For types ``passthrough`` and ``evdev``, the manda= tory sub-element ``source`` must have an ``evdev`` (for ``passthrough``) or ``d= ev`` @@ -5848,9 +5846,9 @@ ports available to connect devices to a host system. The ``hub`` element has one mandatory attribute, the ``type`` whose val= ue can only be 'usb'. -The ``hub`` element has an optional sub-element ``
`` with -``type=3D'usb'``\ which can tie the device to a particular controller, `do= cumented -above <#elementsAddress>`__. +The ``hub`` element has an optional sub-element ``
`` +(See `Device Addresses`_) ``type=3D'usb'`` which can tie the device to a +particular controller. :anchor:`` @@ -6419,7 +6417,7 @@ If any of the attributes is not specified by the user= , libvirt will choose a value suitable for most users. Most target types support configuring the guest-visible device address as -`documented above <#elementsAddress>`__; more specifically, acceptable add= ress +documented in the `Device Addresses`_ section; more specifically, acceptab= le address types are ``isa`` (for ``isa-serial``), ``usb`` (for ``usb-serial``), ``pc= i`` (for ``pci-serial``) and ``spapr-vio`` (for ``spapr-vio-serial``). The ``system-serial`` and ``sclp-serial`` target types don't support specifyin= g an @@ -6598,7 +6596,7 @@ types have different ``target`` attributes. /dev/virtio-ports/$name (for more info, please see https://fedoraproject.org/wiki/Features/VirtioSerial). The optional ele= ment ``address`` can tie the channel to a particular ``type=3D'virtio-serial= '`` - controller, `documented above <#elementsAddress>`__. With qemu, if ``na= me`` + controller, as documented in the `Device Addresses`_ section. With qemu= , if ``name`` is "org.qemu.guest_agent.0", then libvirt can interact with a guest age= nt installed in the guest, for actions such as guest shutdown or file syst= em quiescing. :since:`Since 0.7.7, guest agent interaction since 0.9.10` @@ -6985,7 +6983,7 @@ Valid values are: ... Each ``sound`` element has an optional sub-element ``
`` which can= tie -the device to a particular PCI slot, `documented above <#elementsAddress>`= __. +the device to a particular PCI slot. See `Device Addresses`_. A sound device could be optionally mapped to the specific host audio backend using the ``