[PATCH 15/15] docs: formatdomain: Remove old unreferenced HTML anchors

Most of the anchors that were forward ported to formatdomain.rst when it was converted are not actually referenced by our documentation. Since it's now quite some time after the conversion was done we can remove them. Signed-off-by: Peter Krempa <pkrempa(a)redhat.com&gt; --- docs/formatdomain.rst | 112 ------------------------------------------ 1 file changed, 112 deletions(-) diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst index 6c4096713a..9be305f3e6 100644 --- a/docs/formatdomain.rst +++ b/docs/formatdomain.rst @@ -285,8 +285,6 @@ them in production. case the boot fails (according to BIOS). The value is in milliseconds with maximum of ``65535`` and special value ``-1`` disables the reboot. -:anchor:`<a id="elementsOSBootloader"/>` - Host bootloader ~~~~~~~~~~~~~~~ @@ -312,8 +310,6 @@ also uses a host bootloader, either ``bhyveload`` or ``grub-bhyve``. The optional ``bootloader_args`` element allows command line arguments to be passed to the bootloader. :since:`Since 0.2.3` -:anchor:`<a id="elementsOSKernel"/>` - Direct kernel boot ~~~~~~~~~~~~~~~~~~ @@ -1226,8 +1222,6 @@ Block I/O Tuning ``write_iops_sec`` Write I/O operations per second limit. :since:`Since 1.2.2` -:anchor:`<a id="resPartition"/>` - Resource partitioning --------------------- @@ -1811,8 +1805,6 @@ manager will take its default action. ``ignore`` Keep the domain running as if nothing happened. -:anchor:`<a id="elementsPowerManagement"/>` - Power Management ---------------- @@ -2129,8 +2121,6 @@ are: tb-cache The size of translation block cache size an integer (a multiple of MiB) :since:`8.0.0` =========== ============================================== =================================================== ============== -:anchor:`<a id="elementsTime"/>` - Time keeping ------------ @@ -2251,8 +2241,6 @@ Windows, however, expects it to be in so called 'localtime'. The ``present`` attribute can be "yes" or "no" to specify whether a particular timer is available to the guest. -:anchor:`<a id="elementsPerf"/>` - Performance monitoring events ----------------------------- @@ -3306,8 +3294,6 @@ paravirtualized driver is specified via the ``disk`` element. disk's hardware sector size which can be relevant for the alignment of disk data. -:anchor:`<a id="elementsFilesystems"/>` - Filesystems ~~~~~~~~~~~ @@ -3978,8 +3964,6 @@ pcie-root-port. ( :since:`since 1.2.19` ) </devices> ... -:anchor:`<a id="elementsLease"/>` - Device leases ~~~~~~~~~~~~~ @@ -4019,8 +4003,6 @@ acquired. Host device assignment ~~~~~~~~~~~~~~~~~~~~~~ -:anchor:`<a id="elementsHostDevSubsys"/>` - USB / PCI / SCSI devices ^^^^^^^^^^^^^^^^^^^^^^^^ @@ -4313,8 +4295,6 @@ or: Note: Although ``shareable`` was introduced :since:`in 1.0.6` , it did not work as as expected until :since:`1.2.2` . -:anchor:`<a id="elementsHostDevCaps"/>` - Block / character devices ^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -4365,8 +4345,6 @@ after 1.0.1 for LXC` : used. For network interfaces, the name of the interface is provided in the "interface" element. -:anchor:`<a id="elementsRedir"/>` - Redirected devices ~~~~~~~~~~~~~~~~~~ @@ -4417,8 +4395,6 @@ after 0.9.5 (KVM only)` : ``-1`` can be used to allow any value for them. ``allow`` attribute is mandatory, 'yes' means allow, 'no' for deny. -:anchor:`<a id="elementsSmartcard"/>` - Smartcard devices ~~~~~~~~~~~~~~~~~ @@ -4536,8 +4512,6 @@ to provide network interface device naming, that is stable across changes in PCI addresses assigned to the device. This value is required to be unique across all devices and be between 1 and (16*1024-1). -:anchor:`<a id="elementsNICSVirtual"/>` - Virtual network ^^^^^^^^^^^^^^^ @@ -4622,8 +4596,6 @@ virtualport, connection of the interface will fail. </devices> ... -:anchor:`<a id="elementsNICSBridge"/>` - Bridge to LAN ^^^^^^^^^^^^^ @@ -4704,8 +4676,6 @@ to the interface. </devices> ... -:anchor:`<a id="elementsNICSSlirp"/>` - Userspace SLIRP stack ^^^^^^^^^^^^^^^^^^^^^ @@ -4734,8 +4704,6 @@ to add an IPv6 address to the interface. ``address``. Optionally, address </devices> ... -:anchor:`<a id="elementsNICSEthernet"/>` - Generic ethernet connection ^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -4903,8 +4871,6 @@ should be provided by the network administrator. :since:`Since 0.8.2` </devices> ... -:anchor:`<a id="elementsNICSHostdev"/>` - PCI Passthrough ^^^^^^^^^^^^^^^ @@ -4962,8 +4928,6 @@ or stopping the guest. </devices> ... -:anchor:`<a id="elementsNICSVDPA"/>` - vDPA devices ^^^^^^^^^^^^ @@ -4986,8 +4950,6 @@ requires QEMU 5.1.0 or newer)` </devices> ... -:anchor:`<a id="elementsTeaming"/>` - Teaming a virtio/hostdev NIC pair ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -5116,8 +5078,6 @@ management software must properly modify the interface XML during migration so that the virtio device remains connected to the same network segment before and after migration. -:anchor:`<a id="elementsNICSMulticast"/>` - Multicast tunnel ^^^^^^^^^^^^^^^^ @@ -5141,8 +5101,6 @@ must be from the multicast address block. </devices> ... -:anchor:`<a id="elementsNICSTCP"/>` - TCP tunnel ^^^^^^^^^^ @@ -5170,8 +5128,6 @@ appropriate routing. </devices> ... -:anchor:`<a id="elementsNICSUDP"/>` - UDP unicast tunnel ^^^^^^^^^^^^^^^^^^ @@ -5195,8 +5151,6 @@ which the UDP socket packets will originate from the QEMU host. :since:`Since </devices> ... -:anchor:`<a id="elementsNICSModel"/>` - Setting the NIC model ^^^^^^^^^^^^^^^^^^^^^ @@ -5230,8 +5184,6 @@ ne2k_pci pcnet rtl8139 e1000 virtio. :since:`Since 5.2.0` , See `Virtio transitional devices <#elementsVirtioTransitional>`__ for more details. -:anchor:`<a id="elementsDriverBackendOptions"/>` - Setting NIC driver-specific options ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -5376,8 +5328,6 @@ sub-elements: options. By default, the supported offloads are enabled by QEMU. :since:`Since 1.2.9 (QEMU only)` -:anchor:`<a id="elementsBackendOptions"/>` - Setting network backend-specific options ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -5444,8 +5394,6 @@ the ``guest`` element should be used, as in the following snippet: </devices> ... -:anchor:`<a id="elementsNICSBoot"/>` - Specifying boot order ^^^^^^^^^^^^^^^^^^^^^ @@ -5467,8 +5415,6 @@ be tried during boot sequence. The per-device ``boot`` elements cannot be used together with general boot elements in `BIOS bootloader <#elementsOSBIOS>`__ section. :since:`Since 0.8.8` -:anchor:`<a id="elementsNICSROM"/>` - Interface ROM BIOS configuration ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -5495,8 +5441,6 @@ used to point to a binary file to be presented to the guest as the device's ROM BIOS. This can be useful to provide an alternative boot ROM for a network device. :since:`Since 0.9.10 (QEMU and KVM only)` . -:anchor:`<a id="elementDomain"/>` - Setting up a network backend in a driver domain ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -5630,8 +5574,6 @@ each other; if there is a guest on the same bridge that doesn't have ``isolated='yes'``, even the isolated guests will be able to communicate with it.) -:anchor:`<a id="elementLink"/>` - Modifying virtual link state ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -5701,8 +5643,6 @@ one attribute, ``max``, to tweak, in element ``frames`` for the ``rx`` group, which accepts a non-negative integer that specifies the maximum number of packets that will be received before an interrupt. :since:`Since 3.3.0` -:anchor:`<a id="ipconfig"/>` - IP configuration ^^^^^^^^^^^^^^^^ @@ -5812,8 +5752,6 @@ connection is lost. It has two attributes ``enabled`` (which accepts ``yes`` and ``no``) and ``timeout`` which specifies the amount of seconds after which hypervisor tries to reconnect. -:anchor:`<a id="elementNwfilter"/>` - Traffic filtering with NWFilter ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -5848,8 +5786,6 @@ nwfilter via the ``name`` and ``value`` attributes. See the `nwfilter <formatnwfilter.html#usage-of-variables-in-filters>`__ docs for info on parameters. -:anchor:`<a id="elementsInput"/>` - Input devices ~~~~~~~~~~~~~ @@ -5908,8 +5844,6 @@ The subelement ``driver`` can be used to tune the virtio options of the device: `Virtio-specific options <#elementsVirtio>`__ can also be set. ( :since:`Since 3.5.0` ) -:anchor:`<a id="elementsHub"/>` - Hub devices ~~~~~~~~~~~ @@ -6379,15 +6313,11 @@ are "yes" and "no" and ``timeout`` which is in seconds. The ``reconnect`` attribute is valid only for ``connect`` mode. :since:`Since 3.7.0 (QEMU driver only)` . -:anchor:`<a id="elementsCharGuestInterface"/>` - Guest interface ^^^^^^^^^^^^^^^ A character device presents itself to the guest as one of the following types. -:anchor:`<a id="elementCharParallel"/>` - Parallel port ''''''''''''' @@ -6479,8 +6409,6 @@ address. For the relationship between serial ports and consoles, `see below <#elementCharSerialAndConsole>`__. -:anchor:`<a id="elementCharConsole"/>` - Console ''''''' @@ -6609,8 +6537,6 @@ following configurations: will be treated the same and will result in a single emulated serial console being available to the guest. -:anchor:`<a id="elementCharChannel"/>` - Channel ''''''' @@ -6690,8 +6616,6 @@ Host interface A character device presents itself to the host as one of the following types. -:anchor:`<a id="elementsCharSTDIO"/>` - Domain logfile '''''''''''''' @@ -6708,8 +6632,6 @@ virtual machine's logfile </devices> ... -:anchor:`<a id="elementsCharFle"/>` - Device logfile '''''''''''''' @@ -6727,8 +6649,6 @@ file. </devices> ... -:anchor:`<a id="elementsCharVC"/>` - Virtual console ''''''''''''''' @@ -6745,8 +6665,6 @@ This is typically accessed via a special hotkey sequence such as "ctrl+alt+3" </devices> ... -:anchor:`<a id="elementsCharNull"/>` - Null device ''''''''''' @@ -6763,8 +6681,6 @@ input. All data written is discarded. </devices> ... -:anchor:`<a id="elementsCharPTY"/>` - Pseudo TTY '''''''''' @@ -6807,8 +6723,6 @@ port. </devices> ... -:anchor:`<a id="elementsCharPipe"/>` - Named pipe '''''''''' @@ -6825,8 +6739,6 @@ The character device writes output to a named pipe. See pipe(7) for more info. </devices> ... -:anchor:`<a id="elementsCharTCP"/>` - TCP client/server ''''''''''''''''' @@ -6907,8 +6819,6 @@ to use the host TLS environment if either the ``chardev_tls_x509_cert_dir`` or </devices> ... -:anchor:`<a id="elementsCharUDP"/>` - UDP network console ''''''''''''''''''' @@ -6927,8 +6837,6 @@ packets. This is a lossy service. </devices> ... -:anchor:`<a id="elementsCharUNIX"/>` - UNIX domain socket client/server '''''''''''''''''''''''''''''''' @@ -6946,8 +6854,6 @@ from local clients. </devices> ... -:anchor:`<a id="elementsCharSpiceport"/>` - Spice channel ''''''''''''' @@ -6968,8 +6874,6 @@ domains with or without `spice graphics <#elementsGraphics>`__. </devices> ... -:anchor:`<a id="elementsNmdm"/>` - Nmdm device ''''''''''' @@ -6995,8 +6899,6 @@ The ``source`` element has these attributes: Slave device of the pair, that is passed to the clients for connection to the guest console. Device is specified by a fully qualified path. -:anchor:`<a id="elementsSound"/>` - Sound devices ~~~~~~~~~~~~~ @@ -7391,8 +7293,6 @@ defaults to 'WAV' with QEMU. :since:`Since 7.2.0, qemu` -:anchor:`<a id="elementsWatchdog"/>` - Watchdog device ~~~~~~~~~~~~~~~ @@ -7455,8 +7355,6 @@ feature is planned for a future version of libvirt. Note 2: the directory to save dump files can be configured by ``auto_dump_path`` in file /etc/libvirt/qemu.conf. -:anchor:`<a id="elementsMemBalloon"/>` - Memory balloon device ~~~~~~~~~~~~~~~~~~~~~ @@ -7533,8 +7431,6 @@ Example: manually added device with static PCI slot 2 requested For model ``virtio`` memballoon, `Virtio-specific options <#elementsVirtio>`__ can also be set. ( :since:`Since 3.5.0` ) -:anchor:`<a id="elementsRng"/>` - Random number generator device ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -7729,8 +7625,6 @@ Example: usage of the TPM Emulator encrypted. The ``secret`` must reference a secret object that holds the passphrase from which the encryption key will be derived. -:anchor:`<a id="elementsNVRAM"/>` - NVRAM device ~~~~~~~~~~~~ @@ -7756,8 +7650,6 @@ Example: usage of NVRAM configuration ``reg`` Device address -:anchor:`<a id="elementsPanic"/>` - panic device ~~~~~~~~~~~~ @@ -7801,8 +7693,6 @@ Example: usage of panic configuration specify an address, and doing so is forbidden altogether for s390, pseries and hyperv models. -:anchor:`<a id="elementsShmem"/>` - Shared memory device ~~~~~~~~~~~~~~~~~~~~ @@ -8364,8 +8254,6 @@ spec <https://support.amd.com/TechDocs/55766_SEV-KM_API_Specification.pdf>`__ session blob defined in the SEV API spec. See SEV spec LAUNCH_START section for the session blob format. -:anchor:`<a id="examples"/>` - Example configs =============== -- 2.35.1