docs: Use <code> inside <dt> for symbols

Most of the time, the <dt> tag is used when providing
documentation for a symbol; enclose symbols in <code> tags to
style them appropriately.
This commit is contained in:
Andrea Bolognani 2016-04-21 15:23:56 +02:00
parent 2f745b63fd
commit 61b070cf20
7 changed files with 126 additions and 126 deletions

View File

@ -57,13 +57,13 @@
</p>
<dl>
<dt>pid</dt>
<dt><code>pid</code></dt>
<dd>Process ID of the libvirtd daemon generating the audit record.</dd>
<dt>uid</dt>
<dt><code>uid</code></dt>
<dd>User ID of the libvirtd daemon process generating the audit record.</dd>
<dt>subj</dt>
<dt><code>subj</code></dt>
<dd>Security context of the libvirtd daemon process generating the audit record.</dd>
<dt>msg</dt>
<dt><code>msg</code></dt>
<dd>String containing a list of key=value pairs specific to the type of audit record being reported.</dd>
</dl>
@ -72,21 +72,21 @@
</p>
<dl>
<dt>virt</dt>
<dt><code>virt</code></dt>
<dd>Type of virtualization driver used. One of <code>qemu</code> or <code>lxc</code></dd>
<dt>vm</dt>
<dt><code>vm</code></dt>
<dd>Host driver unique name of the guest</dd>
<dt>uuid</dt>
<dt><code>uuid</code></dt>
<dd>Globally unique identifier for the guest</dd>
<dt>exe</dt>
<dt><code>exe</code></dt>
<dd>Path of the libvirtd daemon</dd>
<dt>hostname</dt>
<dt><code>hostname</code></dt>
<dd>Currently unused</dd>
<dt>addr</dt>
<dt><code>addr</code></dt>
<dd>Currently unused</dd>
<dt>terminal</dt>
<dt><code>terminal</code></dt>
<dd>Currently unused</dd>
<dt>res</dt>
<dt><code>res</code></dt>
<dd>Result of the action, either <code>success</code> or <code>failed</code></dd>
</dl>
@ -98,15 +98,15 @@
</p>
<dl>
<dt>op</dt>
<dt><code>op</code></dt>
<dd>Type of operation performed. One of <code>start</code>, <code>stop</code> or <code>init</code></dd>
<dt>reason</dt>
<dt><code>reason</code></dt>
<dd>The reason which caused the operation to happen</dd>
<dt>vm-pid</dt>
<dt><code>vm-pid</code></dt>
<dd>ID of the primary/leading process associated with the guest</dd>
<dt>init-pid</dt>
<dt><code>init-pid</code></dt>
<dd>ID of the <code>init</code> process in a container. Only if <code>op=init</code> and <code>virt=lxc</code></dd>
<dt>pid-ns</dt>
<dt><code>pid-ns</code></dt>
<dd>Namespace ID of the <code>init</code> process in a container. Only if <code>op=init</code> and <code>virt=lxc</code></dd>
</dl>
@ -118,11 +118,11 @@
</p>
<dl>
<dt>model</dt>
<dt><code>model</code></dt>
<dd>The security driver type. One of <code>selinux</code> or <code>apparmor</code></dd>
<dt>vm-ctx</dt>
<dt><code>vm-ctx</code></dt>
<dd>Security context for the guest process</dd>
<dt>img-ctx</dt>
<dt><code>img-ctx</code></dt>
<dd>Security context for the guest disk images and other assigned host resources</dd>
</dl>
@ -144,13 +144,13 @@
</p>
<dl>
<dt>reason</dt>
<dt><code>reason</code></dt>
<dd>The reason which caused the resource to be assigned to happen</dd>
<dt>resrc</dt>
<dt><code>resrc</code></dt>
<dd>The type of resource assigned. Set to <code>vcpu</code></dd>
<dt>old-vcpu</dt>
<dt><code>old-vcpu</code></dt>
<dd>Original vCPU count, or 0</dd>
<dt>new-vcpu</dt>
<dt><code>new-vcpu</code></dt>
<dd>Updated vCPU count</dd>
</dl>
@ -162,13 +162,13 @@
</p>
<dl>
<dt>reason</dt>
<dt><code>reason</code></dt>
<dd>The reason which caused the resource to be assigned to happen</dd>
<dt>resrc</dt>
<dt><code>resrc</code></dt>
<dd>The type of resource assigned. Set to <code>mem</code></dd>
<dt>old-mem</dt>
<dt><code>old-mem</code></dt>
<dd>Original memory size in bytes, or 0</dd>
<dt>new-mem</dt>
<dt><code>new-mem</code></dt>
<dd>Updated memory size in bytes</dd>
</dl>
@ -178,13 +178,13 @@
</p>
<dl>
<dt>reason</dt>
<dt><code>reason</code></dt>
<dd>The reason which caused the resource to be assigned to happen</dd>
<dt>resrc</dt>
<dt><code>resrc</code></dt>
<dd>The type of resource assigned. Set to <code>disk</code></dd>
<dt>old-disk</dt>
<dt><code>old-disk</code></dt>
<dd>Original host file or device path acting as the disk backing file</dd>
<dt>new-disk</dt>
<dt><code>new-disk</code></dt>
<dd>Updated host file or device path acting as the disk backing file</dd>
</dl>
@ -195,13 +195,13 @@
</p>
<dl>
<dt>reason</dt>
<dt><code>reason</code></dt>
<dd>The reason which caused the resource to be assigned to happen</dd>
<dt>resrc</dt>
<dt><code>resrc</code></dt>
<dd>The type of resource assigned. Set to <code>net</code></dd>
<dt>old-net</dt>
<dt><code>old-net</code></dt>
<dd>Original MAC address of the guest network interface</dd>
<dt>new-net</dt>
<dt><code>new-net</code></dt>
<dd>Updated MAC address of the guest network interface</dd>
</dl>
@ -211,13 +211,13 @@
</p>
<dl>
<dt>reason</dt>
<dt><code>reason</code></dt>
<dd>The reason which caused the resource to be assigned to happen</dd>
<dt>resrc</dt>
<dt><code>resrc</code></dt>
<dd>The type of resource assigned. Set to <code>net</code></dd>
<dt>net</dt>
<dt><code>net</code></dt>
<dd>MAC address of the host network interface</dd>
<dt>rdev</dt>
<dt><code>rdev</code></dt>
<dd>Name of the host network interface</dd>
</dl>
@ -227,13 +227,13 @@
</p>
<dl>
<dt>reason</dt>
<dt><code>reason</code></dt>
<dd>The reason which caused the resource to be assigned to happen</dd>
<dt>resrc</dt>
<dt><code>resrc</code></dt>
<dd>The type of resource assigned. Set to <code>fs</code></dd>
<dt>old-fs</dt>
<dt><code>old-fs</code></dt>
<dd>Original host directory, file or device path backing the filesystem </dd>
<dt>new-fs</dt>
<dt><code>new-fs</code></dt>
<dd>Updated host directory, file or device path backing the filesystem</dd>
</dl>
@ -243,15 +243,15 @@
</p>
<dl>
<dt>reason</dt>
<dt><code>reason</code></dt>
<dd>The reason which caused the resource to be assigned to happen</dd>
<dt>resrc</dt>
<dt><code>resrc</code></dt>
<dd>The type of resource assigned. Set to <code>hostdev</code> or <code>dev</code></dd>
<dt>dev</dt>
<dt><code>dev</code></dt>
<dd>The unique bus identifier of the USB, PCI or SCSI device, if <code>resrc=dev</code></dd>
<dt>disk</dt>
<dt><code>disk</code></dt>
<dd>The path of the block device assigned to the guest, if <code>resrc=hostdev</code></dd>
<dt>chardev</dt>
<dt><code>chardev</code></dt>
<dd>The path of the character device assigned to the guest, if <code>resrc=hostdev</code></dd>
</dl>
@ -261,11 +261,11 @@
</p>
<dl>
<dt>reason</dt>
<dt><code>reason</code></dt>
<dd>The reason which caused the resource to be assigned to happen</dd>
<dt>resrc</dt>
<dt><code>resrc</code></dt>
<dd>The type of resource assigned. Set to <code>tpm</code></dd>
<dt>device</dt>
<dt><code>device</code></dt>
<dd>The path of the host TPM device assigned to the guest</dd>
</dl>
@ -275,13 +275,13 @@
</p>
<dl>
<dt>reason</dt>
<dt><code>reason</code></dt>
<dd>The reason which caused the resource to be assigned to happen</dd>
<dt>resrc</dt>
<dt><code>resrc</code></dt>
<dd>The type of resource assigned. Set to <code>rng</code></dd>
<dt>old-rng</dt>
<dt><code>old-rng</code></dt>
<dd>Original path of the host entropy source for the RNG</dd>
<dt>new-rng</dt>
<dt><code>new-rng</code></dt>
<dd>Updated path of the host entropy source for the RNG</dd>
</dl>
@ -291,13 +291,13 @@
</p>
<dl>
<dt>reason</dt>
<dt><code>reason</code></dt>
<dd>The reason which caused the resource to be assigned to happen</dd>
<dt>resrc</dt>
<dt><code>resrc</code></dt>
<dd>The type of resource assigned. Set to <code>chardev</code></dd>
<dt>old-chardev</dt>
<dt><code>old-chardev</code></dt>
<dd>Original path of the backing character device for given emulated device</dd>
<dt>new-chardev</dt>
<dt><code>new-chardev</code></dt>
<dd>Updated path of the backing character device for given emulated device</dd>
</dl>
@ -307,15 +307,15 @@
</p>
<dl>
<dt>reason</dt>
<dt><code>reason</code></dt>
<dd>The reason which caused the resource to be assigned to happen</dd>
<dt>resrc</dt>
<dt><code>resrc</code></dt>
<dd>The type of resource assigned. Set to <code>smartcard</code></dd>
<dt>old-smartcard</dt>
<dt><code>old-smartcard</code></dt>
<dd>Original path of the backing character device, certificate store or
"nss-smartcard-device" for host smartcard passthrough.
</dd>
<dt>new-smartcard</dt>
<dt><code>new-smartcard</code></dt>
<dd>Updated path of the backing character device, certificate store or
"nss-smartcard-device" for host smartcard passthrough.
</dd>
@ -327,13 +327,13 @@
</p>
<dl>
<dt>reason</dt>
<dt><code>reason</code></dt>
<dd>The reason which caused the resource to be assigned to happen</dd>
<dt>resrc</dt>
<dt><code>resrc</code></dt>
<dd>The type of resource assigned. Set to <code>redir</code></dd>
<dt>bus</dt>
<dt><code>bus</code></dt>
<dd>The bus type, only <code>usb</code> allowed</dd>
<dt>device</dt>
<dt><code>device</code></dt>
<dd>The device type, only <code>USB redir</code> allowed</dd>
</dl>
@ -344,11 +344,11 @@
</p>
<dl>
<dt>reason</dt>
<dt><code>reason</code></dt>
<dd>The reason which caused the resource to be assigned to happen</dd>
<dt>resrc</dt>
<dt><code>resrc</code></dt>
<dd>The type of resource assigned. Set to <code>cgroup</code></dd>
<dt>cgroup</dt>
<dt><code>cgroup</code></dt>
<dd>The name of the cgroup controller</dd>
</dl>

View File

@ -80,15 +80,15 @@ to be provided by all container technologies on Linux.
</p>
<dl>
<dt>container</dt>
<dt><code>container</code></dt>
<dd>The fixed string <code>libvirt-lxc</code> to identify libvirt as the creator</dd>
<dt>container_uuid</dt>
<dt><code>container_uuid</code></dt>
<dd>The UUID assigned to the container by libvirt</dd>
<dt>PATH</dt>
<dt><code>PATH</code></dt>
<dd>The fixed string <code>/bin:/usr/bin</code></dd>
<dt>TERM</dt>
<dt><code>TERM</code></dt>
<dd>The fixed string <code>linux</code></dd>
<dt>HOME</dt>
<dt><code>HOME</code></dt>
<dd>The fixed string <code>/</code></dd>
</dl>
@ -98,11 +98,11 @@ environment variables are also provided
</p>
<dl>
<dt>LIBVIRT_LXC_NAME</dt>
<dt><code>LIBVIRT_LXC_NAME</code></dt>
<dd>The name assigned to the container by libvirt</dd>
<dt>LIBVIRT_LXC_UUID</dt>
<dt><code>LIBVIRT_LXC_UUID</code></dt>
<dd>The UUID assigned to the container by libvirt</dd>
<dt>LIBVIRT_LXC_CMDLINE</dt>
<dt><code>LIBVIRT_LXC_CMDLINE</code></dt>
<dd>The unparsed command line arguments specified in the container configuration.
Use of this is discouraged, in favour of passing arguments directly to the
container init process via the <code>initarg</code> config element.</dd>

View File

@ -73,19 +73,19 @@
<dd>This expresses what kind of operating system the hypervisor
is able to run. Possible values are:
<dl>
<dt>xen</dt>
<dt><code>xen</code></dt>
<dd>for XEN</dd>
<dt>linux</dt>
<dt><code>linux</code></dt>
<dd>legacy alias for <code>xen</code></dd>
<dt>hvm</dt>
<dt><code>hvm</code></dt>
<dd>Unmodified operating system</dd>
<dt>exe</dt>
<dt><code>exe</code></dt>
<dd>Container based virtualization</dd>
<dt>uml</dt>
<dt><code>uml</code></dt>
<dd>User Mode Linux</dd>
</dl>
</dd>
@ -97,37 +97,37 @@
<dd>This optional element encases possible features that can be used
with a guest of described type. Possible subelements are:
<dl>
<dt>pae</dt><dd>If present, 32-bit guests can use PAE
<dt><code>pae</code></dt><dd>If present, 32-bit guests can use PAE
address space extensions, <span class="since">since
0.4.1</span></dd>
<dt>nonpae</dt><dd>If present, 32-bit guests can be run
<dt><code>nonpae</code></dt><dd>If present, 32-bit guests can be run
without requiring PAE, <span class="since">since
0.4.1</span></dd>
<dt>ia64_be</dt><dd>If present, IA64 guests can be run in
<dt><code>ia64_be</code></dt><dd>If present, IA64 guests can be run in
big-endian mode, <span class="since">since 0.4.1</span></dd>
<dt>acpi</dt><dd>If this element is present,
<dt><code>acpi</code></dt><dd>If this element is present,
the <code>default</code> attribute describes whether the
hypervisor exposes ACPI to the guest by default, and
the <code>toggle</code> attribute describes whether the
user can override this
default. <span class="since">Since 0.4.1</span></dd>
<dt>apic</dt><dd>If this element is present,
<dt><code>apic</code></dt><dd>If this element is present,
the <code>default</code> attribute describes whether the
hypervisor exposes APIC to the guest by default, and
the <code>toggle</code> attribute describes whether the
user can override this
default. <span class="since">Since 0.4.1</span></dd>
<dt>cpuselection</dt><dd>If this element is present, the
<dt><code>cpuselection</code></dt><dd>If this element is present, the
hypervisor supports the <code>&lt;cpu&gt;</code> element
within a domain definition for fine-grained control over
the CPU presented to the
guest. <span class="since">Since 0.7.5</span></dd>
<dt>deviceboot</dt><dd>If this element is present,
<dt><code>deviceboot</code></dt><dd>If this element is present,
the <code>&lt;boot order='...'/&gt;</code> element can
be used inside devices, rather than the older boot
specification by category. <span class="since">Since
0.8.8</span></dd>
<dt>disksnapshot</dt><dd>If this element is present,
<dt><code>disksnapshot</code></dt><dd>If this element is present,
the <code>default</code> attribute describes whether
external disk snapshots are supported. If absent,
external snapshots may still be supported, but it

View File

@ -3331,17 +3331,17 @@
...</pre>
<dl>
<dt>lockspace</dt>
<dt><code>lockspace</code></dt>
<dd>This is an arbitrary string, identifying the lockspace
within which the key is held. Lock managers may impose
extra restrictions on the format, or length of the lockspace
name.</dd>
<dt>key</dt>
<dt><code>key</code></dt>
<dd>This is an arbitrary string, uniquely identifying the
lease to be acquired. Lock managers may impose extra
restrictions on the format, or length of the key.
</dd>
<dt>target</dt>
<dt><code>target</code></dt>
<dd>This is the fully qualified path of the file associated
with the lockspace. The offset specifies where the lease
is stored within the file. If the lock manager does not
@ -3429,12 +3429,12 @@
"subsystem" and the <code>type</code> is one of the following values
with additional attributes noted.
<dl>
<dt>usb</dt>
<dt><code>usb</code></dt>
<dd>USB devices are detached from the host on guest startup
and reattached after the guest exits or the device is
hot-unplugged.
</dd>
<dt>pci</dt>
<dt><code>pci</code></dt>
<dd>For PCI devices, when <code>managed</code> is "yes" it is
detached from the host before being passed on to the guest
and reattached to the host after the guest exits. If
@ -3445,7 +3445,7 @@
(or <code>virsh nodedev-reattach</code>) after hot-unplug or
stopping the guest.
</dd>
<dt>scsi</dt>
<dt><code>scsi</code></dt>
<dd>For SCSI devices, user is responsible to make sure the device
is not used by host. If supported by the hypervisor and OS, the
optional <code>sgio</code> (<span class="since">since 1.0.6</span>)
@ -3472,7 +3472,7 @@
<dd>The source element describes the device as seen from the host using
the following mechanism to describe:
<dl>
<dt>usb</dt>
<dt><code>usb</code></dt>
<dd>The USB device can either be addressed by vendor / product id
using the <code>vendor</code> and <code>product</code> elements
or by the device's address on the host using the
@ -3500,10 +3500,10 @@
</tr>
</table>
</dd>
<dt>pci</dt>
<dt><code>pci</code></dt>
<dd>PCI devices can only be described by their <code>address</code>.
</dd>
<dt>scsi</dt>
<dt><code>scsi</code></dt>
<dd>SCSI devices are described by both the <code>adapter</code>
and <code>address</code> elements. The <code>address</code>
element includes a <code>bus</code> attribute (a 2-digit bus

View File

@ -61,18 +61,18 @@
&lt;/domainCapabilities&gt;
</pre>
<dl>
<dt>path</dt>
<dt><code>path</code></dt>
<dd>The full path to the emulator binary.</dd>
<dt>domain</dt>
<dt><code>domain</code></dt>
<dd>Describes the <a href="formatdomain.html#elements">virtualization
type</a> (or so called domain type).</dd>
<dt>machine</dt>
<dt><code>machine</code></dt>
<dd>The domain's <a href="formatdomain.html#elementsOSBIOS">machine
type</a>.</dd>
<dt>arch</dt>
<dt><code>arch</code></dt>
<dd>The domain's <a href="formatdomain.html#elementsOSBIOS">
architecture</a>.</dd>
@ -92,7 +92,7 @@
</pre>
<dl>
<dt>vcpu</dt>
<dt><code>vcpu</code></dt>
<dd>The maximum number of supported virtual CPUs</dd>
</dl>
@ -126,18 +126,18 @@
<p>For the <code>loader</code> element, the following can occur:</p>
<dl>
<dt>value</dt>
<dt><code>value</code></dt>
<dd>List of known loader paths. Currently this is only used
to advertise known locations of OVMF binaries for qemu. Binaries
will only be listed if they actually exist on disk.</dd>
<dt>type</dt>
<dt><code>type</code></dt>
<dd>Whether loader is a typical BIOS (<code>rom</code>) or
an UEFI binary (<code>pflash</code>). This refers to
<code>type</code> attribute of the &lt;loader/&gt;
element.</dd>
<dt>readonly</dt>
<dt><code>readonly</code></dt>
<dd>Options for the <code>readonly</code> attribute of the
&lt;loader/&gt; element.</dd>
</dl>
@ -207,11 +207,11 @@
</pre>
<dl>
<dt>diskDevice</dt>
<dt><code>diskDevice</code></dt>
<dd>Options for the <code>device</code> attribute of the &lt;disk/&gt;
element.</dd>
<dt>bus</dt>
<dt><code>bus</code></dt>
<dd>Options for the <code>bus</code> attribute of the &lt;target/&gt;
element for a &lt;disk/&gt;.</dd>
</dl>
@ -257,23 +257,23 @@
</pre>
<dl>
<dt>mode</dt>
<dt><code>mode</code></dt>
<dd>Options for the <code>mode</code> attribute of the &lt;hostdev/&gt;
element.</dd>
<dt>startupPolicy</dt>
<dt><code>startupPolicy</code></dt>
<dd>Options for the <code>startupPolicy</code> attribute of the
&lt;hostdev/&gt; element.</dd>
<dt>subsysType</dt>
<dt><code>subsysType</code></dt>
<dd>Options for the <code>type</code> attribute of the &lt;hostdev/&gt;
element in case of <code>mode="subsystem"</code>.</dd>
<dt>capsType</dt>
<dt><code>capsType</code></dt>
<dd>Options for the <code>type</code> attribute of the &lt;hostdev/&gt;
element in case of <code>mode="capabilities"</code>.</dd>
<dt>pciBackend</dt>
<dt><code>pciBackend</code></dt>
<dd>Options for the <code>name</code> attribute of the &lt;driver/&gt;
element.</dd>
</dl>
@ -313,7 +313,7 @@
<p>GIC capabilities are exposed under the <code>gic</code> element.</p>
<dl>
<dt>version</dt>
<dt><code>version</code></dt>
<dd>Options for the <code>version</code> attribute of the
<code>gic</code> element.</dd>
</dl>

View File

@ -23,19 +23,19 @@
</p>
<dl>
<dt>nop</dt>
<dt><code>nop</code></dt>
<dd>This is a "no op" implementation which does absolutely
nothing. This can be used if mutual exclusion between
virtual machines is not required, or if it is being
solved at another level in the management stack.</dd>
<dt><a href="locking-lockd.html">lockd</a></dt>
<dt><code><a href="locking-lockd.html">lockd</a></code></dt>
<dd>This is the current preferred implementation shipped
with libvirt. It uses the <code>virtlockd</code> daemon
to manage locks using the POSIX fcntl() advisory locking
capability. As such it requires a shared filesystem of
some kind be accessible to all hosts which share the
same image storage.</dd>
<dt><a href="locking-sanlock.html">sanlock</a></dt>
<dt><code><a href="locking-sanlock.html">sanlock</a></code></dt>
<dd>This is an alternative implementation preferred by
the oVirt project. It uses a disk paxos algorithm for
maintaining continuously renewed leases. In the default

View File

@ -102,7 +102,7 @@ much slower than, say, direct hypervisor calls. </li>
Remote libvirt supports a range of transports:
</p>
<dl>
<dt> tls </dt>
<dt><code>tls</code></dt>
<dd><a href="http://en.wikipedia.org/wiki/Transport_Layer_Security" title="Transport Layer Security">TLS</a>
1.0 (SSL 3.1) authenticated and encrypted TCP/IP socket, usually
listening on a public port number. To use this you will need to
@ -110,7 +110,7 @@ Remote libvirt supports a range of transports:
server certificates</a>.
The standard port is 16514.
</dd>
<dt> unix </dt>
<dt><code>unix</code></dt>
<dd> Unix domain socket. Since this is only accessible on the
local machine, it is not encrypted, and uses Unix permissions or
SELinux for authentication.
@ -119,7 +119,7 @@ Remote libvirt supports a range of transports:
<code>/var/run/libvirt/libvirt-sock-ro</code> (the latter
for read-only connections).
</dd>
<dt> ssh </dt>
<dt><code>ssh</code></dt>
<dd> Transported over an ordinary
<a href="http://www.openssh.com/" title="OpenSSH homepage">ssh
(secure shell)</a> connection.
@ -130,15 +130,15 @@ Remote libvirt supports a range of transports:
<a href="http://mah.everybody.org/docs/ssh" title="Using ssh-agent with ssh">ssh-agent</a>)
otherwise programs which use
this transport will stop to ask for a password. </dd>
<dt> ext </dt>
<dt><code>ext</code></dt>
<dd> Any external program which can make a connection to the
remote machine by means outside the scope of libvirt. </dd>
<dt> tcp </dt>
<dt><code>tcp</code></dt>
<dd> Unencrypted TCP/IP socket. Not recommended for production
use, this is normally disabled, but an administrator can enable
it for testing or use over a trusted network.
The standard port is 16509. </dd>
<dt> libssh2 </dt>
<dt><code>libssh2</code></dt>
<dd> Transport over the SSH protocol using
<a href="http://libssh2.org/" title="libssh2 homepage">libssh2</a> instead
of the OpenSSH binary. This transport uses the libvirt authentication callback for