Re: [libvirt] Missing documentation?

2013-05-07 Thread Joseph Glanville
Fixed the libxml2 errors.

You need to install the DTD into /etc/xml as W3C is now blocking libxml2
from downloading them, that is what caused the errors I saw.

On debian systems the DTD for XHTML is packaged as w3c-dtd-xhtml
For RHEL compatible systems I think the correct package is
html11-dtds
However docs are still empty. :(


On Mon, May 6, 2013 at 10:23 AM, Eric Blake ebl...@redhat.com wrote:

 On 05/05/2013 02:57 AM, Joseph Glanville wrote:
  Hi,
 
  I am playing with libvirt and I noticed the API reference appears to be
  empty, the page in particular is: http://libvirt.org/html/index.html

 Yeah, Dan did a refactoring of several web pages recently, and probably
 missed something that resulted in killing the content of this page.  I'm
 no xml wizard, so I'm hoping Dan can step in soon; but if it is still
 broken in 24 hours, I'll try my hand at it (you never know - I might
 learn something useful!).

 
  I also tried to build the documentation from git but this also produces
  empty html along with a stream of errors because W3C is blocking access
 to
  the DTD from the useragent that is used to attempt to download it
  (rightfully so, you don't need to download it more than once)
 
  My guess is that without the DTD the parser being used is borking on
  undefined entities like this:
  csharp.html.in:441: parser error : Entity 'nbsp' not defined
 
 nbsp;/tdtdnbsp;/tdtdnbsp;/tdtdnbsp;/tdtdnbsp;/tdtdnbsp;
  and as such is no real docs are being produced.
 
  I am not subscribed to the list so please use reply-all (or just cc me)

 It's list policy to reply-all anyways :)

 --
 Eric Blake   eblake redhat com+1-919-301-3266
 Libvirt virtualization library http://libvirt.org


--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list

Re: [libvirt] Missing documentation?

2013-05-07 Thread Daniel P. Berrange
On Tue, May 07, 2013 at 02:38:30AM -0700, Joseph Glanville wrote:
 Fixed the libxml2 errors.
 
 You need to install the DTD into /etc/xml as W3C is now blocking libxml2
 from downloading them, that is what caused the errors I saw.
 
 On debian systems the DTD for XHTML is packaged as w3c-dtd-xhtml
 For RHEL compatible systems I think the correct package is
 html11-dtds
 However docs are still empty. :(

If you were using libvirt GIT from the past 4 days, then the blank
APIs docs are my fault. I pushed a fix a few minutes ago, so make
sure you have this commit in your checkout

  commit 5e7b0e8757112f17ea616beb8d171bcc94a0f9c3
  Author: Daniel P. Berrange berra...@redhat.com
  Date:   Tue May 7 11:18:10 2013 +0100

Fix namespace bugs in API docs, todo page  hv support page


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 :|

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list


Re: [libvirt] Missing documentation?

2013-05-07 Thread Joseph Glanville
You might want to make sure you update the website too hehe.

http://libvirt.org/html/libvirt-libvirt.html is still dead. :P

All good mate, mistakes happen.

Joseph.


On Tue, May 7, 2013 at 3:35 AM, Daniel P. Berrange berra...@redhat.comwrote:

 On Tue, May 07, 2013 at 02:38:30AM -0700, Joseph Glanville wrote:
  Fixed the libxml2 errors.
 
  You need to install the DTD into /etc/xml as W3C is now blocking libxml2
  from downloading them, that is what caused the errors I saw.
 
  On debian systems the DTD for XHTML is packaged as w3c-dtd-xhtml
  For RHEL compatible systems I think the correct package is
  html11-dtds
  However docs are still empty. :(

 If you were using libvirt GIT from the past 4 days, then the blank
 APIs docs are my fault. I pushed a fix a few minutes ago, so make
 sure you have this commit in your checkout

   commit 5e7b0e8757112f17ea616beb8d171bcc94a0f9c3
   Author: Daniel P. Berrange berra...@redhat.com
   Date:   Tue May 7 11:18:10 2013 +0100

 Fix namespace bugs in API docs, todo page  hv support page


 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:|

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list

Re: [libvirt] Missing documentation?

2013-05-07 Thread Daniel P. Berrange
On Tue, May 07, 2013 at 03:46:18AM -0700, Joseph Glanville wrote:
 You might want to make sure you update the website too hehe.
 
 http://libvirt.org/html/libvirt-libvirt.html is still dead. :P
 
 All good mate, mistakes happen.

The website automatically refreshes itself from GIT once an hour
via cron job

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 :|

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list


Re: [libvirt] Missing documentation?

2013-05-06 Thread Eric Blake
On 05/05/2013 02:57 AM, Joseph Glanville wrote:
 Hi,
 
 I am playing with libvirt and I noticed the API reference appears to be
 empty, the page in particular is: http://libvirt.org/html/index.html

Yeah, Dan did a refactoring of several web pages recently, and probably
missed something that resulted in killing the content of this page.  I'm
no xml wizard, so I'm hoping Dan can step in soon; but if it is still
broken in 24 hours, I'll try my hand at it (you never know - I might
learn something useful!).

 
 I also tried to build the documentation from git but this also produces
 empty html along with a stream of errors because W3C is blocking access to
 the DTD from the useragent that is used to attempt to download it
 (rightfully so, you don't need to download it more than once)
 
 My guess is that without the DTD the parser being used is borking on
 undefined entities like this:
 csharp.html.in:441: parser error : Entity 'nbsp' not defined
 nbsp;/tdtdnbsp;/tdtdnbsp;/tdtdnbsp;/tdtdnbsp;/tdtdnbsp;
 and as such is no real docs are being produced.
 
 I am not subscribed to the list so please use reply-all (or just cc me)

It's list policy to reply-all anyways :)

-- 
Eric Blake   eblake redhat com+1-919-301-3266
Libvirt virtualization library http://libvirt.org



signature.asc
Description: OpenPGP digital signature
--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list