[libvirt] [PATCH] docs: add dimm address document in docs

[Peter Krempa]

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 at 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
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 819 bytes
Desc: Digital signature
URL: <http://listman.redhat.com/archives/libvir-list/attachments/20150514/4762af4c/attachment-0001.sig>