External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2025-03-07 17:28:15 +00:00
Code

docs: Fix documentation for cputune parameters

Browse Source 
This re-adds the example section originally written by Osier Yang,
and indicates the version in which the cputune parameters became
available in libvirt.

Signed-off-by: Igor Serebryany <igor47@moomers.org>
This commit is contained in:
Osier Yang 2011-05-12 18:48:23 +08:00
parent 2a5251e2c4
commit 81cfe71998
1 changed files with 22 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
docs/formatdomain.html.in
View File

@ -288,6 +288,13 @@
&lt;min_guarantee&gt;65536&lt;/min_guarantee&gt; &lt;min_guarantee&gt;65536&lt;/min_guarantee&gt;
&lt;/memtune&gt; &lt;/memtune&gt;
&lt;vcpu cpuset="1-4,^3,6" current="1"&gt;2&lt;/vcpu&gt; &lt;vcpu cpuset="1-4,^3,6" current="1"&gt;2&lt;/vcpu&gt;
&lt;cputune&gt;
&lt;vcpupin vcpu="0" cpuset="1-4,^2"&gt;
&lt;vcpupin vcpu="1" cpuset="0,1"&gt;
&lt;vcpupin vcpu="2" cpuset="2,3"&gt;
&lt;vcpupin vcpu="3" cpuset="0,4"&gt;
&lt;cpushares&gt;2048&lt;/cpushares&gt;
&lt;/cputune&gt;
...</pre> ...</pre>
<dl> <dl>
@ -351,21 +358,30 @@
virtual CPUs should be enabled. virtual CPUs should be enabled.
</dd> </dd>
<dt><code>cputune</code></dt> <dt><code>cputune</code></dt>
<dd> The optional <code>cputune</code> element provides details <dd>
regarding the cpu tunable parameters for the domain.</dd> The optional <code>cputune</code> element provides details
regarding the cpu tunable parameters for the domain.
<span class="since">Since 0.9.0</span>
</dd>
<dt><code>vcpupin</code></dt> <dt><code>vcpupin</code></dt>
<dd> The optional <code>vcpupin</code> element specifies which of host <dd>
The optional <code>vcpupin</code> element specifies which of host
physical CPUS the domain VCPU will be pinned to. If this is ommited, physical CPUS the domain VCPU will be pinned to. If this is ommited,
each VCPU pinned to all the physical CPUS by default. It contains two each VCPU pinned to all the physical CPUS by default. It contains two
required attributes, the attribute <code>vcpu</code> specifies vcpu id, required attributes, the attribute <code>vcpu</code> specifies vcpu id,
and the attribute <code>cpuset</code> is same as attribute <code>cpuset</code> and the attribute <code>cpuset</code> is same as attribute <code>cpuset</code>
of element <code>vcpu</code>. NB, Only qemu driver supports</dd> of element <code>vcpu</code>. (NB: Only qemu driver support)
<span class="since">Since 0.9.0</span>
</dd>
<dt><code>shares</code></dt> <dt><code>shares</code></dt>
<dd> The optional <code>shares</code> element specifies the proportional <dd>
The optional <code>shares</code> element specifies the proportional
weighted share for the domain. If this is ommited, it defaults to weighted share for the domain. If this is ommited, it defaults to
the OS provided defaults. NB, There is no unit for the value, it's a relative the OS provided defaults. NB, There is no unit for the value, it's a relative
measure based on the setting of other VM, e.g. A VM configured with value measure based on the setting of other VM, e.g. A VM configured with value
2048 will get twice as much CPU time as a VM configured with value 1024.</dd> 2048 will get twice as much CPU time as a VM configured with value 1024.
<span class="since">Since 0.9.0</span>
</dd>
</dl> </dl>
<h3><a name="elementsCPU">CPU model and topology</a></h3> <h3><a name="elementsCPU">CPU model and topology</a></h3>