[libvirt] [PATCH] docs: install the generated html files when make install is run

Previously, only the API docs were installed, rather than the complete documentation set. This commit ensures the complete documentation set is installed. --- docs/Makefile.am | 9 +++++++++ 1 files changed, 9 insertions(+), 0 deletions(-) diff --git a/docs/Makefile.am b/docs/Makefile.am index 27804a2..f1ec2a6 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -26,6 +26,11 @@ devhelphtml = \ devhelp/libvirt-libvirt.html \ devhelp/libvirt-virterror.html +css = \ + generic.css \ + libvirt.css \ + main.css + devhelppng = \ devhelp/home.png \ devhelp/left.png \ @@ -169,6 +174,10 @@ rebuild: api all install-data-local: $(mkinstalldirs) $(DESTDIR)$(HTML_DIR) + for f in $(css) $(dot_html); do \ + $(INSTALL) -m 0644 $(srcdir)/$$f $(DESTDIR)$(HTML_DIR); done + for f in $(gif) $(png); do \ + $(INSTALL) -m 0644 $(srcdir)/$$f $(DESTDIR)$(HTML_DIR); done -$(INSTALL) -m 0644 $(srcdir)/Libxml2-Logo-90x34.gif $(DESTDIR)$(HTML_DIR) $(mkinstalldirs) $(DESTDIR)$(HTML_DIR)/html for h in $(apihtml); do \ -- 1.7.2.3

On 10/24/2010 07:46 PM, Justin Clift wrote:
Previously, only the API docs were installed, rather than the complete documentation set. This commit ensures the complete documentation set is installed. <snip>
Please ignore this first version of the patch. The *.css files weren't being included in the "make dist" generated tarball. The next version of this patch (v2) also includes an addition to the EXTRA_DIST line, so everything needed is in the tarball.

Previously, only the API docs were installed, rather than the complete documentation set. This commit ensures the complete documentation set is installed. --- docs/Makefile.am | 11 ++++++++++- 1 files changed, 10 insertions(+), 1 deletions(-) diff --git a/docs/Makefile.am b/docs/Makefile.am index 27804a2..7a74753 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -26,6 +26,11 @@ devhelphtml = \ devhelp/libvirt-libvirt.html \ devhelp/libvirt-virterror.html +css = \ + generic.css \ + libvirt.css \ + main.css + devhelppng = \ devhelp/home.png \ devhelp/left.png \ @@ -76,7 +81,7 @@ EXTRA_DIST= \ site.xsl newapi.xsl news.xsl page.xsl \ $(dot_html) $(dot_html_in) $(gif) $(apihtml) $(apipng) \ $(devhelphtml) $(devhelppng) $(devhelpcss) $(devhelpxsl) \ - $(xml) $(fig) $(png) \ + $(xml) $(fig) $(png) $(css) \ $(patches) \ sitemap.html.in \ todo.pl todo.cfg-example @@ -169,6 +174,10 @@ rebuild: api all install-data-local: $(mkinstalldirs) $(DESTDIR)$(HTML_DIR) + for f in $(css) $(dot_html); do \ + $(INSTALL) -m 0644 $(srcdir)/$$f $(DESTDIR)$(HTML_DIR); done + for f in $(gif) $(png); do \ + $(INSTALL) -m 0644 $(srcdir)/$$f $(DESTDIR)$(HTML_DIR); done -$(INSTALL) -m 0644 $(srcdir)/Libxml2-Logo-90x34.gif $(DESTDIR)$(HTML_DIR) $(mkinstalldirs) $(DESTDIR)$(HTML_DIR)/html for h in $(apihtml); do \ -- 1.7.2.3

On 10/24/2010 03:34 AM, Justin Clift wrote:
Previously, only the API docs were installed, rather than the complete documentation set. This commit ensures the complete documentation set is installed. --- docs/Makefile.am | 11 ++++++++++- 1 files changed, 10 insertions(+), 1 deletions(-)
@@ -169,6 +174,10 @@ rebuild: api all
install-data-local: $(mkinstalldirs) $(DESTDIR)$(HTML_DIR) + for f in $(css) $(dot_html); do \ + $(INSTALL) -m 0644 $(srcdir)/$$f $(DESTDIR)$(HTML_DIR); done + for f in $(gif) $(png); do \ + $(INSTALL) -m 0644 $(srcdir)/$$f $(DESTDIR)$(HTML_DIR); done
Any reason this is done as two for loops instead of one? ACK once you rewrite this as: for f in $(css) $(dot_html) $(gif) $(png); do \ $(INSTALL) -m 0644 $(srcdir)/$$f $(DESTDIR)$(HTML_DIR); done As a side note, recent automake has gone to efforts to speed up installation by using a single install invocation on multiple target files all going to the same directory. Unfortunately, until we can rely on automake 1.11 being a minimum development requirement, I don't know if we can take advantage of any of those speedups, because older install-sh scripts (necessary on systems where install(1) is less-than-stellar) didn't support multiple arguments. For reference, here's the automake NEWS snippet: - The targets `install' and `uninstall' are more efficient now, in that for example multiple files from one Automake variable such as `bin_SCRIPTS' are copied in one `install' (or `libtool --mode=install') invocation if they do not have to be renamed. -- Eric Blake eblake@redhat.com +1-801-349-2682 Libvirt virtualization library http://libvirt.org

On Mon, Oct 25, 2010 at 03:30:49PM -0600, Eric Blake wrote:
On 10/24/2010 03:34 AM, Justin Clift wrote:
Previously, only the API docs were installed, rather than the complete documentation set. This commit ensures the complete documentation set is installed. --- docs/Makefile.am | 11 ++++++++++- 1 files changed, 10 insertions(+), 1 deletions(-)
@@ -169,6 +174,10 @@ rebuild: api all
install-data-local: $(mkinstalldirs) $(DESTDIR)$(HTML_DIR) + for f in $(css) $(dot_html); do \ + $(INSTALL) -m 0644 $(srcdir)/$$f $(DESTDIR)$(HTML_DIR); done + for f in $(gif) $(png); do \ + $(INSTALL) -m 0644 $(srcdir)/$$f $(DESTDIR)$(HTML_DIR); done
Any reason this is done as two for loops instead of one?
ACK once you rewrite this as:
for f in $(css) $(dot_html) $(gif) $(png); do \ $(INSTALL) -m 0644 $(srcdir)/$$f $(DESTDIR)$(HTML_DIR); done
ACK too, but I smell something missing as I don't see any reference to those specific css files in the libvirt.spec.in file (only gtk-doc ones seems copied and apparently that's not the same Daniel -- Daniel Veillard | libxml Gnome XML XSLT toolkit http://xmlsoft.org/ daniel@veillard.com | Rpmfind RPM search engine http://rpmfind.net/ http://veillard.com/ | virtualization library http://libvirt.org/

On 10/27/2010 12:43 AM, Daniel Veillard wrote: <snip>
ACK once you rewrite this as:
for f in $(css) $(dot_html) $(gif) $(png); do \ $(INSTALL) -m 0644 $(srcdir)/$$f $(DESTDIR)$(HTML_DIR); done
ACK too, but I smell something missing as I don't see any reference to those specific css files in the libvirt.spec.in file (only gtk-doc ones seems copied and apparently that's not the same
Good thinking, I'd best check that. :)

On 10/26/2010 08:30 AM, Eric Blake wrote:
On 10/24/2010 03:34 AM, Justin Clift wrote:
Previously, only the API docs were installed, rather than the complete documentation set. This commit ensures the complete documentation set is installed. --- docs/Makefile.am | 11 ++++++++++- 1 files changed, 10 insertions(+), 1 deletions(-)
@@ -169,6 +174,10 @@ rebuild: api all
install-data-local: $(mkinstalldirs) $(DESTDIR)$(HTML_DIR) + for f in $(css) $(dot_html); do \ + $(INSTALL) -m 0644 $(srcdir)/$$f $(DESTDIR)$(HTML_DIR); done + for f in $(gif) $(png); do \ + $(INSTALL) -m 0644 $(srcdir)/$$f $(DESTDIR)$(HTML_DIR); done
Any reason this is done as two for loops instead of one?
Needed more coffee, thanks for the catch. :) Pushed, after rewriting as you suggested.
participants (3)
-
Daniel Veillard
-
Eric Blake
-
Justin Clift