From 50251fcfec62f5f8dbc88e10b6c4ae0ea521f6e1 Mon Sep 17 00:00:00 2001 From: Thomas Vander Stichele Date: Sun, 18 May 2003 15:04:26 +0000 Subject: [PATCH 1/1] converting to xml as intermediary step to fix devhelp generation assorted doc build fixes as well http://bugzilla.gno... Original commit message from CVS: converting to xml as intermediary step to fix devhelp generation assorted doc build fixes as well http://bugzilla.gnome.org/show_bug.cgi?id=113195 --- docs/Makefile.am | 4 +- docs/gst/Makefile.am | 63 +++++-- docs/gst/gstreamer-docs.sgml | 145 ++++++++-------- docs/gst/gstreamer-sections.txt | 15 +- docs/libs/Makefile.am | 239 ++++++++++++++++++++++---- docs/libs/gstreamer-libs-docs.sgml | 19 +-- docs/libs/gstreamer-libs-sections.txt | 306 +--------------------------------- 7 files changed, 349 insertions(+), 442 deletions(-) diff --git a/docs/Makefile.am b/docs/Makefile.am index b6a7361..57f3bb8 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -5,8 +5,8 @@ else SUBDIRS_PLUGINS = endif -SUBDIRS = faq manual pwg gst libs $(SUBDIRS_PLUGINS) devhelp -DIST_SUBDIRS = faq manual pwg gst libs plugins xsl devhelp +SUBDIRS = faq manual pwg gst libs $(SUBDIRS_PLUGINS) +DIST_SUBDIRS = faq manual pwg gst libs plugins xsl EXTRA_DIST = slides manuals.mak diff --git a/docs/gst/Makefile.am b/docs/gst/Makefile.am index 6398369..7d9dc67 100644 --- a/docs/gst/Makefile.am +++ b/docs/gst/Makefile.am @@ -1,8 +1,29 @@ ## Process this file with automake to produce Makefile.in # The name of the module, e.g. 'glib'. +# DOC_MODULE=gstreamer-@GST_MAJORMINOR@ DOC_MODULE=gstreamer +# 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) + # The top-level SGML file. Change it if you want. DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml @@ -20,21 +41,21 @@ SCAN_OPTIONS= #EXTRA_DIST = gstreamer.types.in gstreamer.hierarchy $(DOC_MODULE)-sections.txt gstreamer-sections.txt $(DOC_MAIN_SGML_FILE) # Extra options to supply to gtkdoc-mkdb. -MKDB_OPTIONS= +MKDB_OPTIONS=--sgml-mode --output-format=xml --ignore-files=trio # Extra options to supply to gtkdoc-fixref. FIXXREF_OPTIONS= # Used for dependencies. -# FIXME deal with the subdirs too... HFILE_GLOB=$(DOC_SOURCE_DIR)/*.h CFILE_GLOB=$(DOC_SOURCE_DIR)/*.c # this is a wingo addition # thomasvs: another nice wingo addition would be an explanation on why # this is useful ;) -SCANOBJ_DEPS = $(top_builddir)/gst/elements/libgstelements.la \ - $(top_builddir)/gst/schedulers/libgstbasicomegascheduler.la + +#SCANOBJ_DEPS = $(top_builddir)/gst/elements/libgstelements.la \ +# $(top_builddir)/gst/schedulers/libgstbasicomegascheduler.la # Header files to ignore when scanning. IGNORE_HFILES= @@ -65,8 +86,17 @@ GTKDOC_LD=$(LIBTOOL) --mode=link $(CC) ########################################################################### # 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) -# added majorminor here because we want parallel installs +# thomas: make docs parallel installable TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@ EXTRA_DIST = \ @@ -90,8 +120,9 @@ all-local: html-build.stamp #### scan #### + # wingo addition -scan-build.stamp: $(HFILE_GLOB) $(SCANOBJ_DEPS) +scan-build.stamp: $(HFILE_GLOB) $(SCANOBJ_DEPS) $(basefiles) @echo '*** Scanning header files ***' if grep -l '^..*$$' $(srcdir)/$(DOC_MODULE).types > /dev/null ; then \ CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" CFLAGS="$(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)" $(GTK_DOC_SCANOBJ) --module=$(DOC_MODULE) --output-dir=$(srcdir) ; \ @@ -131,18 +162,22 @@ sgml.stamp: sgml-build.stamp #### 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 ***' test -d $(srcdir)/html || mkdir $(srcdir)/html cd $(srcdir)/html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE) test "x$(HTML_IMAGES)" = "x" || ( cd $(srcdir) && cp $(HTML_IMAGES) html ) @echo '-- Fixing Crossreferences' - cd $(srcdir) && gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS) + cd $(srcdir) && LANG=C && gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS) touch html-build.stamp endif clean-local: rm -f *~ *.bak $(SCANOBJ_FILES) *-unused.txt $(DOC_STAMPS) + rm -rf xml html maintainer-clean-local: clean cd $(srcdir) && rm -rf sgml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt @@ -151,14 +186,15 @@ maintainer-clean-local: clean # make distcheck work distclean-local: clean rm -rf $(DOC_MODULE)-decl-list.txt - rm -rf gstreamer-*.txt + rm -rf $(DOC_MODULE)-*.txt rm -rf tmpl/*.sgml - rm -f gstreamer.hierarchy + rm -f $(DOC_MODULE).hierarchy rm -f *.stamp || true +# thomas: make docs parallel installable; devhelp requires majorminor too install-data-local: $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR) - (installfiles=`echo $(srcdir)/html/*.html`; \ + (installfiles=`echo $(srcdir)/html/*.html $(srcdir)/html/*.png`; \ if test "$$installfiles" = '$(srcdir)/html/*.html'; \ then echo '-- Nothing to install' ; \ else \ @@ -166,6 +202,9 @@ install-data-local: echo '-- Installing '$$i ; \ $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \ done; \ + 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); \ fi) @@ -183,10 +222,10 @@ endif dist-hook: dist-check-gtkdoc dist-hook-local mkdir $(distdir)/tmpl - mkdir $(distdir)/sgml + mkdir $(distdir)/xml mkdir $(distdir)/html -cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl - -cp $(srcdir)/sgml/*.sgml $(distdir)/sgml + -cp $(srcdir)/sgml/*.xml $(distdir)/xml -cp $(srcdir)/html/index.sgml $(distdir)/html -cp $(srcdir)/html/*.html $(srcdir)/html/*.css $(distdir)/html diff --git a/docs/gst/gstreamer-docs.sgml b/docs/gst/gstreamer-docs.sgml index df93a31..d860aba 100644 --- a/docs/gst/gstreamer-docs.sgml +++ b/docs/gst/gstreamer-docs.sgml @@ -1,70 +1,73 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ]> - - GStreamer Core Reference Manual @@ -114,7 +117,8 @@ with some more specialized elements. &GstProbe; &GstProps; &GstQuery; - &GstQueue; + &GstRegistry; &GstRegistryPool; &GstScheduler; @@ -123,7 +127,8 @@ with some more specialized elements. &GstThread; &GstType; &GstTypeFactory; - &GstTypeFind; + &GstUri; &GstUtils; &GstXML; @@ -161,6 +166,7 @@ with some more specialized elements. --> + + diff --git a/docs/gst/gstreamer-sections.txt b/docs/gst/gstreamer-sections.txt index 200f071..a616f16 100644 --- a/docs/gst/gstreamer-sections.txt +++ b/docs/gst/gstreamer-sections.txt @@ -2,10 +2,9 @@
cothreads -CURRENT_STACK_FRAME cothread_state -cothread_context cothread_func +cothread_context COTHREAD_STARTED COTHREAD_DESTROYED cothread_context_init @@ -127,7 +126,6 @@ GST_SCHEDULER_PARENT GST_SCHEDULER_STATE GstSchedulerState GstSchedulerFlags -gst_scheduler_destroy gst_scheduler_setup gst_scheduler_reset gst_scheduler_add_element @@ -214,7 +212,6 @@ GstBinFlags GstBin GstBinPrePostIterateFunction gst_bin_new -gst_bin_destroy gst_bin_add gst_bin_add_many gst_bin_remove @@ -280,7 +277,6 @@ GstData GstDataFreeFunction GstDataCopyFunction GstDataFlags -GST_DATA_IS_READONLY GST_DATA_REFCOUNT GST_DATA_REFCOUNT_VALUE GST_DATA_COPY_FUNC @@ -289,7 +285,6 @@ gst_data_init gst_data_dispose gst_data_copy_into gst_data_copy -gst_data_needs_copy_on_write gst_data_copy_on_write gst_data_free gst_data_ref @@ -337,7 +332,6 @@ gst_buffer_ref gst_buffer_ref_by_count gst_buffer_unref gst_buffer_copy -gst_buffer_needs_copy_on_write gst_buffer_copy_on_write gst_buffer_free gst_buffer_create_sub @@ -373,7 +367,6 @@ gst_buffer_pool_set_user_data gst_buffer_pool_get_user_data gst_buffer_pool_get_default gst_buffer_pool_default_free -gst_buffer_pool_needs_copy_on_write GST_TYPE_BUFFER_POOL
@@ -442,7 +435,6 @@ gst_seek_type_get_type gstelement GstElement GstElement -gst_element_destroy gst_element_get_name gst_element_set_name gst_element_get_factory @@ -817,7 +809,6 @@ gst_object_ref gst_object_unref gst_object_replace gst_object_sink -gst_object_destroy gst_object_save_thyself gst_object_restore_thyself gst_object_get_path_string @@ -900,7 +891,6 @@ GstPadFlags gst_pad_new gst_pad_custom_new gst_pad_custom_new_from_template -gst_pad_destroy gst_pad_new_from_template gst_pad_get_direction gst_pad_set_chain_function @@ -1100,7 +1090,6 @@ gst_pad_template_flags_get_type GstPipeline GstPipeline gst_pipeline_new -gst_pipeline_destroy GstPipelineClass gst_pipeline_get_type @@ -1369,7 +1358,6 @@ gst_props_normalize gst_props_set gst_props_get gst_props_get_safe -gst_props_has_property gst_props_has_fixed_property gst_props_has_property_typed gst_props_intersect @@ -1386,6 +1374,7 @@ gst_props_entry_new gst_props_entry_copy gst_props_entry_destroy gst_props_entry_get +gst_props_entry_get_type gst_props_entry_get_boolean gst_props_entry_get_float gst_props_entry_get_float_range diff --git a/docs/libs/Makefile.am b/docs/libs/Makefile.am index da6ee0b..1a2723a 100644 --- a/docs/libs/Makefile.am +++ b/docs/libs/Makefile.am @@ -1,51 +1,198 @@ ## Process this file with automake to produce Makefile.in -# The name of the module. +# The name of the module, e.g. 'glib'. +#DOC_MODULE=gstreamer-libs-@GST_MAJORMINOR@ DOC_MODULE=gstreamer-libs -# The top-level SGML file. +# generated basefiles +#basefiles = \ +## $(DOC_MODULE).types \ +# $(DOC_MODULE)-sections.txt \ +# $(DOC_MODULE)-docs.sgml + +# ugly hack to make -unused.sgml work +#unused-build.stamp: +# BUILDDIR=`pwd` && \ +# cd $(srcdir)/tmpl && \ +# ln -sf gstreamer-libs-unused.sgml \ +# $$BUILDDIR/tmpl/gstreamer-libs-@GST_MAJORMINOR@-unused.sgml +# touch unused-build.stamp + +# these rules are added to create parallel docs using GST_MAJORMINOR +#$(basefiles): gstreamer-libs-@GST_MAJORMINOR@%: gstreamer-libs% +# cp $< $@ + +#CLEANFILES = $(basefiles) + +# The top-level SGML file. Change it if you want. DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml -# The directory containing the source code (if it contains documentation). -DOC_SOURCE_DIR=$(top_srcdir)/libs +# 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. +DOC_SOURCE_DIR=$(top_srcdir)/libs/gst + +# Extra options to supply to gtkdoc-scan. +SCAN_OPTIONS= + +# FIXME : +# there's something wrong with gstreamer-sections.txt not being in the dist +# maybe it doesn't resolve; we're adding it below for now +#EXTRA_DIST = gstreamer.types.in gstreamer.hierarchy $(DOC_MODULE)-sections.txt gstreamer-sections.txt $(DOC_MAIN_SGML_FILE) + +# Extra options to supply to gtkdoc-mkdb. +MKDB_OPTIONS=--sgml-mode --output-format=xml --ignore-files=trio + +# Extra options to supply to gtkdoc-fixref. +FIXXREF_OPTIONS=--extra-dir=../gst/html + +# Used for dependencies. +HFILE_GLOB=$(DOC_SOURCE_DIR)/*/*.h +CFILE_GLOB=$(DOC_SOURCE_DIR)/*/*.c + +# this is a wingo addition +# thomasvs: another nice wingo addition would be an explanation on why +# this is useful ;) + +#SCANOBJ_DEPS = $(top_builddir)/gst/elements/libgstelements.la \ +# $(top_builddir)/gst/schedulers/libgstbasicomegascheduler.la + +# 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. +GTKDOC_CFLAGS = $(GST_CFLAGS) +GTKDOC_LIBS = $(GST_LIBS) $(SCANOBJ_DEPS) + +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 + + + +########################################################################### +# Everything below here is generic and you shouldn't need to change it. +########################################################################### +# thomas: except of course that we did -EXTRA_DIST = $(DOC_MODULE)-docs.sgml $(DOC_MODULE)-sections.txt +# 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) -HTML_DIR=@HTML_DIR@ -# add major minor here for parallel installs TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@ +EXTRA_DIST = \ + $(content_files) \ + $(extra_files) \ + $(HTML_IMAGES) \ + $(DOC_MAIN_SGML_FILE) \ + $(DOC_MODULE).types \ + $(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).signals + if HAVE_GTK_DOC -html: html/book1.html -else -html: -endif +all-local: html-build.stamp + +#### scan #### + + +# wingo addition +scan-build.stamp: $(HFILE_GLOB) $(SCANOBJ_DEPS) $(basefiles) + @echo '*** Scanning header files ***' + if grep -l '^..*$$' $(srcdir)/$(DOC_MODULE).types > /dev/null ; then \ + CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" CFLAGS="$(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)" $(GTK_DOC_SCANOBJ) --module=$(DOC_MODULE) --output-dir=$(srcdir) ; \ + else \ + cd $(srcdir) ; \ + for i in $(SCANOBJ_FILES) ; do \ + test -f $$i || touch $$i ; \ + done \ + fi + cd $(srcdir) && \ + gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="$(IGNORE_HFILES)" $(SCAN_OPTIONS) $(EXTRA_HFILES) + touch scan-build.stamp + +$(DOC_MODULE)-decl.txt $(SCANOBJ_FILES): scan-build.stamp + @true + +#### templates #### -# rule to make the html -html/book1.html: sgml/$(DOC_MODULE)-doc.bottom $(DOC_MAIN_SGML_FILE) - if ! test -d html ; then mkdir html ; fi - -cd html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE) +tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_OVERRIDES) + @echo '*** Rebuilding template files ***' + cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE) + touch tmpl-build.stamp -# rule to cause scanning to be done -$(DOC_MODULE)-decl.txt: - gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="" +tmpl.stamp: tmpl-build.stamp + @true -# rule to cause tmpls to be made -tmpl/$(DOC_MODULE)-unused.sgml: $(DOC_MODULE)-decl.txt $(DOC_MODULE)-sections.txt - gtkdoc-mktmpl --module=$(DOC_MODULE) +#### sgml #### -# rule to make sgml -sgml/$(DOC_MODULE)-doc.bottom: tmpl/$(DOC_MODULE)-unused.sgml - gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) +sgml-build.stamp: tmpl.stamp $(CFILE_GLOB) + @echo '*** Building SGML ***' + cd $(srcdir) && \ + gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --main-sgml-file=$(DOC_MAIN_SGML_FILE) $(MKDB_OPTIONS) + touch sgml-build.stamp -all-local: html +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 ***' + test -d $(srcdir)/html || mkdir $(srcdir)/html + cd $(srcdir)/html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE) + test "x$(HTML_IMAGES)" = "x" || ( cd $(srcdir) && cp $(HTML_IMAGES) html ) + @echo '-- Fixing Crossreferences' + cd $(srcdir) && gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS) + touch html-build.stamp +endif clean-local: - $(RM) -rf *~ *.bak *.signals *-unused.txt *.args html sgml tmpl/*.bak $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt + rm -f *~ *.bak $(SCANOBJ_FILES) *-unused.txt $(DOC_STAMPS) + rm -rf xml html + +maintainer-clean-local: clean + cd $(srcdir) && rm -rf sgml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt + +# FIXME : thomas added all sgml files and some other things to make +# make distcheck work +distclean-local: clean + rm -rf $(DOC_MODULE)-decl-list.txt + rm -rf $(DOC_MODULE)-*.txt + rm -rf tmpl/*.sgml + rm -f $(DOC_MODULE).hierarchy + rm -f *.stamp || true -install-data-local: html - @$(mkinstalldirs) $(DESTDIR)$(TARGET_DIR) - @(installfiles=`echo $(srcdir)/html/*.html`; \ +install-data-local: + $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR) + (installfiles=`echo $(srcdir)/html/*.html $(srcdir)/html/*.png`; \ if test "$$installfiles" = '$(srcdir)/html/*.html'; \ then echo '-- Nothing to install' ; \ else \ @@ -53,14 +200,36 @@ install-data-local: html echo '-- Installing '$$i ; \ $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \ done; \ + 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); \ - echo '-- Fixing Crossreferences' ; \ - gtkdoc-fixxref --module=$(DOC_MODULE) --html-dir=$(HTML_DIR)|| true; \ fi) -uninstall-local: - @echo '-- Uninstalling '$(DESTDIR)$(TARGET_DIR) ; \ - $(RM) -rf $(DESTDIR)$(TARGET_DIR) +# +# 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 + + images=$(HTML_IMAGES) ; \ + for i in $$images ; do \ + cp $(srcdir)/$$i $(distdir)/html ; \ + done -.PHONY : html +.PHONY : dist-hook-local diff --git a/docs/libs/gstreamer-libs-docs.sgml b/docs/libs/gstreamer-libs-docs.sgml index 49bf5e0..0cbe339 100644 --- a/docs/libs/gstreamer-libs-docs.sgml +++ b/docs/libs/gstreamer-libs-docs.sgml @@ -1,11 +1,10 @@ - - - - - - + + + + + ]> @@ -24,12 +23,10 @@ GStreamer provides some standard libraries you can use to create plugins. - &GstColorSpace; &GstGetbits; &GstIDCT; &GstPutbits; - &GstVideoScale; - &GstRiff; + &GstControl; diff --git a/docs/libs/gstreamer-libs-sections.txt b/docs/libs/gstreamer-libs-sections.txt index 0a9e91d..bb34c2e 100644 --- a/docs/libs/gstreamer-libs-sections.txt +++ b/docs/libs/gstreamer-libs-sections.txt @@ -1,275 +1,4 @@
-gstcolorspace -libs/colorspace/gstcolorspace.h -GstColorSpaceType -GstColorSpaceConverter -GstColorSpaceConvertFunction -GST_COLORSPACE_RGB_FIRST -GST_COLORSPACE_YUV_FIRST -GST_COLORSPACE_YUV_LAST -GST_COLORSPACE_RGB_LAST -GST_COLORSPACE_IS_YUV_TYPE -GST_COLORSPACE_IS_RGB_TYPE -gst_colorspace_converter_new -gst_colorspace_convert -gst_colorspace_destroy - -
- - -
-gstriff -libs/riff/gstriff.h -GstRiffReturn -GstRiffParserState -GST_RIFF_OK -GST_RIFF_ENOTRIFF -GST_RIFF_EINVAL -GST_RIFF_ENOMEM -GST_RIFF_STATE_INITIAL -GST_RIFF_STATE_HASAVIH -GST_RIFF_STATE_HASSTRH -GST_RIFF_STATE_HASSTRF -GST_RIFF_STATE_MOVI -MAKE_FOUR_CC -GST_RIFF_RIFF_WAVE -GST_RIFF_RIFF_AVI -GST_RIFF_TAG_RIFF -GST_RIFF_TAG_RIFX -GST_RIFF_TAG_LIST -GST_RIFF_TAG_avih -GST_RIFF_TAG_strd -GST_RIFF_TAG_strh -GST_RIFF_TAG_strf -GST_RIFF_TAG_vedt -GST_RIFF_TAG_JUNK -GST_RIFF_TAG_idx1 -GST_RIFF_TAG_fmt -GST_RIFF_TAG_data -GST_RIFF_LIST_movi -GST_RIFF_LIST_hdrl -GST_RIFF_LIST_strl -GST_RIFF_FCC_vids -GST_RIFF_FCC_auds -GST_RIFF_FCC_pads -GST_RIFF_FCC_txts -GST_RIFF_FCC_vidc -GST_RIFF_FCCH_RLE -GST_RIFF_FCCH_msvc -GST_RIFF_FCCH_MSVC -GST_RIFF_FF00 -GST_RIFF_00 -GST_RIFF_01 -GST_RIFF_02 -GST_RIFF_03 -GST_RIFF_04 -GST_RIFF_05 -GST_RIFF_06 -GST_RIFF_07 -GST_RIFF_00pc -GST_RIFF_01pc -GST_RIFF_00dc -GST_RIFF_00dx -GST_RIFF_00db -GST_RIFF_00xx -GST_RIFF_00id -GST_RIFF_00rt -GST_RIFF_0021 -GST_RIFF_00iv -GST_RIFF_0031 -GST_RIFF_0032 -GST_RIFF_00vc -GST_RIFF_00xm -GST_RIFF_01wb -GST_RIFF_01dc -GST_RIFF_cram -GST_RIFF_CRAM -GST_RIFF_wham -GST_RIFF_WHAM -GST_RIFF_rgb -GST_RIFF_RGB -GST_RIFF_rle8 -GST_RIFF_RLE8 -GST_RIFF_rle4 -GST_RIFF_RLE4 -GST_RIFF_none -GST_RIFF_NONE -GST_RIFF_pack -GST_RIFF_PACK -GST_RIFF_tran -GST_RIFF_TRAN -GST_RIFF_ccc -GST_RIFF_CCC -GST_RIFF_cyuv -GST_RIFF_CYUV -GST_RIFF_jpeg -GST_RIFF_JPEG -GST_RIFF_MJPG -GST_RIFF_mJPG -GST_RIFF_IJPG -GST_RIFF_rt21 -GST_RIFF_RT21 -GST_RIFF_iv31 -GST_RIFF_IV31 -GST_RIFF_iv32 -GST_RIFF_IV32 -GST_RIFF_iv41 -GST_RIFF_IV41 -GST_RIFF_iv50 -GST_RIFF_IV50 -GST_RIFF_cvid -GST_RIFF_CVID -GST_RIFF_ULTI -GST_RIFF_ulti -GST_RIFF_YUV9 -GST_RIFF_YVU9 -GST_RIFF_XMPG -GST_RIFF_xmpg -GST_RIFF_VDOW -GST_RIFF_MVI1 -GST_RIFF_v422 -GST_RIFF_V422 -GST_RIFF_mvi1 -GST_RIFF_MPIX -GST_RIFF_AURA -GST_RIFF_DMB1 -GST_RIFF_dmb1 -GST_RIFF_BW10 -GST_RIFF_bw10 -GST_RIFF_yuy2 -GST_RIFF_YUY2 -GST_RIFF_YUV8 -GST_RIFF_WINX -GST_RIFF_WPY2 -GST_RIFF_m263 -GST_RIFF_M263 -GST_RIFF_Q1_0 -GST_RIFF_SFMC -GST_RIFF_y41p -GST_RIFF_Y41P -GST_RIFF_yv12 -GST_RIFF_YV12 -GST_RIFF_vixl -GST_RIFF_VIXL -GST_RIFF_iyuv -GST_RIFF_IYUV -GST_RIFF_i420 -GST_RIFF_I420 -GST_RIFF_vyuy -GST_RIFF_VYUY -GST_RIFF_DIV3 -GST_RIFF_rpza -GST_RIFF_azpr -GST_RIFF_ISFT -GST_RIFF_IDIT -GST_RIFF_00AM -GST_RIFF_DISP -GST_RIFF_ISBJ -GST_RIFF_rec -gst_riff_avih -gst_riff_strh -gst_riff_strf_vids -gst_riff_strf_auds -gst_riff_riff -gst_riff_list -gst_riff_chunk -gst_riff_index_entry -GstRiff -GstRiffChunk -GstRiffCallback -gst_riff_parser_new -gst_riff_parser_next_buffer -gst_riff_parser_resync -gst_riff_encoder_new -gst_riff_encoder_avih -gst_riff_encoder_strh -gst_riff_encoder_strf -gst_riff_encoder_chunk -gst_riff_encoder_get_buffer -gst_riff_encoder_get_and_reset_buffer -gst_riff_fourcc_to_id -gst_riff_id_to_fourcc -
- -
-gstgetbits_inl -debug2 -debug -checklength2 -checklength -swab32 -gst_getbits_init -gst_getbits_newbuf -gst_getbits_bitoffset -gst_getbits_bufferpos -gst_getbits_bytesleft -gst_getbits_bitsleft -gst_getbits1 -gst_getbits2 -gst_getbitsX -gst_getbits3 -gst_getbits4 -gst_getbits5 -gst_getbits6 -gst_getbits7 -gst_getbits8 -gst_getbits9 -gst_getbits10 -gst_getbits11 -gst_getbits12 -gst_getbits13 -gst_getbits14 -gst_getbits15 -gst_getbits16 -gst_getbits17 -gst_getbits18 -gst_getbits19 -gst_getbits20 -gst_getbits21 -gst_getbits22 -gst_getbits32 -gst_getbitsn -gst_showbits32 -gst_showbitsX -gst_showbits1 -gst_showbits2 -gst_showbits3 -gst_showbits4 -gst_showbits5 -gst_showbits6 -gst_showbits7 -gst_showbits8 -gst_showbits9 -gst_showbits10 -gst_showbits11 -gst_showbits12 -gst_showbits13 -gst_showbits14 -gst_showbits15 -gst_showbits16 -gst_showbits17 -gst_showbits18 -gst_showbits19 -gst_showbits20 -gst_showbits21 -gst_showbits22 -gst_showbits23 -gst_showbits24 -gst_showbits25 -gst_showbits26 -gst_showbits27 -gst_showbits28 -gst_showbits29 -gst_showbits30 -gst_showbits31 -gst_showbitsn -gst_flushbits32 -gst_flushbitsn -gst_backbits24 -gst_backbitsn -
- -
gstgetbits libs/getbits/gstgetbits.h gst_getbits_t @@ -350,17 +79,6 @@ DEBUG
-gstvideoscale -libs/videoscale/gstvideoscale.h -GstVideoScaleMethod -GstVideoScale -GstVideoScaleScaler -gst_videoscale_new -gst_videoscale_scale -gst_videoscale_destroy -
- -
gstputbits libs/putbits/gstputbits.h gst_putbits_t @@ -398,25 +116,6 @@ gst_putbits
-externals -ext_unknown -
- -
-wineacm -MSACM_hHeap -MSACM_pFirstACMDriverID -MSACM_pLastACMDriverID -MSACM_RegisterDriver -MSACM_RegisterAllDrivers -MSACM_UnregisterDriver -MSACM_UnregisterAllDrivers -MSACM_GetDriverID -MSACM_GetDriver -MSACM_GetObj -
- -
dct DCTSIZE DCTSIZE2 @@ -447,3 +146,8 @@ gst_idct_convert_sparse gst_idct_destroy
+
+gstcontrol +libs/control/control.h +gst_control_init +
-- 2.7.4