From nobody Sun Feb 8 22:49:35 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=1654009687; cv=none; d=zohomail.com; s=zohoarc; b=P3EJH/MNPenewjLY4T/YObKpZO5MlrgiVrJb9ioOkkUQHGqeqxZlbiDHTsx69Ifbw8xKYOHCahgihZZlzD12+1jbROGjbO+1/KhU8Ix4ro5WhwI1Q9mo0CwecIihJD4JYCQaxoCECpOYZ1cTXcEUxCMyF+yrg7yCAcJHO9wjukY= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1654009687; 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=6VcHACP+Jz2by/iz7FKqwwcEQcQCri6SjG0EzQcvvjw=; b=gS+qDLqr5xg/xyEAEZF3K9dyX3OQJjECPmMJukSEahsd0LsHS93VApVMXtwGfA9GkOXvTYWaESNYTXk8/9fJKhTomUhnLHEIl49HIY7ltocD4eIs2efCjjbsPP5AfVbuUW5hiWG65Jyaoex51ywyHsNH9a+PcYcZLywFS6oHkCU= 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 1654009687955301.3452787496673; Tue, 31 May 2022 08:08:07 -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-424-OB518HlUPx-CjIwuv4FM7Q-1; Tue, 31 May 2022 11:07:42 -0400 Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.rdu2.redhat.com [10.11.54.5]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id E536180C8FF; Tue, 31 May 2022 15:06:55 +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 CE13C1731B; Tue, 31 May 2022 15:06:55 +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 554F6194706C; Tue, 31 May 2022 15:06:55 +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 8050419451F1 for ; Tue, 31 May 2022 15:06:53 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id 70FCA1731B; Tue, 31 May 2022 15:06:53 +0000 (UTC) Received: from speedmetal.lan (unknown [10.40.208.21]) by smtp.corp.redhat.com (Postfix) with ESMTP id EF48C82886 for ; Tue, 31 May 2022 15:06:52 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1654009686; 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=6VcHACP+Jz2by/iz7FKqwwcEQcQCri6SjG0EzQcvvjw=; b=Wo+ZXnAE3w3czFjAmCP5ZltUFoDJGk6SIXJ59BhLRYLuvjDQK2ZdQev0g/qZAyvi1gKFWH fKIkctis874Ltdl6a4N18fPkcTrtWaV6rkqDYlit17J3uV1U31IYd+OjiHLr3OmeAJEdUc 1kVQADxHXQrrFmh0oEZeMjKzKpv+DyY= X-MC-Unique: OB518HlUPx-CjIwuv4FM7Q-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Peter Krempa To: libvir-list@redhat.com Subject: [PATCH 11/67] docs: formatdomain: Remove 'elementsMemoryBacking' anchor Date: Tue, 31 May 2022 17:05:46 +0200 Message-Id: <6531bc8ab8bf8ab58657abbe7dd769044fa38cdb.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.79 on 10.11.54.5 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: 1654009689366100001 Content-Type: text/plain; charset="utf-8" Reworded documentation around one of the local links. Signed-off-by: Peter Krempa --- docs/formatdomain.rst | 16 +++++++--------- docs/kbase/kvm-realtime.rst | 2 +- 2 files changed, 8 insertions(+), 10 deletions(-) diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst index 8e18151796..fbebff8650 100644 --- a/docs/formatdomain.rst +++ b/docs/formatdomain.rst @@ -970,7 +970,6 @@ Memory Allocation fly. If this is omitted, it defaults to the same value as the ``memory`` element. The ``unit`` attribute behaves the same as for ``memory``. -:anchor:`` Memory Backing -------------- @@ -1083,7 +1082,7 @@ Memory Tuning killed by the kernel if the guess is too low, and determining the memory needed for a process to run is an `undecidable problem `__; that sa= id, if - you already set ``locked`` in `memory backing <#elementsMemoryBacking>`= __ + you already set ``locked`` in `Memory Backing`_ because your workload demands it, you'll have to take into account the specifics of your deployment and figure out a value for ``hard_limit`` = that is large enough to support the memory requirements of your guest, but s= mall @@ -1573,8 +1572,8 @@ in unwanted behaviour. :since:`Since 1.2.9` the optio= nal attribute ``memAccess`` can control whether the memory is to be mapped as "shared" or "private". T= his is valid only for hugepages-backed memory and nvdimm modules. Each ``cell`` e= lement can have an optional ``discard`` attribute which fine tunes the discard fe= ature -for given numa node as described under `Memory -Backing <#elementsMemoryBacking>`__. Accepted values are ``yes`` and ``no`= `. +for given numa node as described under `Memory Backing`_. +Accepted values are ``yes`` and ``no``. :since:`Since 4.4.0` This guest NUMA specification is currently available only for QEMU/KVM and= Xen. @@ -2715,7 +2714,7 @@ paravirtualized driver is specified via the ``disk`` = element. ``vhostuser`` Enables the hypervisor to connect to another process using vhost-user protocol. Requires shared memory configured for the VM, for more det= ails - see ``access`` mode for `memoryBacking <#elementsMemoryBacking>`__ e= lement. + see ``access`` mode for ``memoryBacking`` element (See `Memory Backi= ng`_). The ``source`` element has following mandatory attributes: @@ -7907,7 +7906,7 @@ Example: usage of the memory devices ``access`` An optional attribute ``access`` ( :since:`since 3.2.0` ) that provides capability to fine tune mapping of the memory on per module basis. Valu= es are - the same as `Memory Backing <#elementsMemoryBacking>`__: ``shared`` and + the same as `Memory Backing`_: ``shared`` and ``private``. For ``nvdimm`` model, if using real NVDIMM DAX device as backend, ``shared`` is required. For ``virtio-pmem`` model ``shared`` is required. @@ -7915,9 +7914,8 @@ Example: usage of the memory devices ``discard`` An optional attribute ``discard`` ( :since:`since 4.4.0` ) that provides capability to fine tune discard of data on per module basis. Accepted v= alues - are ``yes`` and ``no``. The feature is described here: `Memory - Backing <#elementsMemoryBacking>`__. This attribute is allowed only for - ``model=3D'dimm'``. + are ``yes`` and ``no``. The feature is described here: `Memory Backing`= _. + This attribute is allowed only for ``model=3D'dimm'``. ``uuid`` For pSeries guests, an uuid can be set to identify the nvdimm module. If diff --git a/docs/kbase/kvm-realtime.rst b/docs/kbase/kvm-realtime.rst index 288295b4c7..9b38aff0fd 100644 --- a/docs/kbase/kvm-realtime.rst +++ b/docs/kbase/kvm-realtime.rst @@ -178,7 +178,7 @@ Memory configuration The host memory used for guest RAM needs to be allocated from huge pages o= n the second NUMA node, and all other memory allocation needs to be locked into = RAM with memory page sharing disabled. -This is achieved by using the `memory backing config `_: +This is achieved by using the `memory backing config `_: :: --=20 2.35.3