[rygel] docs: Generalize the docs build more.
- From: Murray Cumming <murrayc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [rygel] docs: Generalize the docs build more.
- Date: Fri, 12 Oct 2012 09:37:12 +0000 (UTC)
commit 702e91aa2091f213b37cd07a36c3f6f62990cab3
Author: Murray Cumming <murrayc murrayc com>
Date: Fri Oct 12 11:36:38 2012 +0200
docs: Generalize the docs build more.
But the librygel-renderer-gst docs are still not correct.
doc/reference/doc-build.am | 24 ++++++++++++++++++++++-
doc/reference/librygel-core/Makefile.am | 13 +----------
doc/reference/librygel-renderer-gst/Makefile.am | 22 +++++++-------------
doc/reference/librygel-renderer/Makefile.am | 12 +---------
doc/reference/librygel-server/Makefile.am | 19 ++++-------------
src/librygel-renderer-gst/filelist.am | 2 +-
src/librygel-server/filelist.am | 2 +-
7 files changed, 42 insertions(+), 52 deletions(-)
---
diff --git a/doc/reference/doc-build.am b/doc/reference/doc-build.am
index 3d2a568..c5de605 100644
--- a/doc/reference/doc-build.am
+++ b/doc/reference/doc-build.am
@@ -1,11 +1,23 @@
# Other Makefile.am files should set:
# VALA_SOURCE_FILES, VALA_SOURCE_FILES_WITH_PATHS,
-# VALADOC_FLAGS, RYGEL_DOCBUILD_MODULE
+# RYGEL_DOCBUILD_VALADOC_FLAGS, RYGEL_DOCBUILD_MODULE
# and RYGEL_DOCBUILD_EXTRA_GTKDOC_OPTIONS
# and the include this .am file.
if ENABLE_VALADOC
+VALADOC_FLAGS = --force \
+ --vapidir $(top_srcdir)/src/lib$(RYGEL_DOCBUILD_MODULE) \
+ $(RYGEL_DOCBUILD_VALADOC_FLAGS) \
+ --target-glib=2.32 \
+ --vapidir=$(rygeldir) \
+ --pkg rygel-build-config \
+ -b $(top_srcdir)/src/lib$(RYGEL_DOCBUILD_MODULE) \
+ --package-name lib$(RYGEL_DOCBUILD_MODULE) \
+ --package-version 2.0 \
+ $(VALA_SOURCE_FILES_WITH_PATHS)
+
+
valadoc-gen: $(VALA_SOURCE_FILES_WITH_PATHS)
$(AM_V_GEN)$(VALADOC) \
-o valadoc \
@@ -20,11 +32,21 @@ gtkdoc-gen: $(VALA_SOURCE_FILES_WITH_PATHS) $(RYGEL_GTKDOC_DOCS_XML)
@rm -rf gtkdoc/html
$(AM_V_GEN)$(VALADOC) \
-X $(top_srcdir)/src/lib$(RYGEL_DOCBUILD_MODULE)/$(RYGEL_DOCBUILD_MODULE).h \
+ $(RYGEL_DOCBUILD_EXTRA_GTKDOC_OPTIONS) \
-X -l -X $(top_builddir)/src/lib$(RYGEL_DOCBUILD_MODULE)/.libs/lib$(RYGEL_DOCBUILD_MODULE)-2.0.so \
-o gtkdoc \
--doclet gtkdoc \
$(VALADOC_FLAGS)
+debugecho:
+ echo $(AM_V_GEN)$(VALADOC) \
+ -X $(top_srcdir)/src/lib$(RYGEL_DOCBUILD_MODULE)/$(RYGEL_DOCBUILD_MODULE).h \
+ $(RYGEL_DOCBUILD_EXTRA_GTKDOC_OPTIONS) \
+ -X -l -X $(top_builddir)/src/lib$(RYGEL_DOCBUILD_MODULE)/.libs/lib$(RYGEL_DOCBUILD_MODULE)-2.0.so \
+ -o gtkdoc \
+ --doclet gtkdoc \
+ $(VALADOC_FLAGS)
+
clean-local:
rm -rf valadoc gtkdoc/html
rm -f gtkdoc/html.stamp
diff --git a/doc/reference/librygel-core/Makefile.am b/doc/reference/librygel-core/Makefile.am
index d61279f..eeda5d4 100644
--- a/doc/reference/librygel-core/Makefile.am
+++ b/doc/reference/librygel-core/Makefile.am
@@ -10,18 +10,9 @@ VALA_SOURCE_FILES = $(LIBRYGEL_CORE_VAPI_SOURCE_FILES) \
VALA_SOURCE_FILES_WITH_PATHS = $(addprefix $(top_srcdir)/src/librygel-core/, $(VALA_SOURCE_FILES))
-VALADOC_FLAGS = --force \
- --vapidir $(top_srcdir)/src/librygel-core \
+RYGEL_DOCBUILD_VALADOC_FLAGS = \
$(RYGEL_COMMON_VALAFLAGS_PKG) \
- $(LIBRYGEL_CORE_VALAFLAGS_PKG) \
- --pkg gio-2.0 \
- --target-glib=2.32 \
- --vapidir=$(rygeldir) \
- --pkg rygel-build-config \
- -b $(top_srcdir)/src/librygel-core \
- --package-name librygel-core \
- --package-version 2.0 \
- $(VALA_SOURCE_FILES_WITH_PATHS)
+ $(LIBRYGEL_CORE_VALAFLAGS_PKG)
RYGEL_DOCBUILD_MODULE = rygel-core
RYGEL_DOCBUILD_EXTRA_GTKDOC_OPTIONS =
diff --git a/doc/reference/librygel-renderer-gst/Makefile.am b/doc/reference/librygel-renderer-gst/Makefile.am
index ca6db93..772bc1a 100644
--- a/doc/reference/librygel-renderer-gst/Makefile.am
+++ b/doc/reference/librygel-renderer-gst/Makefile.am
@@ -3,7 +3,7 @@ if ENABLE_VALADOC
include $(top_srcdir)/common.am
include $(top_srcdir)/src/librygel-renderer-gst/filelist.am
-# Note that LIBRYGEL_RENDERER_NONVAPI_SOURCE_FILES all (should) use the internal keyword
+# Note that LIBRYGEL_RENDERER_GST_NONVAPI_SOURCE_FILES all (should) use the internal keyword
# so they are not shown as part of the public API.
VALA_SOURCE_FILES = $(LIBRYGEL_RENDERER_GST_VAPI_SOURCE_FILES) \
$(LIBRYGEL_RENDERER_GST_NONVAPI_SOURCE_FILES)
@@ -15,24 +15,18 @@ VALA_SOURCE_FILES_WITH_PATHS = $(addprefix $(top_srcdir)/src/librygel-renderer-g
# TODO: The need for rygel-build-config here reminds us that we shouldn't need that in librygel-renderer-gst either.
# TODO: Why is gstreamer-pbutils-0.10 needed here, but not needed in librygel-renderer-gst/Makefile.am?
-VALADOC_FLAGS = --force \
+RYGEL_DOCBUILD_VALADOC_FLAGS = \
--vapidir $(top_srcdir)/src/librygel-core \
- --pkg rygel-core-2.0 --pkg rygel-renderer-2.0 \
- --vapidir $(top_srcdir)/src/librygel-renderer-gst \
+ --pkg rygel-core-2.0 \
--vapidir $(top_srcdir)/src/librygel-renderer \
- $(RYGEL_COMMON_VALAFLAGS_PKG) \
- $(LIBRYGEL_RENDERER_VALAFLAGS_PKG) \
+ --pkg rygel-renderer-2.0 \
--pkg gstreamer-pbutils-0.10 \
- --target-glib=2.32 \
- --vapidir=$(rygeldir) \
- --pkg rygel-build-config \
- -b $(top_srcdir)/src/librygel-renderer-gst \
- --package-name librygel-renderer-gst \
- --package-version 2.0 \
- $(VALA_SOURCE_FILES_WITH_PATHS)
+ $(RYGEL_COMMON_VALAFLAGS_PKG) \
+ $(LIBRYGEL_RENDERER_GST_VALAFLAGS_PKG)
RYGEL_DOCBUILD_MODULE = rygel-renderer-gst
-RYGEL_DOCBUILD_EXTRA_GTKDOC_OPTIONS = -X -l -X $(top_builddir)/src/librygel-core/.libs/librygel-core-2.0.so
+RYGEL_DOCBUILD_EXTRA_GTKDOC_OPTIONS = -X -l -X $(top_builddir)/src/librygel-core/.libs/librygel-core-2.0.so \
+ -X -l -X $(top_builddir)/src/librygel-renderer/.libs/librygel-renderer-2.0.so
endif
include $(top_srcdir)/doc/reference/doc-build.am
diff --git a/doc/reference/librygel-renderer/Makefile.am b/doc/reference/librygel-renderer/Makefile.am
index 7d24dd1..dc073c5 100644
--- a/doc/reference/librygel-renderer/Makefile.am
+++ b/doc/reference/librygel-renderer/Makefile.am
@@ -12,19 +12,11 @@ VALA_SOURCE_FILES_WITH_PATHS = $(addprefix $(top_srcdir)/src/librygel-renderer/,
# TODO: The need for rygel-build-config here reminds us that we shouldn't need that in librygel-renderer either.
# TODO: Why is gstreamer-pbutils-0.10 needed here, but not needed in librygel-renderer/Makefile.am?
-VALADOC_FLAGS = --force \
+RYGEL_DOCBUILD_VALADOC_FLAGS = \
--vapidir $(top_srcdir)/src/librygel-core \
--pkg rygel-core-2.0 \
- --vapidir $(top_srcdir)/src/librygel-renderer \
$(RYGEL_COMMON_VALAFLAGS_PKG) \
- $(LIBRYGEL_RENDERER_VALAFLAGS_PKG) \
- --target-glib=2.32 \
- --vapidir=$(rygeldir) \
- --pkg rygel-build-config \
- -b $(top_srcdir)/src/librygel-renderer \
- --package-name librygel-renderer \
- --package-version 2.0 \
- $(VALA_SOURCE_FILES_WITH_PATHS)
+ $(LIBRYGEL_RENDERER_VALAFLAGS_PKG)
RYGEL_DOCBUILD_MODULE = rygel-renderer
RYGEL_DOCBUILD_EXTRA_GTKDOC_OPTIONS = -X -l -X $(top_builddir)/src/librygel-core/.libs/librygel-core-2.0.so
diff --git a/doc/reference/librygel-server/Makefile.am b/doc/reference/librygel-server/Makefile.am
index c278d19..db8b17e 100644
--- a/doc/reference/librygel-server/Makefile.am
+++ b/doc/reference/librygel-server/Makefile.am
@@ -14,20 +14,11 @@ VALA_SOURCE_FILES_WITH_PATHS = $(addprefix $(top_srcdir)/src/librygel-server/, $
# echo $(VALA_SOURCE_FILES_WITH_PATHS);
# TODO: The need for rygel-build-config here reminds us that we shouldn't need that in librygel-server either.
-# TODO: Why is gstreamer-pbutils-0.10 needed here, but not needed in librygel-server/Makefile.am?
-VALADOC_FLAGS = --force \
- --vapidir $(top_srcdir)/src/librygel-core \
- --pkg rygel-core-2.0 \
- --vapidir $(top_srcdir)/src/librygel-server \
- $(RYGEL_COMMON_VALAFLAGS_PKG) \
- $(LIBRYGEL_SERVER_VALAFLAGS_PKG) \
- --target-glib=2.32 \
- --vapidir=$(rygeldir) \
- --pkg rygel-build-config \
- -b $(top_srcdir)/src/librygel-server \
- --package-name librygel-server \
- --package-version 2.0 \
- $(VALA_SOURCE_FILES_WITH_PATHS)
+RYGEL_DOCBUILD_VALADOC_FLAGS = \
+ --vapidir $(top_srcdir)/src/librygel-core \
+ --pkg rygel-core-2.0 \
+ $(RYGEL_COMMON_VALAFLAGS_PKG) \
+ $(LIBRYGEL_SERVER_VALAFLAGS_PKG)
RYGEL_DOCBUILD_MODULE = rygel-server
diff --git a/src/librygel-renderer-gst/filelist.am b/src/librygel-renderer-gst/filelist.am
index c6fcc9d..c21215d 100644
--- a/src/librygel-renderer-gst/filelist.am
+++ b/src/librygel-renderer-gst/filelist.am
@@ -3,6 +3,6 @@ LIBRYGEL_RENDERER_GST_VAPI_SOURCE_FILES = \
rygel-playbin-plugin.vala \
rygel-playbin-renderer.vala
-LIBRYGEL_RENDERER_GST_NONVAPI_SOURCE_FILES =
+LIBRYGEL_RENDERER_GST_NONVAPI_SOURCE_FILES =
LIBRYGEL_RENDERER_GST_VALAFLAGS_PKG = --pkg gstreamer-0.10
diff --git a/src/librygel-server/filelist.am b/src/librygel-server/filelist.am
index a389709..3db81d6 100644
--- a/src/librygel-server/filelist.am
+++ b/src/librygel-server/filelist.am
@@ -32,7 +32,7 @@ LIBRYGEL_SERVER_NONVAPI_SOURCE_FILES = \
rygel-client-hacks.vala \
rygel-content-directory.vala \
rygel-dbus-thumbnailer.vala \
- rygel-engine-loader.vala \
+ rygel-engine-loader.vala \
rygel-http-byte-seek.vala \
rygel-http-get-handler.vala \
rygel-http-get.vala \
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]