Re- set up the gtk-doc system. I'd managed to mutilate it a while back, but now it's fixed. I'll put a copy of the ...
Original commit message from CVS:
Re- set up the gtk-doc system. I'd managed to mutilate it a while back,
but now it's fixed. I'll put a copy of the HTML output somewhere on the
website tonight.
In order to actually generate the docs, you'll have to install all the
DocBook tools, as well as gtk-doc from GNOME cvs. (see
http://developer.gnome.org/arch/doc/tools.html)
Notes (I'll codify these some day):
- Don't believe the Gnome page, always edit the SOURCES when documenting a
given function, never the tmpl file.
- I'll be re-arranging things a lot, but gtk-doc is smart enough to merge
any changes to the tmpl file. However, gtk-doc's merge and CVS's diff are
two entirely separate animals. We should probably have a virtual mutex on
the entire docs/gst/ directory, over and above what CVS does.
- I'm going to try to end up with a book set (docbook terms), where
docs/gst/ is only one book. There'd be another called docs/manual/, and
another docs/plugins/, etc. If you have any comments as to how these
should be done, gstreamer-devel is the place.
2000-02-01 09:16:43 +00:00
|
|
|
## Process this file with automake to produce Makefile.in
|
|
|
|
|
|
2001-12-12 06:08:44 +00:00
|
|
|
# The name of the module, e.g. 'glib'.
|
2003-05-18 15:04:26 +00:00
|
|
|
# DOC_MODULE=gstreamer-@GST_MAJORMINOR@
|
Re- set up the gtk-doc system. I'd managed to mutilate it a while back, but now it's fixed. I'll put a copy of the ...
Original commit message from CVS:
Re- set up the gtk-doc system. I'd managed to mutilate it a while back,
but now it's fixed. I'll put a copy of the HTML output somewhere on the
website tonight.
In order to actually generate the docs, you'll have to install all the
DocBook tools, as well as gtk-doc from GNOME cvs. (see
http://developer.gnome.org/arch/doc/tools.html)
Notes (I'll codify these some day):
- Don't believe the Gnome page, always edit the SOURCES when documenting a
given function, never the tmpl file.
- I'll be re-arranging things a lot, but gtk-doc is smart enough to merge
any changes to the tmpl file. However, gtk-doc's merge and CVS's diff are
two entirely separate animals. We should probably have a virtual mutex on
the entire docs/gst/ directory, over and above what CVS does.
- I'm going to try to end up with a book set (docbook terms), where
docs/gst/ is only one book. There'd be another called docs/manual/, and
another docs/plugins/, etc. If you have any comments as to how these
should be done, gstreamer-devel is the place.
2000-02-01 09:16:43 +00:00
|
|
|
DOC_MODULE=gstreamer
|
|
|
|
|
|
2004-01-28 12:16:51 +00:00
|
|
|
# for upload.mak
|
|
|
|
|
DOC=gstreamer
|
|
|
|
|
FORMATS=html
|
|
|
|
|
html: html-build.stamp
|
|
|
|
|
sinclude $(srcdir)/../upload.mak
|
|
|
|
|
|
2003-05-18 15:04:26 +00:00
|
|
|
# generated basefiles
|
|
|
|
|
#basefiles = \
|
|
|
|
|
# gstreamer-@GST_MAJORMINOR@.types \
|
|
|
|
|
# gstreamer-@GST_MAJORMINOR@-sections.txt \
|
|
|
|
|
# gstreamer-@GST_MAJORMINOR@-docs.sgml
|
|
|
|
|
|
|
|
|
|
# ugly hack to make -unused.sgml work
|
|
|
|
|
#unused-build.stamp:
|
|
|
|
|
# BUILDDIR=`pwd` && \
|
|
|
|
|
# cd $(srcdir)/tmpl && \
|
|
|
|
|
# ln -sf gstreamer-unused.sgml \
|
|
|
|
|
# $$BUILDDIR/tmpl/gstreamer-@GST_MAJORMINOR@-unused.sgml
|
|
|
|
|
# touch unused-build.stamp
|
|
|
|
|
|
|
|
|
|
# these rules are added to create parallel docs using GST_MAJORMINOR
|
|
|
|
|
#$(basefiles): gstreamer-@GST_MAJORMINOR@%: gstreamer%
|
|
|
|
|
# cp $< $@
|
|
|
|
|
|
|
|
|
|
#CLEANFILES = $(basefiles)
|
|
|
|
|
|
2001-12-12 06:08:44 +00:00
|
|
|
# The top-level SGML file. Change it if you want.
|
2001-01-01 14:06:25 +00:00
|
|
|
DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
|
Re- set up the gtk-doc system. I'd managed to mutilate it a while back, but now it's fixed. I'll put a copy of the ...
Original commit message from CVS:
Re- set up the gtk-doc system. I'd managed to mutilate it a while back,
but now it's fixed. I'll put a copy of the HTML output somewhere on the
website tonight.
In order to actually generate the docs, you'll have to install all the
DocBook tools, as well as gtk-doc from GNOME cvs. (see
http://developer.gnome.org/arch/doc/tools.html)
Notes (I'll codify these some day):
- Don't believe the Gnome page, always edit the SOURCES when documenting a
given function, never the tmpl file.
- I'll be re-arranging things a lot, but gtk-doc is smart enough to merge
any changes to the tmpl file. However, gtk-doc's merge and CVS's diff are
two entirely separate animals. We should probably have a virtual mutex on
the entire docs/gst/ directory, over and above what CVS does.
- I'm going to try to end up with a book set (docbook terms), where
docs/gst/ is only one book. There'd be another called docs/manual/, and
another docs/plugins/, etc. If you have any comments as to how these
should be done, gstreamer-devel is the place.
2000-02-01 09:16:43 +00:00
|
|
|
|
2001-12-12 06:08:44 +00:00
|
|
|
# The directory containing the source code. Relative to $(top_srcdir).
|
|
|
|
|
# gtk-doc will search all .c & .h files beneath here for inline comments
|
|
|
|
|
# documenting functions and macros.
|
Re- set up the gtk-doc system. I'd managed to mutilate it a while back, but now it's fixed. I'll put a copy of the ...
Original commit message from CVS:
Re- set up the gtk-doc system. I'd managed to mutilate it a while back,
but now it's fixed. I'll put a copy of the HTML output somewhere on the
website tonight.
In order to actually generate the docs, you'll have to install all the
DocBook tools, as well as gtk-doc from GNOME cvs. (see
http://developer.gnome.org/arch/doc/tools.html)
Notes (I'll codify these some day):
- Don't believe the Gnome page, always edit the SOURCES when documenting a
given function, never the tmpl file.
- I'll be re-arranging things a lot, but gtk-doc is smart enough to merge
any changes to the tmpl file. However, gtk-doc's merge and CVS's diff are
two entirely separate animals. We should probably have a virtual mutex on
the entire docs/gst/ directory, over and above what CVS does.
- I'm going to try to end up with a book set (docbook terms), where
docs/gst/ is only one book. There'd be another called docs/manual/, and
another docs/plugins/, etc. If you have any comments as to how these
should be done, gstreamer-devel is the place.
2000-02-01 09:16:43 +00:00
|
|
|
DOC_SOURCE_DIR=$(top_srcdir)/gst
|
|
|
|
|
|
2001-12-12 06:08:44 +00:00
|
|
|
# Extra options to supply to gtkdoc-scan.
|
|
|
|
|
SCAN_OPTIONS=
|
|
|
|
|
|
2001-12-10 10:24:06 +00:00
|
|
|
# FIXME :
|
2001-10-08 10:45:03 +00:00
|
|
|
# there's something wrong with gstreamer-sections.txt not being in the dist
|
2001-12-10 10:24:06 +00:00
|
|
|
# maybe it doesn't resolve; we're adding it below for now
|
2002-11-29 11:28:51 +00:00
|
|
|
#EXTRA_DIST = gstreamer.types.in gstreamer.hierarchy $(DOC_MODULE)-sections.txt gstreamer-sections.txt $(DOC_MAIN_SGML_FILE)
|
2001-12-12 06:08:44 +00:00
|
|
|
|
|
|
|
|
# Extra options to supply to gtkdoc-mkdb.
|
2003-05-18 15:04:26 +00:00
|
|
|
MKDB_OPTIONS=--sgml-mode --output-format=xml --ignore-files=trio
|
2001-12-12 06:08:44 +00:00
|
|
|
|
|
|
|
|
# Extra options to supply to gtkdoc-fixref.
|
|
|
|
|
FIXXREF_OPTIONS=
|
|
|
|
|
|
|
|
|
|
# Used for dependencies.
|
|
|
|
|
HFILE_GLOB=$(DOC_SOURCE_DIR)/*.h
|
|
|
|
|
CFILE_GLOB=$(DOC_SOURCE_DIR)/*.c
|
|
|
|
|
|
|
|
|
|
# this is a wingo addition
|
2002-09-13 15:14:45 +00:00
|
|
|
# thomasvs: another nice wingo addition would be an explanation on why
|
|
|
|
|
# this is useful ;)
|
2003-05-18 15:04:26 +00:00
|
|
|
|
|
|
|
|
#SCANOBJ_DEPS = $(top_builddir)/gst/elements/libgstelements.la \
|
|
|
|
|
# $(top_builddir)/gst/schedulers/libgstbasicomegascheduler.la
|
2001-12-12 06:08:44 +00:00
|
|
|
|
|
|
|
|
# Header files to ignore when scanning.
|
|
|
|
|
IGNORE_HFILES=
|
|
|
|
|
|
|
|
|
|
# Images to copy into HTML directory.
|
|
|
|
|
HTML_IMAGES =
|
|
|
|
|
|
|
|
|
|
# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
|
|
|
|
|
content_files =
|
|
|
|
|
|
|
|
|
|
# Other files to distribute.
|
|
|
|
|
extra_files =
|
|
|
|
|
|
|
|
|
|
# CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib
|
|
|
|
|
# contains GtkObjects/GObjects and you want to document signals and properties.
|
2003-11-19 23:34:45 +00:00
|
|
|
GTKDOC_CFLAGS = $(GST_CFLAGS) -I$(top_builddir)
|
2002-01-14 04:09:56 +00:00
|
|
|
GTKDOC_LIBS = $(GST_LIBS) $(SCANOBJ_DEPS)
|
2001-12-12 06:08:44 +00:00
|
|
|
|
|
|
|
|
GTKDOC_CC=$(LIBTOOL) --mode=compile $(CC)
|
|
|
|
|
GTKDOC_LD=$(LIBTOOL) --mode=link $(CC)
|
|
|
|
|
|
|
|
|
|
# If you need to override some of the declarations, place them in this file
|
|
|
|
|
# and uncomment this line.
|
|
|
|
|
#DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt
|
2000-05-12 07:15:03 +00:00
|
|
|
|
Re- set up the gtk-doc system. I'd managed to mutilate it a while back, but now it's fixed. I'll put a copy of the ...
Original commit message from CVS:
Re- set up the gtk-doc system. I'd managed to mutilate it a while back,
but now it's fixed. I'll put a copy of the HTML output somewhere on the
website tonight.
In order to actually generate the docs, you'll have to install all the
DocBook tools, as well as gtk-doc from GNOME cvs. (see
http://developer.gnome.org/arch/doc/tools.html)
Notes (I'll codify these some day):
- Don't believe the Gnome page, always edit the SOURCES when documenting a
given function, never the tmpl file.
- I'll be re-arranging things a lot, but gtk-doc is smart enough to merge
any changes to the tmpl file. However, gtk-doc's merge and CVS's diff are
two entirely separate animals. We should probably have a virtual mutex on
the entire docs/gst/ directory, over and above what CVS does.
- I'm going to try to end up with a book set (docbook terms), where
docs/gst/ is only one book. There'd be another called docs/manual/, and
another docs/plugins/, etc. If you have any comments as to how these
should be done, gstreamer-devel is the place.
2000-02-01 09:16:43 +00:00
|
|
|
|
2001-01-19 22:15:21 +00:00
|
|
|
|
2001-12-12 06:08:44 +00:00
|
|
|
###########################################################################
|
|
|
|
|
# Everything below here is generic and you shouldn't need to change it.
|
|
|
|
|
###########################################################################
|
2003-05-18 15:04:26 +00:00
|
|
|
# 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)
|
2001-01-19 22:15:21 +00:00
|
|
|
|
2003-05-18 15:04:26 +00:00
|
|
|
# thomas: make docs parallel installable
|
2002-12-08 14:39:38 +00:00
|
|
|
TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@
|
Re- set up the gtk-doc system. I'd managed to mutilate it a while back, but now it's fixed. I'll put a copy of the ...
Original commit message from CVS:
Re- set up the gtk-doc system. I'd managed to mutilate it a while back,
but now it's fixed. I'll put a copy of the HTML output somewhere on the
website tonight.
In order to actually generate the docs, you'll have to install all the
DocBook tools, as well as gtk-doc from GNOME cvs. (see
http://developer.gnome.org/arch/doc/tools.html)
Notes (I'll codify these some day):
- Don't believe the Gnome page, always edit the SOURCES when documenting a
given function, never the tmpl file.
- I'll be re-arranging things a lot, but gtk-doc is smart enough to merge
any changes to the tmpl file. However, gtk-doc's merge and CVS's diff are
two entirely separate animals. We should probably have a virtual mutex on
the entire docs/gst/ directory, over and above what CVS does.
- I'm going to try to end up with a book set (docbook terms), where
docs/gst/ is only one book. There'd be another called docs/manual/, and
another docs/plugins/, etc. If you have any comments as to how these
should be done, gstreamer-devel is the place.
2000-02-01 09:16:43 +00:00
|
|
|
|
2001-12-12 06:08:44 +00:00
|
|
|
EXTRA_DIST = \
|
|
|
|
|
$(content_files) \
|
|
|
|
|
$(extra_files) \
|
|
|
|
|
$(HTML_IMAGES) \
|
|
|
|
|
$(DOC_MAIN_SGML_FILE) \
|
2002-11-29 11:28:51 +00:00
|
|
|
$(DOC_MODULE).types \
|
|
|
|
|
$(DOC_MODULE)-sections.txt
|
2000-02-02 06:26:44 +00:00
|
|
|
|
2001-12-12 06:08:44 +00:00
|
|
|
DOC_STAMPS=scan-build.stamp tmpl-build.stamp sgml-build.stamp html-build.stamp \
|
|
|
|
|
$(srcdir)/tmpl.stamp $(srcdir)/sgml.stamp $(srcdir)/html.stamp
|
2000-03-27 19:53:43 +00:00
|
|
|
|
2001-12-12 06:08:44 +00:00
|
|
|
SCANOBJ_FILES = \
|
|
|
|
|
$(DOC_MODULE).args \
|
|
|
|
|
$(DOC_MODULE).hierarchy \
|
2003-06-29 14:05:49 +00:00
|
|
|
$(DOC_MODULE)-scan.o \
|
2001-12-12 06:08:44 +00:00
|
|
|
$(DOC_MODULE).signals
|
2000-10-22 16:27:21 +00:00
|
|
|
|
2001-12-12 06:08:44 +00:00
|
|
|
if HAVE_GTK_DOC
|
|
|
|
|
all-local: html-build.stamp
|
Re- set up the gtk-doc system. I'd managed to mutilate it a while back, but now it's fixed. I'll put a copy of the ...
Original commit message from CVS:
Re- set up the gtk-doc system. I'd managed to mutilate it a while back,
but now it's fixed. I'll put a copy of the HTML output somewhere on the
website tonight.
In order to actually generate the docs, you'll have to install all the
DocBook tools, as well as gtk-doc from GNOME cvs. (see
http://developer.gnome.org/arch/doc/tools.html)
Notes (I'll codify these some day):
- Don't believe the Gnome page, always edit the SOURCES when documenting a
given function, never the tmpl file.
- I'll be re-arranging things a lot, but gtk-doc is smart enough to merge
any changes to the tmpl file. However, gtk-doc's merge and CVS's diff are
two entirely separate animals. We should probably have a virtual mutex on
the entire docs/gst/ directory, over and above what CVS does.
- I'm going to try to end up with a book set (docbook terms), where
docs/gst/ is only one book. There'd be another called docs/manual/, and
another docs/plugins/, etc. If you have any comments as to how these
should be done, gstreamer-devel is the place.
2000-02-01 09:16:43 +00:00
|
|
|
|
2001-12-12 06:08:44 +00:00
|
|
|
#### scan ####
|
Re- set up the gtk-doc system. I'd managed to mutilate it a while back, but now it's fixed. I'll put a copy of the ...
Original commit message from CVS:
Re- set up the gtk-doc system. I'd managed to mutilate it a while back,
but now it's fixed. I'll put a copy of the HTML output somewhere on the
website tonight.
In order to actually generate the docs, you'll have to install all the
DocBook tools, as well as gtk-doc from GNOME cvs. (see
http://developer.gnome.org/arch/doc/tools.html)
Notes (I'll codify these some day):
- Don't believe the Gnome page, always edit the SOURCES when documenting a
given function, never the tmpl file.
- I'll be re-arranging things a lot, but gtk-doc is smart enough to merge
any changes to the tmpl file. However, gtk-doc's merge and CVS's diff are
two entirely separate animals. We should probably have a virtual mutex on
the entire docs/gst/ directory, over and above what CVS does.
- I'm going to try to end up with a book set (docbook terms), where
docs/gst/ is only one book. There'd be another called docs/manual/, and
another docs/plugins/, etc. If you have any comments as to how these
should be done, gstreamer-devel is the place.
2000-02-01 09:16:43 +00:00
|
|
|
|
2003-05-18 15:04:26 +00:00
|
|
|
|
2001-12-12 06:08:44 +00:00
|
|
|
# wingo addition
|
2003-05-18 15:04:26 +00:00
|
|
|
scan-build.stamp: $(HFILE_GLOB) $(SCANOBJ_DEPS) $(basefiles)
|
2001-12-12 06:08:44 +00:00
|
|
|
@echo '*** Scanning header files ***'
|
|
|
|
|
if grep -l '^..*$$' $(srcdir)/$(DOC_MODULE).types > /dev/null ; then \
|
2003-11-19 23:49:46 +00:00
|
|
|
if test x"$(srcdir)" != x. ; then \
|
2003-11-19 23:34:45 +00:00
|
|
|
cp $(srcdir)/$(DOC_MODULE).types . ; \
|
|
|
|
|
fi ; \
|
|
|
|
|
CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" CFLAGS="$(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)" $(GTK_DOC_SCANOBJ) --module=$(DOC_MODULE) ; \
|
2001-12-12 06:08:44 +00:00
|
|
|
else \
|
|
|
|
|
cd $(srcdir) ; \
|
|
|
|
|
for i in $(SCANOBJ_FILES) ; do \
|
|
|
|
|
test -f $$i || touch $$i ; \
|
|
|
|
|
done \
|
|
|
|
|
fi
|
2003-11-19 23:34:45 +00:00
|
|
|
gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="$(IGNORE_HFILES)" $(SCAN_OPTIONS) $(EXTRA_HFILES)
|
2001-12-12 06:08:44 +00:00
|
|
|
touch scan-build.stamp
|
|
|
|
|
|
|
|
|
|
$(DOC_MODULE)-decl.txt $(SCANOBJ_FILES): scan-build.stamp
|
|
|
|
|
@true
|
|
|
|
|
|
|
|
|
|
#### templates ####
|
|
|
|
|
|
|
|
|
|
tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_OVERRIDES)
|
|
|
|
|
@echo '*** Rebuilding template files ***'
|
2003-11-19 23:49:46 +00:00
|
|
|
if test x"$(srcdir)" != x. ; then \
|
2003-11-19 23:34:45 +00:00
|
|
|
cp $(srcdir)/$(DOC_MODULE)-decl.txt . ; \
|
|
|
|
|
cp $(srcdir)/$(DOC_MODULE)-sections.txt . ; \
|
|
|
|
|
fi
|
|
|
|
|
gtkdoc-mktmpl --module=$(DOC_MODULE)
|
2001-12-12 06:08:44 +00:00
|
|
|
touch tmpl-build.stamp
|
|
|
|
|
|
|
|
|
|
tmpl.stamp: tmpl-build.stamp
|
|
|
|
|
@true
|
|
|
|
|
|
|
|
|
|
#### sgml ####
|
|
|
|
|
|
2002-01-14 07:18:43 +00:00
|
|
|
sgml-build.stamp: tmpl.stamp $(CFILE_GLOB)
|
2001-12-12 06:08:44 +00:00
|
|
|
@echo '*** Building SGML ***'
|
|
|
|
|
gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --main-sgml-file=$(DOC_MAIN_SGML_FILE) $(MKDB_OPTIONS)
|
|
|
|
|
touch sgml-build.stamp
|
|
|
|
|
|
|
|
|
|
sgml.stamp: sgml-build.stamp
|
|
|
|
|
@true
|
|
|
|
|
|
|
|
|
|
#### html ####
|
|
|
|
|
|
2003-05-18 15:04:26 +00:00
|
|
|
# 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
|
2001-12-12 06:08:44 +00:00
|
|
|
html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
|
|
|
|
|
@echo '*** Building HTML ***'
|
2003-11-19 23:34:45 +00:00
|
|
|
test -d html || mkdir html
|
|
|
|
|
cd html && gtkdoc-mkhtml $(DOC_MODULE) $(srcdir)/../$(DOC_MAIN_SGML_FILE)
|
2003-12-19 20:27:03 +00:00
|
|
|
test "x$(HTML_IMAGES)" = "x" || for i in "" $(HTML_IMAGES) ; do \
|
|
|
|
|
if test "$$i" != ""; then cp $(srcdir)/$$i html ; fi; done
|
2001-12-12 06:08:44 +00:00
|
|
|
@echo '-- Fixing Crossreferences'
|
2003-11-19 23:34:45 +00:00
|
|
|
LANG=C && gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
|
2001-12-12 06:08:44 +00:00
|
|
|
touch html-build.stamp
|
|
|
|
|
endif
|
Re- set up the gtk-doc system. I'd managed to mutilate it a while back, but now it's fixed. I'll put a copy of the ...
Original commit message from CVS:
Re- set up the gtk-doc system. I'd managed to mutilate it a while back,
but now it's fixed. I'll put a copy of the HTML output somewhere on the
website tonight.
In order to actually generate the docs, you'll have to install all the
DocBook tools, as well as gtk-doc from GNOME cvs. (see
http://developer.gnome.org/arch/doc/tools.html)
Notes (I'll codify these some day):
- Don't believe the Gnome page, always edit the SOURCES when documenting a
given function, never the tmpl file.
- I'll be re-arranging things a lot, but gtk-doc is smart enough to merge
any changes to the tmpl file. However, gtk-doc's merge and CVS's diff are
two entirely separate animals. We should probably have a virtual mutex on
the entire docs/gst/ directory, over and above what CVS does.
- I'm going to try to end up with a book set (docbook terms), where
docs/gst/ is only one book. There'd be another called docs/manual/, and
another docs/plugins/, etc. If you have any comments as to how these
should be done, gstreamer-devel is the place.
2000-02-01 09:16:43 +00:00
|
|
|
|
|
|
|
|
clean-local:
|
2001-12-12 06:08:44 +00:00
|
|
|
rm -f *~ *.bak $(SCANOBJ_FILES) *-unused.txt $(DOC_STAMPS)
|
2003-05-18 15:04:26 +00:00
|
|
|
rm -rf xml html
|
2001-12-12 06:08:44 +00:00
|
|
|
|
|
|
|
|
maintainer-clean-local: clean
|
|
|
|
|
cd $(srcdir) && rm -rf sgml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
|
Re- set up the gtk-doc system. I'd managed to mutilate it a while back, but now it's fixed. I'll put a copy of the ...
Original commit message from CVS:
Re- set up the gtk-doc system. I'd managed to mutilate it a while back,
but now it's fixed. I'll put a copy of the HTML output somewhere on the
website tonight.
In order to actually generate the docs, you'll have to install all the
DocBook tools, as well as gtk-doc from GNOME cvs. (see
http://developer.gnome.org/arch/doc/tools.html)
Notes (I'll codify these some day):
- Don't believe the Gnome page, always edit the SOURCES when documenting a
given function, never the tmpl file.
- I'll be re-arranging things a lot, but gtk-doc is smart enough to merge
any changes to the tmpl file. However, gtk-doc's merge and CVS's diff are
two entirely separate animals. We should probably have a virtual mutex on
the entire docs/gst/ directory, over and above what CVS does.
- I'm going to try to end up with a book set (docbook terms), where
docs/gst/ is only one book. There'd be another called docs/manual/, and
another docs/plugins/, etc. If you have any comments as to how these
should be done, gstreamer-devel is the place.
2000-02-01 09:16:43 +00:00
|
|
|
|
2003-06-29 14:05:49 +00:00
|
|
|
# company: don't delete .sgml and -sections.txt as they're in CVS
|
2001-12-10 19:11:27 +00:00
|
|
|
# FIXME : thomas added all sgml files and some other things to make
|
|
|
|
|
# make distcheck work
|
2001-06-28 16:31:04 +00:00
|
|
|
distclean-local: clean
|
|
|
|
|
rm -rf $(DOC_MODULE)-decl-list.txt
|
2003-06-29 14:05:49 +00:00
|
|
|
rm -rf $(DOC_MODULE)-decl.txt
|
|
|
|
|
rm -rf $(DOC_MODULE)-undocumented.txt
|
|
|
|
|
rm -rf $(DOC_MODULE)-unused.txt
|
|
|
|
|
rm -rf tmpl/*.sgml.bak
|
2003-05-18 15:04:26 +00:00
|
|
|
rm -f $(DOC_MODULE).hierarchy
|
2001-12-12 19:35:34 +00:00
|
|
|
rm -f *.stamp || true
|
2003-11-19 23:49:46 +00:00
|
|
|
if test x"$(srcdir)" != x. ; then \
|
2003-11-19 23:34:45 +00:00
|
|
|
rm -f $(DOC_MODULE)-docs.sgml ; \
|
|
|
|
|
rm -f $(DOC_MODULE).types ; \
|
|
|
|
|
rm -f $(DOC_MODULE).interfaces ; \
|
|
|
|
|
rm -f $(DOC_MODULE).prerequisites ; \
|
|
|
|
|
rm -f $(DOC_MODULE)-sections.txt ; \
|
|
|
|
|
rm -rf tmpl/*.sgml ; \
|
|
|
|
|
fi
|
|
|
|
|
rm -rf *.o
|
Re- set up the gtk-doc system. I'd managed to mutilate it a while back, but now it's fixed. I'll put a copy of the ...
Original commit message from CVS:
Re- set up the gtk-doc system. I'd managed to mutilate it a while back,
but now it's fixed. I'll put a copy of the HTML output somewhere on the
website tonight.
In order to actually generate the docs, you'll have to install all the
DocBook tools, as well as gtk-doc from GNOME cvs. (see
http://developer.gnome.org/arch/doc/tools.html)
Notes (I'll codify these some day):
- Don't believe the Gnome page, always edit the SOURCES when documenting a
given function, never the tmpl file.
- I'll be re-arranging things a lot, but gtk-doc is smart enough to merge
any changes to the tmpl file. However, gtk-doc's merge and CVS's diff are
two entirely separate animals. We should probably have a virtual mutex on
the entire docs/gst/ directory, over and above what CVS does.
- I'm going to try to end up with a book set (docbook terms), where
docs/gst/ is only one book. There'd be another called docs/manual/, and
another docs/plugins/, etc. If you have any comments as to how these
should be done, gstreamer-devel is the place.
2000-02-01 09:16:43 +00:00
|
|
|
|
2003-05-18 15:04:26 +00:00
|
|
|
# thomas: make docs parallel installable; devhelp requires majorminor too
|
2003-11-14 18:37:23 +00:00
|
|
|
if DOC_HTML
|
2001-12-12 06:08:44 +00:00
|
|
|
install-data-local:
|
2003-11-14 18:37:23 +00:00
|
|
|
$(mkinstalldirs) $(DESTDIR)$(TARGET_DIR)
|
2003-11-29 04:36:56 +00:00
|
|
|
(installfiles=`echo ./html/*.html`; \
|
|
|
|
|
if test "$$installfiles" = './html/*.html'; \
|
2000-02-02 06:26:44 +00:00
|
|
|
then echo '-- Nothing to install' ; \
|
|
|
|
|
else \
|
|
|
|
|
for i in $$installfiles; do \
|
|
|
|
|
echo '-- Installing '$$i ; \
|
|
|
|
|
$(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
|
|
|
|
|
done; \
|
2003-11-29 04:36:56 +00:00
|
|
|
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; \
|
2003-05-18 15:04:26 +00:00
|
|
|
echo '-- Installing $(srcdir)/html/$(DOC_MODULE).devhelp' ; \
|
|
|
|
|
$(INSTALL_DATA) $(srcdir)/html/$(DOC_MODULE).devhelp \
|
|
|
|
|
$(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@.devhelp; \
|
2000-02-02 06:26:44 +00:00
|
|
|
echo '-- Installing $(srcdir)/html/index.sgml' ; \
|
|
|
|
|
$(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR); \
|
2003-11-14 18:37:23 +00:00
|
|
|
fi)
|
2003-11-23 04:40:22 +00:00
|
|
|
uninstall-local:
|
2003-11-29 04:36:56 +00:00
|
|
|
(installfiles=`echo ./html/*.html`; \
|
|
|
|
|
if test "$$installfiles" = './html/*.html'; \
|
2003-11-23 04:40:22 +00:00
|
|
|
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; \
|
2003-11-29 04:36:56 +00:00
|
|
|
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; \
|
2003-11-23 04:40:22 +00:00
|
|
|
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; \
|
|
|
|
|
fi)
|
2003-12-14 22:27:25 +00:00
|
|
|
if test -d $(DESTDIR)$(TARGET_DIR); then rmdir -p --ignore-fail-on-non-empty $(DESTDIR)$(TARGET_DIR); fi
|
2003-11-14 18:37:23 +00:00
|
|
|
else
|
|
|
|
|
install-data-local:
|
2003-11-23 04:40:22 +00:00
|
|
|
uninstall-local:
|
2003-11-14 18:37:23 +00:00
|
|
|
endif
|
2000-02-02 06:26:44 +00:00
|
|
|
|
2001-12-12 06:08:44 +00:00
|
|
|
#
|
|
|
|
|
# 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
|
2003-05-18 15:04:26 +00:00
|
|
|
mkdir $(distdir)/xml
|
2001-12-12 06:08:44 +00:00
|
|
|
mkdir $(distdir)/html
|
2000-02-02 06:26:44 +00:00
|
|
|
-cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl
|
2003-05-18 15:04:26 +00:00
|
|
|
-cp $(srcdir)/sgml/*.xml $(distdir)/xml
|
2001-12-12 06:08:44 +00:00
|
|
|
-cp $(srcdir)/html/index.sgml $(distdir)/html
|
|
|
|
|
-cp $(srcdir)/html/*.html $(srcdir)/html/*.css $(distdir)/html
|
|
|
|
|
|
|
|
|
|
images=$(HTML_IMAGES) ; \
|
2003-12-19 20:27:03 +00:00
|
|
|
for i in "" $$images ; do \
|
|
|
|
|
if test "$$i" != ""; then cp $(srcdir)/$$i $(distdir)/html ; fi; \
|
2001-12-12 06:08:44 +00:00
|
|
|
done
|
Re- set up the gtk-doc system. I'd managed to mutilate it a while back, but now it's fixed. I'll put a copy of the ...
Original commit message from CVS:
Re- set up the gtk-doc system. I'd managed to mutilate it a while back,
but now it's fixed. I'll put a copy of the HTML output somewhere on the
website tonight.
In order to actually generate the docs, you'll have to install all the
DocBook tools, as well as gtk-doc from GNOME cvs. (see
http://developer.gnome.org/arch/doc/tools.html)
Notes (I'll codify these some day):
- Don't believe the Gnome page, always edit the SOURCES when documenting a
given function, never the tmpl file.
- I'll be re-arranging things a lot, but gtk-doc is smart enough to merge
any changes to the tmpl file. However, gtk-doc's merge and CVS's diff are
two entirely separate animals. We should probably have a virtual mutex on
the entire docs/gst/ directory, over and above what CVS does.
- I'm going to try to end up with a book set (docbook terms), where
docs/gst/ is only one book. There'd be another called docs/manual/, and
another docs/plugins/, etc. If you have any comments as to how these
should be done, gstreamer-devel is the place.
2000-02-01 09:16:43 +00:00
|
|
|
|
2001-12-12 06:08:44 +00:00
|
|
|
.PHONY : dist-hook-local
|
