gtk-doc/: As our docs are versioned, we need to patch the index.sgml file to have...

Original commit message from CVS:
* gtk-doc-plugins.mak:
* gtk-doc.mak:
As our docs are versioned, we need to patch the index.sgml file to have
correct paths there, unless we also want to fork gtk-doc's xsl (which
we don't). This hopefully fixes xrefs between modules.

diff --git a/ChangeLog b/ChangeLog
index 55489aa..3b1bdbc 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,11 @@
+2008-02-06  Stefan Kost  <ensonic@users.sf.net>
+
+       * gtk-doc-plugins.mak:
+       * gtk-doc.mak:
+        As our docs are versioned, we need to patch the index.sgml file to have
+        correct paths there, unless we also want to fork gtk-doc's xsl (which
+        we don't). This hopefully fixes xrefs between modules.
+
 2008-02-02  Sebastian Dröge  <slomo@circular-chaos.org>
 
        * m4/gst-feature.m4:

diff --git a/gtk-doc-plugins.mak b/gtk-doc-plugins.mak
index 2f80db1..b566651 100644 (file)
--- a/gtk-doc-plugins.mak
+++ b/gtk-doc-plugins.mak
@@ -141,7 +141,7 @@ inspect-update: inspect
        $(MAKE) inspect-build.stamp
 
 # FIXME: inspect.stamp should be written to by gst-xmlinspect.py
-# IFF the output changed; see gtkdoc-mktmpl
+# IF the output changed; see gtkdoc-mktmpl
 inspect-build.stamp:
        @echo '*** Rebuilding plugin inspection files ***'
        if test x"$(srcdir)" != x. ; then \
@@ -233,6 +233,7 @@ html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
        @if grep "warning:" html-build.log > /dev/null; then \
                echo "ERROR"; grep "warning:" html-build.log; exit 1; fi
        @rm html-build.log
+       sed -i "s/ href=\"$(DOC_MODULE)\// href=\"$(DOC_MODULE)-@GST_MAJORMINOR@\//g" html/index.sgml
        rm -f html/$(DOC_MAIN_SGML_FILE)
        rm -rf html/xml
        rm -f html/version.entities

diff --git a/gtk-doc.mak b/gtk-doc.mak
index 34e4611..7aae8ab 100644 (file)
--- a/gtk-doc.mak
+++ b/gtk-doc.mak
@@ -108,7 +108,7 @@ tmpl.stamp: tmpl-build.stamp
 
 #### xml ####
 
-### FIXME: make this error out again when docs are fixed for 0.9
+### FIXME: make this error out again when docs are complete
 sgml-build.stamp: tmpl.stamp $(CFILE_GLOB)
        @echo '*** Building XML ***'
        gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --main-sgml-file=$(srcdir)/$(DOC_MAIN_SGML_FILE) --output-format=xml $(MKDB_OPTIONS) | tee sgml-build.log
@@ -130,6 +130,7 @@ html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
        cp -pr xml html
        cp ../version.entities html
        cd html && gtkdoc-mkhtml $(DOC_MODULE) $(DOC_MAIN_SGML_FILE)
+       sed -i "s/ href=\"$(DOC_MODULE)\// href=\"$(DOC_MODULE)-@GST_MAJORMINOR@\//g" html/index.sgml
        rm -f html/$(DOC_MAIN_SGML_FILE)
        rm -rf html/xml
        rm -f html/version.entities