Small doc fixes

* src/libvirt.c: fix the doc of virNodeGetFreeMemory to say bytes
* docs/drvlxc.html.in docs/drvlxc.html: fix command used in examples
daniel

diff --git a/ChangeLog b/ChangeLog
index 96ac44ac8c627b3654a82aba00c53e4a62712ded..2d0646b7106dfd207892587420c0b1f3a9dd28e9 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+Fri Apr 17 17:32:16 CEST 2009 Daniel Veillard <veillard@redhat.com>
+
+       * src/libvirt.c: fix the doc of virNodeGetFreeMemory to say bytes
+       * docs/drvlxc.html.in docs/drvlxc.html: fix command used in examples
+
 Thu Apr 16 17:48:30 CEST 2009 Guido Günther <agx@sigxcpu.org>
 
        * src/qemu_driver.c (qemudMonitorCommandExtra): don't log monitor

diff --git a/docs/drvlxc.html b/docs/drvlxc.html
index e76a1e727402bd86205bda84a012911b9594d3ba..0d953fc79ff09dd4b327d1ff781649d8c4836a37 100644 (file)
--- a/docs/drvlxc.html
+++ b/docs/drvlxc.html
@@ -192,11 +192,11 @@ debootstrap, whatever) under /opt/vm-1-root:
         <p>
 In both cases, you can define and start a container using:</p>
         <pre>
-lxc --connect lxc:/// define v1.xml
-lxc --connect lxc:/// start v1.xml
+virsh --connect lxc:/// define v1.xml
+virsh --connect lxc:/// start v1.xml
 </pre>
         <pre>
-lxc --connect lxc:/// console v1
+virsh --connect lxc:/// console v1
 </pre>
         <p>Now doing 'ps -ef' will only show processes in the container, for
 instance.

diff --git a/docs/drvlxc.html.in b/docs/drvlxc.html.in
index a930f2281a1b31e90c2d998dac98c417dfefe52c..6ba36fedde1a368ac086e40e8c182974e67a48e8 100644 (file)
--- a/docs/drvlxc.html.in
+++ b/docs/drvlxc.html.in
@@ -70,12 +70,12 @@ debootstrap, whatever) under /opt/vm-1-root:
 <p>
 In both cases, you can define and start a container using:</p>
 <pre>
-lxc --connect lxc:/// define v1.xml
-lxc --connect lxc:/// start v1.xml
+virsh --connect lxc:/// define v1.xml
+virsh --connect lxc:/// start v1.xml
 </pre>
 and then get a console  using:
 <pre>
-lxc --connect lxc:/// console v1
+virsh --connect lxc:/// console v1
 </pre>
 <p>Now doing 'ps -ef' will only show processes in the container, for
 instance.

diff --git a/src/libvirt.c b/src/libvirt.c
index d6de7730285695a678ae998b13125af43a424d76..d018991c7feedf3fa517db5909081c457e3b58ea 100644 (file)
--- a/src/libvirt.c
+++ b/src/libvirt.c
@@ -3158,8 +3158,10 @@ error:
  * @conn: pointer to the hypervisor connection
  *
  * provides the free memory available on the Node
+ * Note: most libvirt APIs provide memory sizes in kilobytes, but in this
+ * function the returned value is in bytes. Divide by 1024 as necessary.
  *
- * Returns the available free memory in kilobytes or 0 in case of error
+ * Returns the available free memory in bytes or 0 in case of error
  */
 unsigned long long
 virNodeGetFreeMemory(virConnectPtr conn)