From: Andrea Bolognani Date: Thu, 21 Apr 2016 13:23:56 +0000 (+0200) Subject: docs: Use inside
for symbols X-Git-Url: http://xenbits.xensource.com/gitweb?a=commitdiff_plain;h=61b070cf20b5f9bd777fb21f3a0b9bac03202ab3;p=libvirt.git docs: Use inside
for symbols Most of the time, the
tag is used when providing documentation for a symbol; enclose symbols in tags to style them appropriately. --- diff --git a/docs/auditlog.html.in b/docs/auditlog.html.in index 8a007caf35..012d0680a8 100644 --- a/docs/auditlog.html.in +++ b/docs/auditlog.html.in @@ -57,13 +57,13 @@

-
pid
+
pid
Process ID of the libvirtd daemon generating the audit record.
-
uid
+
uid
User ID of the libvirtd daemon process generating the audit record.
-
subj
+
subj
Security context of the libvirtd daemon process generating the audit record.
-
msg
+
msg
String containing a list of key=value pairs specific to the type of audit record being reported.
@@ -72,21 +72,21 @@

-
virt
+
virt
Type of virtualization driver used. One of qemu or lxc
-
vm
+
vm
Host driver unique name of the guest
-
uuid
+
uuid
Globally unique identifier for the guest
-
exe
+
exe
Path of the libvirtd daemon
-
hostname
+
hostname
Currently unused
-
addr
+
addr
Currently unused
-
terminal
+
terminal
Currently unused
-
res
+
res
Result of the action, either success or failed
@@ -98,15 +98,15 @@

-
op
+
op
Type of operation performed. One of start, stop or init
-
reason
+
reason
The reason which caused the operation to happen
-
vm-pid
+
vm-pid
ID of the primary/leading process associated with the guest
-
init-pid
+
init-pid
ID of the init process in a container. Only if op=init and virt=lxc
-
pid-ns
+
pid-ns
Namespace ID of the init process in a container. Only if op=init and virt=lxc
@@ -118,11 +118,11 @@

-
model
+
model
The security driver type. One of selinux or apparmor
-
vm-ctx
+
vm-ctx
Security context for the guest process
-
img-ctx
+
img-ctx
Security context for the guest disk images and other assigned host resources
@@ -144,13 +144,13 @@

-
reason
+
reason
The reason which caused the resource to be assigned to happen
-
resrc
+
resrc
The type of resource assigned. Set to vcpu
-
old-vcpu
+
old-vcpu
Original vCPU count, or 0
-
new-vcpu
+
new-vcpu
Updated vCPU count
@@ -162,13 +162,13 @@

-
reason
+
reason
The reason which caused the resource to be assigned to happen
-
resrc
+
resrc
The type of resource assigned. Set to mem
-
old-mem
+
old-mem
Original memory size in bytes, or 0
-
new-mem
+
new-mem
Updated memory size in bytes
@@ -178,13 +178,13 @@

-
reason
+
reason
The reason which caused the resource to be assigned to happen
-
resrc
+
resrc
The type of resource assigned. Set to disk
-
old-disk
+
old-disk
Original host file or device path acting as the disk backing file
-
new-disk
+
new-disk
Updated host file or device path acting as the disk backing file
@@ -195,13 +195,13 @@

-
reason
+
reason
The reason which caused the resource to be assigned to happen
-
resrc
+
resrc
The type of resource assigned. Set to net
-
old-net
+
old-net
Original MAC address of the guest network interface
-
new-net
+
new-net
Updated MAC address of the guest network interface
@@ -211,13 +211,13 @@

-
reason
+
reason
The reason which caused the resource to be assigned to happen
-
resrc
+
resrc
The type of resource assigned. Set to net
-
net
+
net
MAC address of the host network interface
-
rdev
+
rdev
Name of the host network interface
@@ -227,13 +227,13 @@

-
reason
+
reason
The reason which caused the resource to be assigned to happen
-
resrc
+
resrc
The type of resource assigned. Set to fs
-
old-fs
+
old-fs
Original host directory, file or device path backing the filesystem
-
new-fs
+
new-fs
Updated host directory, file or device path backing the filesystem
@@ -243,15 +243,15 @@

-
reason
+
reason
The reason which caused the resource to be assigned to happen
-
resrc
+
resrc
The type of resource assigned. Set to hostdev or dev
-
dev
+
dev
The unique bus identifier of the USB, PCI or SCSI device, if resrc=dev
-
disk
+
disk
The path of the block device assigned to the guest, if resrc=hostdev
-
chardev
+
chardev
The path of the character device assigned to the guest, if resrc=hostdev
@@ -261,11 +261,11 @@

-
reason
+
reason
The reason which caused the resource to be assigned to happen
-
resrc
+
resrc
The type of resource assigned. Set to tpm
-
device
+
device
The path of the host TPM device assigned to the guest
@@ -275,13 +275,13 @@

-
reason
+
reason
The reason which caused the resource to be assigned to happen
-
resrc
+
resrc
The type of resource assigned. Set to rng
-
old-rng
+
old-rng
Original path of the host entropy source for the RNG
-
new-rng
+
new-rng
Updated path of the host entropy source for the RNG
@@ -291,13 +291,13 @@

-
reason
+
reason
The reason which caused the resource to be assigned to happen
-
resrc
+
resrc
The type of resource assigned. Set to chardev
-
old-chardev
+
old-chardev
Original path of the backing character device for given emulated device
-
new-chardev
+
new-chardev
Updated path of the backing character device for given emulated device
@@ -307,15 +307,15 @@

-
reason
+
reason
The reason which caused the resource to be assigned to happen
-
resrc
+
resrc
The type of resource assigned. Set to smartcard
-
old-smartcard
+
old-smartcard
Original path of the backing character device, certificate store or "nss-smartcard-device" for host smartcard passthrough.
-
new-smartcard
+
new-smartcard
Updated path of the backing character device, certificate store or "nss-smartcard-device" for host smartcard passthrough.
@@ -327,13 +327,13 @@

-
reason
+
reason
The reason which caused the resource to be assigned to happen
-
resrc
+
resrc
The type of resource assigned. Set to redir
-
bus
+
bus
The bus type, only usb allowed
-
device
+
device
The device type, only USB redir allowed
@@ -344,11 +344,11 @@

-
reason
+
reason
The reason which caused the resource to be assigned to happen
-
resrc
+
resrc
The type of resource assigned. Set to cgroup
-
cgroup
+
cgroup
The name of the cgroup controller
diff --git a/docs/drvlxc.html.in b/docs/drvlxc.html.in index d6c57c4fb1..3dc9d59448 100644 --- a/docs/drvlxc.html.in +++ b/docs/drvlxc.html.in @@ -80,15 +80,15 @@ to be provided by all container technologies on Linux.

-
container
+
container
The fixed string libvirt-lxc to identify libvirt as the creator
-
container_uuid
+
container_uuid
The UUID assigned to the container by libvirt
-
PATH
+
PATH
The fixed string /bin:/usr/bin
-
TERM
+
TERM
The fixed string linux
-
HOME
+
HOME
The fixed string /
@@ -98,11 +98,11 @@ environment variables are also provided

-
LIBVIRT_LXC_NAME
+
LIBVIRT_LXC_NAME
The name assigned to the container by libvirt
-
LIBVIRT_LXC_UUID
+
LIBVIRT_LXC_UUID
The UUID assigned to the container by libvirt
-
LIBVIRT_LXC_CMDLINE
+
LIBVIRT_LXC_CMDLINE
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 initarg config element.
diff --git a/docs/formatcaps.html.in b/docs/formatcaps.html.in index c187187f24..0ba567c399 100644 --- a/docs/formatcaps.html.in +++ b/docs/formatcaps.html.in @@ -73,19 +73,19 @@
This expresses what kind of operating system the hypervisor is able to run. Possible values are:
-
xen
+
xen
for XEN
-
linux
+
linux
legacy alias for xen
-
hvm
+
hvm
Unmodified operating system
-
exe
+
exe
Container based virtualization
-
uml
+
uml
User Mode Linux
@@ -97,37 +97,37 @@
This optional element encases possible features that can be used with a guest of described type. Possible subelements are:
-
pae
If present, 32-bit guests can use PAE +
pae
If present, 32-bit guests can use PAE address space extensions, since 0.4.1
-
nonpae
If present, 32-bit guests can be run +
nonpae
If present, 32-bit guests can be run without requiring PAE, since 0.4.1
-
ia64_be
If present, IA64 guests can be run in +
ia64_be
If present, IA64 guests can be run in big-endian mode, since 0.4.1
-
acpi
If this element is present, +
acpi
If this element is present, the default attribute describes whether the hypervisor exposes ACPI to the guest by default, and the toggle attribute describes whether the user can override this default. Since 0.4.1
-
apic
If this element is present, +
apic
If this element is present, the default attribute describes whether the hypervisor exposes APIC to the guest by default, and the toggle attribute describes whether the user can override this default. Since 0.4.1
-
cpuselection
If this element is present, the +
cpuselection
If this element is present, the hypervisor supports the <cpu> element within a domain definition for fine-grained control over the CPU presented to the guest. Since 0.7.5
-
deviceboot
If this element is present, +
deviceboot
If this element is present, the <boot order='...'/> element can be used inside devices, rather than the older boot specification by category. Since 0.8.8
-
disksnapshot
If this element is present, +
disksnapshot
If this element is present, the default attribute describes whether external disk snapshots are supported. If absent, external snapshots may still be supported, but it diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in index 895114bffe..a9c657d48d 100644 --- a/docs/formatdomain.html.in +++ b/docs/formatdomain.html.in @@ -3331,17 +3331,17 @@ ...
-
lockspace
+
lockspace
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.
-
key
+
key
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.
-
target
+
target
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 type is one of the following values with additional attributes noted.
-
usb
+
usb
USB devices are detached from the host on guest startup and reattached after the guest exits or the device is hot-unplugged.
-
pci
+
pci
For PCI devices, when managed 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 virsh nodedev-reattach) after hot-unplug or stopping the guest.
-
scsi
+
scsi
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 sgio (since 1.0.6) @@ -3472,7 +3472,7 @@
The source element describes the device as seen from the host using the following mechanism to describe:
-
usb
+
usb
The USB device can either be addressed by vendor / product id using the vendor and product elements or by the device's address on the host using the @@ -3500,10 +3500,10 @@
-
pci
+
pci
PCI devices can only be described by their address.
-
scsi
+
scsi
SCSI devices are described by both the adapter and address elements. The address element includes a bus attribute (a 2-digit bus diff --git a/docs/formatdomaincaps.html.in b/docs/formatdomaincaps.html.in index 0c403214dd..edbb948215 100644 --- a/docs/formatdomaincaps.html.in +++ b/docs/formatdomaincaps.html.in @@ -61,18 +61,18 @@ </domainCapabilities>
-
path
+
path
The full path to the emulator binary.
-
domain
+
domain
Describes the virtualization type (or so called domain type).
-
machine
+
machine
The domain's machine type.
-
arch
+
arch
The domain's architecture.
@@ -92,7 +92,7 @@
-
vcpu
+
vcpu
The maximum number of supported virtual CPUs
@@ -126,18 +126,18 @@

For the loader element, the following can occur:

-
value
+
value
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.
-
type
+
type
Whether loader is a typical BIOS (rom) or an UEFI binary (pflash). This refers to type attribute of the <loader/> element.
-
readonly
+
readonly
Options for the readonly attribute of the <loader/> element.
@@ -207,11 +207,11 @@
-
diskDevice
+
diskDevice
Options for the device attribute of the <disk/> element.
-
bus
+
bus
Options for the bus attribute of the <target/> element for a <disk/>.
@@ -257,23 +257,23 @@
-
mode
+
mode
Options for the mode attribute of the <hostdev/> element.
-
startupPolicy
+
startupPolicy
Options for the startupPolicy attribute of the <hostdev/> element.
-
subsysType
+
subsysType
Options for the type attribute of the <hostdev/> element in case of mode="subsystem".
-
capsType
+
capsType
Options for the type attribute of the <hostdev/> element in case of mode="capabilities".
-
pciBackend
+
pciBackend
Options for the name attribute of the <driver/> element.
@@ -313,7 +313,7 @@

GIC capabilities are exposed under the gic element.

-
version
+
version
Options for the version attribute of the gic element.
diff --git a/docs/locking.html.in b/docs/locking.html.in index c25ae850cf..aca18113dd 100644 --- a/docs/locking.html.in +++ b/docs/locking.html.in @@ -23,19 +23,19 @@

-
nop
+
nop
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.
-
lockd
+
lockd
This is the current preferred implementation shipped with libvirt. It uses the virtlockd 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.
-
sanlock
+
sanlock
This is an alternative implementation preferred by the oVirt project. It uses a disk paxos algorithm for maintaining continuously renewed leases. In the default diff --git a/docs/remote.html.in b/docs/remote.html.in index dc9b354de5..ace157721f 100644 --- a/docs/remote.html.in +++ b/docs/remote.html.in @@ -102,7 +102,7 @@ much slower than, say, direct hypervisor calls. Remote libvirt supports a range of transports:

-
tls
+
tls
TLS 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. The standard port is 16514.
-
unix
+
unix
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: /var/run/libvirt/libvirt-sock-ro (the latter for read-only connections).
-
ssh
+
ssh
Transported over an ordinary ssh (secure shell) connection. @@ -130,15 +130,15 @@ Remote libvirt supports a range of transports: ssh-agent) otherwise programs which use this transport will stop to ask for a password.
-
ext
+
ext
Any external program which can make a connection to the remote machine by means outside the scope of libvirt.
-
tcp
+
tcp
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.
-
libssh2
+
libssh2
Transport over the SSH protocol using libssh2 instead of the OpenSSH binary. This transport uses the libvirt authentication callback for