factor out gtk-doc

Original commit message from CVS:
factor out gtk-doc
This commit is contained in:
Thomas Vander Stichele 2005-07-07 14:16:40 +00:00
parent adf701a8cc
commit adc8fa1df5
20 changed files with 26 additions and 277 deletions

View file

@ -1,3 +1,10 @@
2005-07-07 Thomas Vander Stichele <thomas at apestaart dot org>
* common/Makefile.am:
* common/gtk-doc.mak:
* docs/gst/Makefile.am:
factor out gtk-doc.mak
2005-07-07 Wim Taymans <wim@fluendo.com>
* gst/schedulers/threadscheduler.c: (gst_thread_scheduler_func),

2
common

@ -1 +1 @@
Subproject commit 4ca96aedcf2be0b3dcf31fce732aed1da21b8850
Subproject commit c40d6ab2d62f885c52650db2438e099d3f369f8f

View file

@ -115,262 +115,4 @@ GTKDOC_LD=$(LIBTOOL) --mode=link $(CC)
# and uncomment this line.
DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt
###########################################################################
# Everything below here is generic and you shouldn't need to change it.
###########################################################################
# thomas: except of course that we did
# thomas: copied from glib-2
# We set GPATH here; this gives us semantics for GNU make
# which are more like other make's VPATH, when it comes to
# whether a source that is a target of one rule is then
# searched for in VPATH/GPATH.
#
GPATH = $(srcdir)
# thomas: make docs parallel installable
TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@
EXTRA_DIST = \
$(content_files) \
$(extra_files) \
$(HTML_IMAGES) \
$(DOC_MAIN_SGML_FILE) \
$(DOC_MODULE).types \
$(DOC_OVERRIDES) \
$(DOC_MODULE)-sections.txt
DOC_STAMPS = \
scan-build.stamp \
tmpl-build.stamp \
sgml-build.stamp \
html-build.stamp \
$(srcdir)/tmpl.stamp \
$(srcdir)/sgml.stamp \
$(srcdir)/html.stamp
SCANOBJ_FILES = \
$(DOC_MODULE).args \
$(DOC_MODULE).hierarchy \
$(DOC_MODULE).interfaces \
$(DOC_MODULE).prerequisites \
.libs/$(DOC_MODULE)-scan.o \
$(DOC_MODULE).signals
CLEANFILES = $(SCANOBJ_FILES) $(DOC_MODULE)-unused.txt $(DOC_STAMPS)
if HAVE_GTK_DOC
all-local: html-build.stamp
#### scan ####
# in the case of non-srcdir builds, the built gst directory gets added
# to gtk-doc scanning; but only then, to avoid duplicates
scan-build.stamp: $(HFILE_GLOB) $(SCANOBJ_DEPS) $(basefiles)
@echo '*** Scanning header files ***'
if grep -l '^..*$$' $(srcdir)/$(DOC_MODULE).types > /dev/null; \
then \
if test x"$(srcdir)" != x. ; then \
cp $(srcdir)/$(DOC_MODULE).types . ; \
chmod u+w $(DOC_MODULE).types ; \
fi ; \
GST_PLUGIN_PATH=`cd $(top_builddir) && pwd` \
GST_PLUGIN_PATH_ONLY=1 \
CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" \
CFLAGS="$(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)" \
$(GTK_DOC_SCANOBJ) --type-init-func="gst_init(NULL,NULL)" \
--module=$(DOC_MODULE) ; \
else \
cd $(srcdir) ; \
for i in $(SCANOBJ_FILES) ; do \
test -f $$i || touch $$i ; \
done \
fi
if test "x$(top_srcdir)" != "x$(top_builddir)"; \
then \
export BUILT_OPTIONS="--source-dir=$(top_builddir)/gst"; \
fi; \
gtkdoc-scan \
$(SCAN_OPTIONS) $(EXTRA_HFILES) \
--module=$(DOC_MODULE) \
--source-dir=$(DOC_SOURCE_DIR) \
$$BUILT_OPTIONS \
--ignore-headers="$(IGNORE_HFILES)"
touch scan-build.stamp
$(DOC_MODULE)-decl.txt $(SCANOBJ_FILES): scan-build.stamp
@true
#### templates ####
### FIXME: make this error out again when docs are fixed for 0.9
tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_OVERRIDES)
@echo '*** Rebuilding template files ***'
if test x"$(srcdir)" != x. ; then \
cp $(srcdir)/$(DOC_MODULE)-sections.txt . ; \
touch $(DOC_MODULE)-decl.txt ; \
fi
gtkdoc-mktmpl --module=$(DOC_MODULE) | tee tmpl-build.log
@cat $(DOC_MODULE)-unused.txt
@if ! test -z "`grep -v GstPoptOption gstreamer-unused.txt`"; then \
true; fi # exit 1; fi
rm -f tmpl-build.log
touch tmpl-build.stamp
tmpl.stamp: tmpl-build.stamp
@true
#### xml ####
### FIXME: make this error out again when docs are fixed for 0.9
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
@if grep "WARNING:" sgml-build.log > /dev/null; then true; fi # exit 1; fi
rm sgml-build.log
touch sgml-build.stamp
sgml.stamp: sgml-build.stamp
@true
#### html ####
# FIXME: setting LANG=C is a hack to work with gtk-doc < 1.1, because
# that forces a non-utf8 locale. gtk-doc >= 1.1 solves this by calling
# use bytes; in gtkdoc-fixxref
html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
@echo '*** Building HTML ***'
if test -d html; then rm -rf html; fi
mkdir html
cp $(srcdir)/$(DOC_MAIN_SGML_FILE) html
cp -pr xml html
cp ../version.entities html
cd html && gtkdoc-mkhtml $(DOC_MODULE) $(DOC_MAIN_SGML_FILE)
rm -f html/$(DOC_MAIN_SGML_FILE)
rm -rf html/xml
rm -f html/version.entities
test "x$(HTML_IMAGES)" = "x" || for i in "" $(HTML_IMAGES) ; do \
if test "$$i" != ""; then cp $(srcdir)/$$i html ; fi; done
@echo '-- Fixing Crossreferences'
LANG=C && gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
touch html-build.stamp
else
all-local:
endif
clean-local:
rm -f *~ *.bak
rm -rf xml html
rm -rf .libs
maintainer-clean-local: clean
cd $(srcdir) && rm -rf xml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
# company: don't delete .sgml and -sections.txt as they're in CVS
# FIXME : thomas added all sgml files and some other things to make
# make distcheck work
distclean-local: clean
rm -f $(DOC_MODULE)-decl-list.txt
rm -f $(DOC_MODULE)-decl.txt
rm -f $(DOC_MODULE)-undocumented.txt
rm -f $(DOC_MODULE)-unused.txt
rm -rf tmpl/*.sgml.bak
rm -f $(DOC_MODULE).hierarchy
rm -f *.stamp || true
if test x"$(srcdir)" != x. ; then \
rm -f $(DOC_MODULE)-docs.sgml ; \
rm -f $(DOC_MODULE).types ; \
rm -f $(DOC_MODULE).interfaces ; \
rm -f $(DOC_MODULE)-overrides.txt ; \
rm -f $(DOC_MODULE).prerequisites ; \
rm -f $(DOC_MODULE)-sections.txt ; \
rm -rf tmpl/*.sgml ; \
fi
rm -rf *.o
# thomas: make docs parallel installable; devhelp requires majorminor too
install-data-local:
$(mkinstalldirs) $(DESTDIR)$(TARGET_DIR)
(installfiles=`echo ./html/*.html`; \
if test "$$installfiles" = './html/*.html'; \
then echo '-- Nothing to install' ; \
else \
for i in $$installfiles; do \
echo '-- Installing '$$i ; \
$(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
done; \
pngfiles=`echo ./html/*.png`; \
if test "$$pngfiles" != './html/*.png'; then \
for i in $$pngfiles; do \
echo '-- Installing '$$i ; \
$(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
done; \
fi; \
echo '-- Installing $(srcdir)/html/$(DOC_MODULE).devhelp' ; \
$(INSTALL_DATA) $(srcdir)/html/$(DOC_MODULE).devhelp \
$(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@.devhelp; \
echo '-- Installing $(srcdir)/html/index.sgml' ; \
$(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR); \
if test -e $(srcdir)/html/style.css; then \
echo '-- Installing $(srcdir)/html/style.css' ; \
$(INSTALL_DATA) $(srcdir)/html/style.css $(DESTDIR)$(TARGET_DIR); \
fi; \
fi)
uninstall-local:
(installfiles=`echo ./html/*.html`; \
if test "$$installfiles" = './html/*.html'; \
then echo '-- Nothing to uninstall' ; \
else \
for i in $$installfiles; do \
rmfile=`basename $$i` ; \
echo '-- Uninstalling $(DESTDIR)$(TARGET_DIR)/'$$rmfile ; \
rm -f $(DESTDIR)$(TARGET_DIR)/$$rmfile; \
done; \
pngfiles=`echo ./html/*.png`; \
if test "$$pngfiles" != './html/*.png'; then \
for i in $$pngfiles; do \
rmfile=`basename $$i` ; \
echo '-- Uninstalling $(DESTDIR)$(TARGET_DIR)/'$$rmfile ; \
rm -f $(DESTDIR)$(TARGET_DIR)/$$rmfile; \
done; \
fi; \
echo '-- Uninstalling $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE).devhelp' ; \
rm -f $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@.devhelp; \
echo '-- Uninstalling $(DESTDIR)$(TARGET_DIR)/index.sgml' ; \
rm -f $(DESTDIR)$(TARGET_DIR)/index.sgml; \
if test -e $(DESTDIR)$(TARGET_DIR)/style.css; then \
echo '-- Uninstalling $(DESTDIR)$(TARGET_DIR)/style.css' ; \
rm -f $(DESTDIR)$(TARGET_DIR)/style.css; \
fi; \
fi)
if test -d $(DESTDIR)$(TARGET_DIR); then rmdir -p --ignore-fail-on-non-empty $(DESTDIR)$(TARGET_DIR) 2>/dev/null; fi; true
#
# Require gtk-doc when making dist
#
if HAVE_GTK_DOC
dist-check-gtkdoc:
else
dist-check-gtkdoc:
@echo "*** gtk-doc must be installed and enabled in order to make dist"
@false
endif
dist-hook: dist-check-gtkdoc dist-hook-local
mkdir $(distdir)/tmpl
mkdir $(distdir)/xml
mkdir $(distdir)/html
-cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl
-cp $(srcdir)/sgml/*.xml $(distdir)/xml
-cp $(srcdir)/html/index.sgml $(distdir)/html
-cp $(srcdir)/html/*.html $(srcdir)/html/*.css $(distdir)/html
-cp $(srcdir)/html/gstreamer.devhelp $(distdir)/html
images=$(HTML_IMAGES) ; \
for i in "" $$images ; do \
if test "$$i" != ""; then cp $(srcdir)/$$i $(distdir)/html ; fi; \
done
.PHONY : dist-hook-local
include $(top_srcdir)/common/gtk-doc.mak

View file

@ -7,7 +7,7 @@ msgid ""
msgstr ""
"Project-Id-Version: gstreamer 0.8.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2005-07-05 16:52+0200\n"
"POT-Creation-Date: 2005-07-07 12:59+0200\n"
"PO-Revision-Date: 2004-03-24 11:28+0200\n"
"Last-Translator: Petri Jooste <rkwjpj@puk.ac.za>\n"
"Language-Team: Afrikaans <i18n@af.org.za>\n"

View file

@ -7,7 +7,7 @@ msgid ""
msgstr ""
"Project-Id-Version: gstreamer-0.8.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2005-07-05 16:52+0200\n"
"POT-Creation-Date: 2005-07-07 12:59+0200\n"
"PO-Revision-Date: 2004-03-19 18:40+0200\n"
"Last-Translator: Metin Amiroff <metin@karegen.com>\n"
"Language-Team: Azerbaijani <translation-team-az@lists.sourceforge.net>\n"

View file

@ -7,7 +7,7 @@ msgid ""
msgstr ""
"Project-Id-Version: gstreamer 0.8.7pre2\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2005-07-05 16:52+0200\n"
"POT-Creation-Date: 2005-07-07 12:59+0200\n"
"PO-Revision-Date: 2004-12-22 17:44+0100\n"
"Last-Translator: Jordi Mallach <jordi@sindominio.net>\n"
"Language-Team: Catalan <ca@dodds.net>\n"

View file

@ -8,7 +8,7 @@ msgid ""
msgstr ""
"Project-Id-Version: gstreamer 0.8.7pre2\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2005-07-05 16:52+0200\n"
"POT-Creation-Date: 2005-07-07 12:59+0200\n"
"PO-Revision-Date: 2004-12-27 17:23+0100\n"
"Last-Translator: Miloslav Trmac <mitr@volny.cz>\n"
"Language-Team: Czech <translation-team-cs@lists.sourceforge.net>\n"

View file

@ -7,7 +7,7 @@ msgid ""
msgstr ""
"Project-Id-Version: gstreamer 0.8.1\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2005-07-05 16:52+0200\n"
"POT-Creation-Date: 2005-07-07 12:59+0200\n"
"PO-Revision-Date: 2004-06-05 09:32+0100\n"
"Last-Translator: Roland Illig <roland.illig@gmx.de>\n"
"Language-Team: German <de@li.org>\n"

View file

@ -6,7 +6,7 @@ msgid ""
msgstr ""
"Project-Id-Version: gstreamer 0.8.1\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2005-07-05 16:52+0200\n"
"POT-Creation-Date: 2005-07-07 12:59+0200\n"
"PO-Revision-Date: 2004-04-26 10:36-0400\n"
"Last-Translator: Gareth Owen <gowen72@yahoo.com>\n"
"Language-Team: English (British) <en_gb@li.org>\n"

View file

@ -7,7 +7,7 @@ msgid ""
msgstr ""
"Project-Id-Version: GStreamer\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2005-07-05 16:52+0200\n"
"POT-Creation-Date: 2005-07-07 12:59+0200\n"
"PO-Revision-Date: 2004-01-13 16:52+0100\n"
"Last-Translator: Julien Moutte <julien@moutte.net>\n"
"Language-Team: French <fr@li.org>\n"

View file

@ -108,7 +108,7 @@ msgid ""
msgstr ""
"Project-Id-Version: gstreamer 0.8.7pre2\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2005-07-05 16:52+0200\n"
"POT-Creation-Date: 2005-07-07 12:59+0200\n"
"PO-Revision-Date: 2004-12-21 08:23+0100\n"
"Last-Translator: Luca Ferretti <elle.uca@infinito.it>\n"
"Language-Team: Italian <tp@lists.linux.it>\n"

View file

@ -6,7 +6,7 @@ msgid ""
msgstr ""
"Project-Id-Version: gstreamer 0.8.8\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2005-07-05 16:52+0200\n"
"POT-Creation-Date: 2005-07-07 12:59+0200\n"
"PO-Revision-Date: 2005-02-17 12:00+0100\n"
"Last-Translator: Kjartan Maraas <kmaraas@broadpark.no>\n"
"Language-Team: Norwegian Bokmaal <i18n-nb@lister.ping.uio.no>\n"

View file

@ -7,7 +7,7 @@ msgid ""
msgstr ""
"Project-Id-Version: GStreamer\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2005-07-05 16:52+0200\n"
"POT-Creation-Date: 2005-07-07 12:59+0200\n"
"PO-Revision-Date: 2004-01-13 12:03+0100\n"
"Last-Translator: Thomas Vander Stichele <thomas@apestaart.org>\n"
"Language-Team: Dutch <nl@li.org>\n"

View file

@ -7,7 +7,7 @@ msgid ""
msgstr ""
"Project-Id-Version: gstreamer 0.8.8\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2005-07-05 16:52+0200\n"
"POT-Creation-Date: 2005-07-07 12:59+0200\n"
"PO-Revision-Date: 2005-02-12 23:37+0300\n"
"Last-Translator: Peter Astakhov <astakhovp@mail.ru>\n"
"Language-Team: Russian <ru@li.org>\n"

View file

@ -6,7 +6,7 @@ msgid ""
msgstr ""
"Project-Id-Version: gstreamer 0.8.4\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2005-07-05 16:52+0200\n"
"POT-Creation-Date: 2005-07-07 12:59+0200\n"
"PO-Revision-Date: 2004-08-07 23:46+0200\n"
"Last-Translator: Laurent Dhima <laurenti@alblinux.net>\n"
"Language-Team: Albanian <begraj@hotmail.com>\n"

View file

@ -6,7 +6,7 @@ msgid ""
msgstr ""
"Project-Id-Version: gstreamer 0.7.6\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2005-07-05 16:52+0200\n"
"POT-Creation-Date: 2005-07-07 12:59+0200\n"
"PO-Revision-Date: 2004-03-13 01:47+0100\n"
"Last-Translator: Danilo Segan <dsegan@gmx.net>\n"
"Language-Team: Serbian <gnu@prevod.org>\n"

View file

@ -8,7 +8,7 @@ msgid ""
msgstr ""
"Project-Id-Version: gstreamer 0.8.7pre2\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2005-07-05 16:52+0200\n"
"POT-Creation-Date: 2005-07-07 12:59+0200\n"
"PO-Revision-Date: 2004-12-21 14:49+0100\n"
"Last-Translator: Christian Rose <menthos@menthos.com>\n"
"Language-Team: Swedish <sv@li.org>\n"

View file

@ -6,7 +6,7 @@ msgid ""
msgstr ""
"Project-Id-Version: gstreamer 0.8.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2005-07-05 16:52+0200\n"
"POT-Creation-Date: 2005-07-07 12:59+0200\n"
"PO-Revision-Date: 2004-04-03 03:14+0300\n"
"Last-Translator: Baris Cicek <baris@teamforce.name.tr>\n"
"Language-Team: Turkish <gnu-tr-u12a@lists.sourceforge.net>\n"

View file

@ -7,7 +7,7 @@ msgid ""
msgstr ""
"Project-Id-Version: gstreamer 0.8.3\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2005-07-05 16:52+0200\n"
"POT-Creation-Date: 2005-07-07 12:59+0200\n"
"PO-Revision-Date: 2004-08-03 10:53+0200\n"
"Last-Translator: Maxim V. Dziumanenko <mvd@mylinux.com.ua>\n"
"Language-Team: Ukrainian <translation-team-uk@lists.sourceforge.net>\n"

View file

@ -6,7 +6,7 @@ msgid ""
msgstr ""
"Project-Id-Version: gstreamer 0.8.8\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2005-07-05 16:52+0200\n"
"POT-Creation-Date: 2005-07-07 12:59+0200\n"
"PO-Revision-Date: 2005-02-05 16:35+1030\n"
"Last-Translator: Clytie Siddall <clytie@riverland.net.au>\n"
"Language-Team: Vietnamese <gnomevi-list@lists.sourceforge.net> \n"