[libvirt] [PATCH] docs: add dimm address document in docs
As we have a new device address type 'dimm', add some document and an example to our docs. Signed-off-by: Luyao Huang <lhuang@redhat.com> --- docs/formatdomain.html.in | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in index e0b6ba7..0e908a1 100644 --- a/docs/formatdomain.html.in +++ b/docs/formatdomain.html.in @@ -2876,6 +2876,13 @@ attributes: <code>iobase</code> and <code>irq</code>. <span class="since">Since 1.2.1</span> </dd> + <dt><code>type='dimm'</code></dt> + <dd>DIMM addresses, for memory device, have the following additional + attributes: <code>slot</code> (a value between 0 and 4294967295, + inclusive), and <code>base</code> (a hex value between 0 and + 0xffffffffffffffff, inclusive). + <span class="since">Since 1.2.14</span> + </dd> </dl> <h4><a name="elementsControllers">Controllers</a></h4> @@ -6038,6 +6045,7 @@ qemu-kvm -net nic,model=? /dev/null <size unit='KiB'>524287</size> <node>0</node> </target> + <address type='dimm' slot='0' base='0x0'/> </memory> <memory model='dimm'> <source> -- 1.8.3.1
On Thu, May 14, 2015 at 17:08:53 +0800, Luyao Huang wrote:
As we have a new device address type 'dimm', add some document and an example to our docs.
Signed-off-by: Luyao Huang <lhuang@redhat.com> --- docs/formatdomain.html.in | 8 ++++++++ 1 file changed, 8 insertions(+)
diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in index e0b6ba7..0e908a1 100644 --- a/docs/formatdomain.html.in +++ b/docs/formatdomain.html.in @@ -2876,6 +2876,13 @@ attributes: <code>iobase</code> and <code>irq</code>. <span class="since">Since 1.2.1</span> </dd> + <dt><code>type='dimm'</code></dt> + <dd>DIMM addresses, for memory device, have the following additional + attributes: <code>slot</code> (a value between 0 and 4294967295, + inclusive), and <code>base</code> (a hex value between 0 and + 0xffffffffffffffff, inclusive). + <span class="since">Since 1.2.14</span>
The values for the DIMM address shouldn't really be documented. I'd rather state that the values are determined automatically and the user should not need to touch them. Peter
On 05/14/2015 07:57 PM, Peter Krempa wrote:
On Thu, May 14, 2015 at 17:08:53 +0800, Luyao Huang wrote:
As we have a new device address type 'dimm', add some document and an example to our docs.
Signed-off-by: Luyao Huang <lhuang@redhat.com> --- docs/formatdomain.html.in | 8 ++++++++ 1 file changed, 8 insertions(+)
diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in index e0b6ba7..0e908a1 100644 --- a/docs/formatdomain.html.in +++ b/docs/formatdomain.html.in @@ -2876,6 +2876,13 @@ attributes: <code>iobase</code> and <code>irq</code>. <span class="since">Since 1.2.1</span> </dd> + <dt><code>type='dimm'</code></dt> + <dd>DIMM addresses, for memory device, have the following additional + attributes: <code>slot</code> (a value between 0 and 4294967295, + inclusive), and <code>base</code> (a hex value between 0 and + 0xffffffffffffffff, inclusive). + <span class="since">Since 1.2.14</span> The values for the DIMM address shouldn't really be documented. I'd rather state that the values are determined automatically and the user should not need to touch them.
Oh, i see, i will remove the value for DIMM address and add some mention about the values. Thanks for your quick review.
Peter
Luyao
participants (3)
-
lhuang -
Luyao Huang
-
Peter Krempa