[libvirt] [PATCH] Fix several formatting mistakes in doc

[Daniel P. Berrange]

On Thu, Mar 31, 2011 at 01:14:03PM +0200, Michal Privoznik wrote:
> ---
>  docs/formatdomain.html.in |    2 +-
>  docs/hooks.html.in        |    6 +++---
>  src/libvirt.c             |    2 +-
>  3 files changed, 5 insertions(+), 5 deletions(-)
> 
> diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
> index 8b50814..438cbf0 100644
> --- a/docs/formatdomain.html.in
> +++ b/docs/formatdomain.html.in
> @@ -353,7 +353,7 @@
>        <dd> The optional <code>vcpupin</code> element specifies which of host
>          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
> -        required attributes, the attribute <code>vcpu</vcpu> 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>
>          of element <code>vcpu</code>. NB, Only qemu driver supports</dd>
>        <dt><code>shares</code></dt>
> diff --git a/docs/hooks.html.in b/docs/hooks.html.in
> index eec7a6a..890359e 100644
> --- a/docs/hooks.html.in
> +++ b/docs/hooks.html.in
> @@ -105,16 +105,16 @@
>          is not started.  The first location, <span class="since">since
>          0.9.0</span>, is before libvirt performs any resource
>          labeling, and the hook can allocate resources not managed by
> -        libvirt such as DRBD or missing bridges.  This is called as:</br>
> +        libvirt such as DRBD or missing bridges.  This is called as:<br/>
>          <pre>/etc/libvirt/hooks/qemu guest_name prepare begin -</pre>
>          The second location, available <span class="since">Since
>          0.8.0</span>, occurs after libvirt has finished labeling
> -        all resources, but has not yet started the guest, called as:</br>
> +        all resources, but has not yet started the guest, called as:<br/>
>          <pre>/etc/libvirt/hooks/qemu guest_name start begin -</pre></li>
>        <li>When a QEMU guest is stopped, the qemu hook script is called
>          in two locations, to match the startup.
>          First, <span class="since">since 0.8.0</span>, the hook is
> -        called before libvirt restores any labels:</br>
> +        called before libvirt restores any labels:<br/>
>          <pre>/etc/libvirt/hooks/qemu guest_name stopped end -</pre>
>          Then, after libvirt has released all resources, the hook is
>          called again, <span class="since">since 0.9.0</span>, to allow

This exposes several problems in the docs/Makefile.am

 - make clean doesn't work in a VPATH build because
   for some reason the HTML is generated in the $srcdir
   and so 'rm -f *.html' misses the files

 - We run xmllint, but failures in xmllint validation
   are not causing a build failure

If both of these are fixed, then the automated build would
detect this in the future.

> diff --git a/src/libvirt.c b/src/libvirt.c
> index 9bdb4c8..8be18d4 100644
> --- a/src/libvirt.c
> +++ b/src/libvirt.c
> @@ -2852,7 +2852,7 @@ error:
>  }
>  
>  /*
> - * virDomainSetMemoryFlags
> + * virDomainSetMemoryFlags:
>   * @domain: a domain object or NULL
>   * @memory: the memory size in kilobytes
>   * @flags: an OR'ed set of virDomainMemoryModFlags
> -- 
> 1.7.4
> 
> --
> libvir-list mailing list
> libvir-list at redhat.com
> https://www.redhat.com/mailman/listinfo/libvir-list

ACK

Daniel
-- 
|: http://berrange.com      -o-    http://www.flickr.com/photos/dberrange/ :|
|: http://libvirt.org              -o-             http://virt-manager.org :|
|: http://autobuild.org       -o-         http://search.cpan.org/~danberr/ :|
|: http://entangle-photo.org       -o-       http://live.gnome.org/gtk-vnc :|