[libvirt] Question about html file in docs

Hi, I think html files in docs directory are redundunt. It is because html file is created by html.in. May I remove these files? Or are there any reason about staying these files? Thanks Atsushi SAKAI

On Wed, Aug 13, 2008 at 09:56:00AM +0900, Atsushi SAKAI wrote:
Hi,
I think html files in docs directory are redundunt. It is because html file is created by html.in. May I remove these files?
No
Or are there any reason about staying these files?
Because the web site is a CVS checkout of the docs/ subdir Daniel -- Red Hat Virtualization group http://redhat.com/virtualization/ Daniel Veillard | virtualization library http://libvirt.org/ veillard@redhat.com | libxml GNOME XML XSLT toolkit http://xmlsoft.org/ http://veillard.com/ | Rpmfind RPM search engine http://rpmfind.net/

Hi, Daniel If I run the make on libvirt, cvs diff outputs large diffs on html. This is because the difference of html and html.in is large. I think it should be fixed. How do you think? Thanks Atsushi SAKAI Daniel Veillard <veillard@redhat.com> wrote:
On Wed, Aug 13, 2008 at 09:56:00AM +0900, Atsushi SAKAI wrote:
Hi,
I think html files in docs directory are redundunt. It is because html file is created by html.in. May I remove these files?
No
Or are there any reason about staying these files?
Because the web site is a CVS checkout of the docs/ subdir
Daniel
-- Red Hat Virtualization group http://redhat.com/virtualization/ Daniel Veillard | virtualization library http://libvirt.org/ veillard@redhat.com | libxml GNOME XML XSLT toolkit http://xmlsoft.org/ http://veillard.com/ | Rpmfind RPM search engine http://rpmfind.net/

On Wed, Aug 13, 2008 at 04:37:27PM +0900, Atsushi SAKAI wrote:
Hi, Daniel
If I run the make on libvirt, cvs diff outputs large diffs on html. This is because the difference of html and html.in is large.
What kind of diff do you get ? The html output should only be dependant on the html.in and the .xsl stylesheets
I think it should be fixed.
One should see changes in .html only if the .in and .xsl changed so: 1/ you should not have any rebuild done on your CVS checkout unless you have timestamp problems on the checkout box 2/ if it were to be rebuilt it really should be the same as on the checkout So there is at least 2 problems on your checkouts, I wonder why Daniel -- Red Hat Virtualization group http://redhat.com/virtualization/ Daniel Veillard | virtualization library http://libvirt.org/ veillard@redhat.com | libxml GNOME XML XSLT toolkit http://xmlsoft.org/ http://veillard.com/ | Rpmfind RPM search engine http://rpmfind.net/

On Wed, Aug 13, 2008 at 05:51:25AM -0400, Daniel Veillard wrote:
On Wed, Aug 13, 2008 at 04:37:27PM +0900, Atsushi SAKAI wrote:
Hi, Daniel
If I run the make on libvirt, cvs diff outputs large diffs on html. This is because the difference of html and html.in is large.
We investigated a bit with Chris Lalancette who is seeing the same problem
What kind of diff do you get ? The html output should only be dependant on the html.in and the .xsl stylesheets
Well apparently the XSL output is post-processed by xmlling --valid --format which then introduce a dependancy on the XHTML1 DTDs . If you don't have them installed locally you will get validation error messages when building in docs and the output will diverge. The simplest solution for you is probably to make sure you have XHTML1 DTDs installed in your local XML catalog, which on RHEL/Fedora is as simple as having the package xhtml1-dtds installed on your machine(s).
I think it should be fixed.
One should see changes in .html only if the .in and .xsl changed so: 1/ you should not have any rebuild done on your CVS checkout unless you have timestamp problems on the checkout box
That is still a problem, I see some files being rebuilt on a fresh checkout there is some timestamp problems in CVS state I guess.
2/ if it were to be rebuilt it really should be the same as on the checkout
unfortunately no because xsltproc output is post processed, Daniel -- Red Hat Virtualization group http://redhat.com/virtualization/ Daniel Veillard | virtualization library http://libvirt.org/ veillard@redhat.com | libxml GNOME XML XSLT toolkit http://xmlsoft.org/ http://veillard.com/ | Rpmfind RPM search engine http://rpmfind.net/

On Wed, Aug 13, 2008 at 08:10:36AM -0400, Daniel Veillard wrote:
Well apparently the XSL output is post-processed by xmlling --valid --format which then introduce a dependancy on the XHTML1 DTDs . If you don't have them installed locally you will get validation error messages when building in docs and the output will diverge.
The simplest solution for you is probably to make sure you have XHTML1 DTDs installed in your local XML catalog, which on RHEL/Fedora is as simple as having the package xhtml1-dtds installed on your machine(s).
The patch enclosed adds detection for the XHTML1 dtds at runtime on the build machine, and should solve the problem of diverging docs, replace the XML validity warnings by a more general message and add the requirement when building the RPM. I guess this should solve the issue Daniel -- Red Hat Virtualization group http://redhat.com/virtualization/ Daniel Veillard | virtualization library http://libvirt.org/ veillard@redhat.com | libxml GNOME XML XSLT toolkit http://xmlsoft.org/ http://veillard.com/ | Rpmfind RPM search engine http://rpmfind.net/

Daniel Veillard wrote:
On Wed, Aug 13, 2008 at 08:10:36AM -0400, Daniel Veillard wrote:
Well apparently the XSL output is post-processed by xmlling --valid --format which then introduce a dependancy on the XHTML1 DTDs . If you don't have them installed locally you will get validation error messages when building in docs and the output will diverge.
The simplest solution for you is probably to make sure you have XHTML1 DTDs installed in your local XML catalog, which on RHEL/Fedora is as simple as having the package xhtml1-dtds installed on your machine(s).
The patch enclosed adds detection for the XHTML1 dtds at runtime on the build machine, and should solve the problem of diverging docs, replace the XML validity warnings by a more general message and add the requirement when building the RPM. I guess this should solve the issue
Yes, that did it for me. I like the warning message too; at least that gives someone a fighting chance of figuring out what to install if they do want to generate the docs for some reason. +1 Chris Lalancette

On Wed, Aug 13, 2008 at 03:50:10PM +0200, Chris Lalancette wrote:
Daniel Veillard wrote:
On Wed, Aug 13, 2008 at 08:10:36AM -0400, Daniel Veillard wrote:
Well apparently the XSL output is post-processed by xmlling --valid --format which then introduce a dependancy on the XHTML1 DTDs . If you don't have them installed locally you will get validation error messages when building in docs and the output will diverge.
The simplest solution for you is probably to make sure you have XHTML1 DTDs installed in your local XML catalog, which on RHEL/Fedora is as simple as having the package xhtml1-dtds installed on your machine(s).
The patch enclosed adds detection for the XHTML1 dtds at runtime on the build machine, and should solve the problem of diverging docs, replace the XML validity warnings by a more general message and add the requirement when building the RPM. I guess this should solve the issue
Yes, that did it for me. I like the warning message too; at least that gives someone a fighting chance of figuring out what to install if they do want to generate the docs for some reason.
Okay, that's far from perfect but better than the status quo, so commited ! thanks, Daniel -- Red Hat Virtualization group http://redhat.com/virtualization/ Daniel Veillard | virtualization library http://libvirt.org/ veillard@redhat.com | libxml GNOME XML XSLT toolkit http://xmlsoft.org/ http://veillard.com/ | Rpmfind RPM search engine http://rpmfind.net/

Hi, Daniel I need to set http_proxy on my environment. (Sorry, since I need not set http_proxy since I use wget and cvs only) But still stays large diffs on html 6 files. drvqemu.html formatnetwork.html formatstorage.html intro.html news.html remote.html Thanks Atsushi SAKAI Daniel Veillard <veillard@redhat.com> wrote:
On Wed, Aug 13, 2008 at 08:10:36AM -0400, Daniel Veillard wrote:
Well apparently the XSL output is post-processed by xmlling --valid --format which then introduce a dependancy on the XHTML1 DTDs . If you don't have them installed locally you will get validation error messages when building in docs and the output will diverge.
The simplest solution for you is probably to make sure you have XHTML1 DTDs installed in your local XML catalog, which on RHEL/Fedora is as simple as having the package xhtml1-dtds installed on your machine(s).
The patch enclosed adds detection for the XHTML1 dtds at runtime on the build machine, and should solve the problem of diverging docs, replace the XML validity warnings by a more general message and add the requirement when building the RPM. I guess this should solve the issue
Daniel
-- Red Hat Virtualization group http://redhat.com/virtualization/ Daniel Veillard | virtualization library http://libvirt.org/ veillard@redhat.com | libxml GNOME XML XSLT toolkit http://xmlsoft.org/ http://veillard.com/ | Rpmfind RPM search engine http://rpmfind.net/

On Wed, Aug 13, 2008 at 03:34:33AM -0400, Daniel Veillard wrote:
On Wed, Aug 13, 2008 at 09:56:00AM +0900, Atsushi SAKAI wrote:
Hi,
I think html files in docs directory are redundunt. It is because html file is created by html.in. May I remove these files?
No
Or are there any reason about staying these files?
Because the web site is a CVS checkout of the docs/ subdir
Could the cron script which updates the CVS checkout simply run 'make' in the docs/ directory ? It already has to run a couple of scripts to re-generate the NEWS & ChangeLog.html files on every checkout Daniel -- |: Red Hat, Engineering, London -o- http://people.redhat.com/berrange/ :| |: http://libvirt.org -o- http://virt-manager.org -o- http://ovirt.org :| |: http://autobuild.org -o- http://search.cpan.org/~danberr/ :| |: GnuPG: 7D3B9505 -o- F3C9 553F A1DA 4AC2 5648 23C1 B3DF F742 7D3B 9505 :|

On Wed, Aug 13, 2008 at 09:35:04AM +0100, Daniel P. Berrange wrote:
On Wed, Aug 13, 2008 at 03:34:33AM -0400, Daniel Veillard wrote:
On Wed, Aug 13, 2008 at 09:56:00AM +0900, Atsushi SAKAI wrote:
Hi,
I think html files in docs directory are redundunt. It is because html file is created by html.in. May I remove these files?
No
Or are there any reason about staying these files?
Because the web site is a CVS checkout of the docs/ subdir
Could the cron script which updates the CVS checkout simply run 'make' in the docs/ directory ? It already has to run a couple of scripts to re-generate the NEWS & ChangeLog.html files on every checkout
Well I dislike the idea that the correctness of the website is dependant on the ability to rebuild libvirt on the box, this is RHEL4, autogen/configure may fail, NEWS and ChangeLog.html are not crucial, but I would like to be sure the site content stay okay even in case of troubles on the box. And really Atsushi should not see diffs like this, Daniel -- Red Hat Virtualization group http://redhat.com/virtualization/ Daniel Veillard | virtualization library http://libvirt.org/ veillard@redhat.com | libxml GNOME XML XSLT toolkit http://xmlsoft.org/ http://veillard.com/ | Rpmfind RPM search engine http://rpmfind.net/
participants (4)
-
Atsushi SAKAI
-
Chris Lalancette
-
Daniel P. Berrange
-
Daniel Veillard