[libvirt] [PATCH 6/7] docs: formatdomain: remove "Since" references older than 1.1.1
Peter Krempa
pkrempa at redhat.com
Wed Jul 17 15:38:31 UTC 2019
On Wed, Jul 17, 2019 at 15:41:47 +0200, Ján Tomko wrote:
> Libvirt 1.1.1 was released 6 years ago. This was the version that
> ended up in RHEL 7.0. It is unlikely that the reader will need to
> consider libvirt versions beyond that. Remove the since markers
> for older versions to de-clutter the documentation a bit.
>
> Signed-off-by: Ján Tomko <jtomko at redhat.com>
> ---
> docs/formatdomain.html.in | 334 +++++++++++++-------------------------
> 1 file changed, 112 insertions(+), 222 deletions(-)
>
> diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
> index 1d57729394..a32568d05c 100644
> --- a/docs/formatdomain.html.in
> +++ b/docs/formatdomain.html.in
In all the hunks which I did not trim below the "since" tag include also
information that e.g ...
> @@ -649,7 +639,6 @@
> specified or if <code>placement</code> is "static", but no
> <code>cpuset</code> is specified, the domain process will be
> pinned to all the available physical CPUs.
> - <span class="since">Since 0.9.11 (QEMU and KVM only)</span>
... it's supported with qemu only which probably should not be removed.
> </dd>
> </dl>
> </dd>
> @@ -858,8 +844,6 @@
> the domain will not be allowed to consume more than <code>quota</code>
> worth of runtime. The value should be in range [1000, 1000000]. A period
> with value 0 means no value.
> - <span class="since">Only QEMU driver support since 0.9.4, LXC since
> - 0.9.10</span>
> </dd>
> <dt><code>quota</code></dt>
> <dd>
> @@ -870,8 +854,6 @@
> should be in range [1000, 18446744073709551] or less than 0. A quota
> with value 0 means no value. You can use this feature to ensure that all
> vCPUs run at the same speed.
> - <span class="since">Only QEMU driver support since 0.9.4, LXC since
> - 0.9.10</span>
> </dd>
> <dt><code>global_period</code></dt>
> <dd>
> @@ -901,7 +883,6 @@
> threads (those excluding vCPUs) of the domain will not be allowed to consume
> more than <code>emulator_quota</code> worth of runtime. The value should be
> in range [1000, 1000000]. A period with value 0 means no value.
> - <span class="since">Only QEMU driver support since 0.10.0</span>
> </dd>
> <dt><code>emulator_quota</code></dt>
> <dd>
> @@ -912,7 +893,6 @@
> (those excluding vCPUs), which means that it is not bandwidth controlled.
> The value should be in range [1000, 18446744073709551] or less than 0. A
> quota with value 0 means no value.
> - <span class="since">Only QEMU driver support since 0.10.0</span>
> </dd>
>
> @@ -2078,9 +2048,9 @@
> </dd>
> <dt><code>apic</code></dt>
> <dd>APIC allows the use of programmable IRQ
> - management. <span class="since">Since 0.10.2 (QEMU only)</span> there is
> - an optional attribute <code>eoi</code> with values <code>on</code>
> - and <code>off</code> which toggles the availability of EOI (End of
> + management.
> + An optional attribute <code>eoi</code> with values <code>on</code>
> + and <code>off</code> toggles the availability of EOI (End of
> Interrupt) for the guest.
> </dd>
> <dt><code>hap</code></dt>
> @@ -3600,7 +3549,6 @@
> Typically guests experiencing high system CPU utilization
> during I/O will benefit from this. On the other hand,
> on overloaded host it could increase guest I/O latency.
> - <span class="since">Since 0.9.3 (QEMU and KVM only)</span>
> <b>In general you should leave this option alone, unless you
> are very certain you know what you are doing.</b>
> </li>
> @@ -3613,7 +3561,6 @@
> supported, default is on. In case there is a situation
> where this behavior is suboptimal, this attribute provides
> a way to force the feature off.
> - <span class="since">Since 0.9.5 (QEMU and KVM only)</span>
> <b>In general you should leave this option alone, unless you
> are very certain you know what you are doing.</b>
> </li>
> @@ -3624,7 +3571,6 @@
> Copy-on-read avoids accessing the same backing file sectors
> repeatedly and is useful when the backing file is over a slow
> network. By default copy-on-read is off.
> - <span class='since'>Since 0.9.10 (QEMU and KVM only)</span>
> </li>
> <li>
> The optional <code>discard</code> attribute controls whether
> @@ -3632,7 +3578,6 @@
> ignored or passed to the filesystem. The value can be either
> "unmap" (allow the discard request to be passed) or "ignore"
> (ignore the discard request).
> - <span class='since'>Since 1.0.6 (QEMU and KVM only)</span>
> </li>
> <li>
> The optional <code>detect_zeroes</code> attribute controls whether
> @@ -3788,7 +3726,6 @@
> <dt><code>blockio</code></dt>
> <dd>If present, the <code>blockio</code> element allows
> to override any of the block device properties listed below.
> - <span class="since">Since 0.10.2 (QEMU and KVM)</span>
> <dl>
> <dt><code>logical_block_size</code></dt>
> <dd>The logical block size the disk will report to the guest
> @@ -4661,8 +4589,6 @@
> <p>
> USB, PCI and SCSI devices attached to the host can be passed through
> to the guest using the <code>hostdev</code> element.
> - <span class="since">since after 0.4.4 for USB, 0.6.0 for PCI (KVM only)
> - and 1.0.6 for SCSI (KVM only)</span>:
> </p>
>
> <pre>
> @@ -4936,14 +4860,12 @@
> presence of the Base Address Register for the ROM). If no rom
> bar is specified, the qemu default will be used (older
> versions of qemu used a default of "off", while newer qemus
> - have a default of "on"). <span class="since">Since
> - 0.9.7 (QEMU and KVM only)</span>. The optional
> + have a default of "on"). The optional
> <code>file</code> attribute contains an absolute path to a binary file
> to be presented to the guest as the device's ROM BIOS. This
> can be useful, for example, to provide a PXE boot ROM for a
> virtual function of an sr-iov capable ethernet device (which
> has no boot ROMs for the VFs).
> - <span class="since">Since 0.9.10 (QEMU and KVM only)</span>.
> The optional <code>enabled</code> attribute can be set to
> <code>no</code> to disable PCI ROM loading completely for the device;
> if PCI ROM loading is disabled through this attribute, attempts to
> @@ -5065,8 +4987,7 @@
>
> <p>
> USB device redirection through a character device is
> - supported <span class="since">since after 0.9.5 (KVM
> - only)</span>:
> + supported:
> </p>
>
> @@ -5527,9 +5446,8 @@
> <p>
> Provides direct attachment of the virtual machine's NIC to the given
> physical interface of the host.
> - <span class="since">Since 0.7.7 (QEMU and KVM only)</span><br/>
> This setup requires the Linux macvtap
> - driver to be available. <span class="since">(Since Linux 2.6.34.)</span>
> + driver to be available.
> One of the modes 'vepa'
> ( <a href="http://www.ieee802.org/1/files/public/docs2009/new-evb-congdon-vepa-modular-0709-v01.pdf">
> 'Virtual Ethernet Port Aggregator'</a>), 'bridge' or 'private'
> @@ -5888,7 +5801,6 @@ qemu-kvm -net nic,model=? /dev/null
> will be rejected. If this attribute is not present, then the
> domain defaults to 'vhost' if present, but silently falls back
> to 'qemu' without error.
> - <span class="since">Since 0.8.8 (QEMU and KVM only)</span>
> </dd>
> <dd>
> For interfaces of type='hostdev' (PCI passthrough devices)
> @@ -5913,7 +5825,7 @@ qemu-kvm -net nic,model=? /dev/null
> The <code>txmode</code> attribute specifies how to handle
> transmission of packets when the transmit buffer is full. The
> value can be either 'iothread' or 'timer'.
> - <span class="since">Since 0.8.8 (QEMU and KVM only)</span><br/><br/>
> + <br/><br/>
>
> If set to 'iothread', packet tx is all done in an iothread in
> the bottom half of the driver (this option translates into
> @@ -5945,7 +5857,7 @@ qemu-kvm -net nic,model=? /dev/null
> Typically guests experiencing high system CPU utilization
> during I/O will benefit from this. On the other hand,
> on overloaded host it could increase guest I/O latency.
> - <span class="since">Since 0.9.3 (QEMU and KVM only)</span><br/><br/>
> + <br/><br/>
>
> <b>In general you should leave this option alone, unless you
> are very certain you know what you are doing.</b>
> @@ -7905,7 +7802,6 @@ qemu-kvm -net nic,model=? /dev/null
> <p>
> A virtual hardware watchdog device can be added to the guest via
> the <code>watchdog</code> element.
> - <span class="since">Since 0.7.3, QEMU and KVM only</span>
> </p>
>
> <p>
> @@ -7998,8 +7894,7 @@ qemu-kvm -net nic,model=? /dev/null
> It will be automatically added when appropriate, so there is no
> need to explicitly add this element in the guest XML unless a
> specific PCI slot needs to be assigned.
> - <span class="since">Since 0.8.3, Xen, QEMU and KVM only</span>
> - Additionally, <span class="since">since 0.8.4</span>, if the
> + If the
> memballoon device needs to be explicitly disabled,
> <code>model='none'</code> may be used.
> </p>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 833 bytes
Desc: not available
URL: <http://listman.redhat.com/archives/libvir-list/attachments/20190717/da2a3d27/attachment-0001.sig>
More information about the libvir-list
mailing list