Move docs/reference to docs/reference/telepathy-glib

This will let us merge other projects into this source tree.

12 files changed, 185 insertions, 181 deletions

diff --git a/.gitignore b/.gitignore
index c5288b726..bf290d652 100644
--- a/.gitignore
+++ b/.gitignore
@@ -36,22 +36,22 @@ config.sub
 configure
 cscope.out
 depcomp
-docs/reference/*-decl.txt
-docs/reference/*-decl-list.txt
-docs/reference/*-undeclared.txt
-docs/reference/*-undocumented.txt
-docs/reference/*-unused.txt
-docs/reference/*.args
-docs/reference/*.hierarchy
-docs/reference/*.interfaces
-docs/reference/*.prerequisites
-docs/reference/*.signals
-docs/reference/*.stamp
-docs/reference/*.types
-/docs/reference/version.xml
-docs/reference/html
-docs/reference/tmpl/*.sgml
-docs/reference/xml
+/docs/reference/telepathy-glib/*-decl.txt
+/docs/reference/telepathy-glib/*-decl-list.txt
+/docs/reference/telepathy-glib/*-undeclared.txt
+/docs/reference/telepathy-glib/*-undocumented.txt
+/docs/reference/telepathy-glib/*-unused.txt
+/docs/reference/telepathy-glib/*.args
+/docs/reference/telepathy-glib/*.hierarchy
+/docs/reference/telepathy-glib/*.interfaces
+/docs/reference/telepathy-glib/*.prerequisites
+/docs/reference/telepathy-glib/*.signals
+/docs/reference/telepathy-glib/*.stamp
+/docs/reference/telepathy-glib/*.types
+/docs/reference/telepathy-glib/version.xml
+/docs/reference/telepathy-glib/html
+/docs/reference/telepathy-glib/tmpl/*.sgml
+/docs/reference/telepathy-glib/xml
 examples/client/telepathy-example-*
 examples/cm/*/telepathy-example-*
 examples/extensions/extensions.html
diff --git a/Makefile.am b/Makefile.am
index faf2fa71f..4010e9adb 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -36,14 +36,14 @@ check-valgrind:
 
 maintainer-upload-release: _maintainer-upload-release-local
 _maintainer-upload-release-local: _maintainer-upload-release-check
-	rsync -rvzPp --chmod=Dg+s,ug+rwX,o=rX $(builddir)/docs/reference/html/ \
+	rsync -rvzPp --chmod=Dg+s,ug+rwX,o=rX $(builddir)/docs/reference/telepathy-glib/html/ \
 	telepathy.freedesktop.org:/srv/telepathy.freedesktop.org/www/doc/telepathy-glib-1/
 
 BRANCH = $(shell sh tools/git-which-branch.sh misc | tr -d '\n' | tr -C "[:alnum:]" _)
 UPLOAD_BRANCH_TO = people.freedesktop.org:public_html/telepathy-glib
 
 upload-branch-docs: all
-	rsync -rtzvPp --chmod=a+rX docs/reference/html/ \
+	rsync -rtzvPp --chmod=a+rX docs/reference/telepathy-glib/html/ \
 		$(UPLOAD_BRANCH_TO)-$(BRANCH)/
 
 include tools/lcov.am
diff --git a/configure.ac b/configure.ac
index 4800c70eb..5f54dcc28 100644
--- a/configure.ac
+++ b/configure.ac
@@ -321,7 +321,8 @@ AM_CONDITIONAL([HAVE_CXX], [test $tp_cxx_works = yes])
 AC_OUTPUT( Makefile \
 	   docs/Makefile \
 	   docs/reference/Makefile \
-	   docs/reference/version.xml \
+	   docs/reference/telepathy-glib/Makefile \
+	   docs/reference/telepathy-glib/version.xml \
 	   examples/Makefile \
 	   examples/client/Makefile \
 	   examples/client/js/Makefile \
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
index 4f7b9a99b..b2d87e85c 100644
--- a/docs/reference/Makefile.am
+++ b/docs/reference/Makefile.am
@@ -1,160 +1,3 @@
-## Process this file with automake to produce Makefile.in
-
-# We require automake 1.6 at least.
-AUTOMAKE_OPTIONS = 1.6
-
-# This is a blank Makefile.am for using gtk-doc.
-# Copy this to your project's API docs directory and modify the variables to
-# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples
-# of using the various options.
-
-# The name of the module, e.g. 'glib'.
-DOC_MODULE=telepathy-glib
-
-# Uncomment for versioned docs and specify the version of the module, e.g. '2'.
-#DOC_MODULE_VERSION=2
-
-
-# The top-level SGML file. You can change this if you want to.
-DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
-
-# Directories containing the source code, relative to $(srcdir).
-# gtk-doc will search all .c and .h files beneath these paths
-# for inline comments documenting functions and macros.
-# e.g. DOC_SOURCE_DIR=../../../gtk ../../../gdk
-DOC_SOURCE_DIR=$(abs_top_srcdir)/telepathy-glib $(abs_top_builddir)/telepathy-glib
-
-# Extra options to pass to gtkdoc-scangobj. Not normally needed.
-SCANGOBJ_OPTIONS=
-
-# Extra options to supply to gtkdoc-scan.
-# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
-SCAN_OPTIONS=\
-    --deprecated-guards=TP_DISABLE_DEPRECATED \
-    --ignore-decorators='_TP_GNUC_DEPRECATED|_TP_GNUC_DEPRECATED_FOR\s*\([^\)]+\)' \
-    --rebuild-types
-
-# Extra options to supply to gtkdoc-mkdb.
-# e.g. MKDB_OPTIONS=--xml-mode --output-format=xml
-MKDB_OPTIONS=--sgml-mode --output-format=xml
-
-# Extra options to supply to gtkdoc-mktmpl
-# e.g. MKTMPL_OPTIONS=--only-section-tmpl
-MKTMPL_OPTIONS=
-
-# Extra options to supply to gtkdoc-mkhtml
-MKHTML_OPTIONS=
-
-# Extra options to supply to gtkdoc-fixref. Not normally needed.
-# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
-FIXXREF_OPTIONS=
-
-# Used for dependencies. The docs will be rebuilt if any of these change.
-# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
-# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
-HFILE_GLOB=$(top_srcdir)/telepathy-glib/*.h $(top_builddir)/telepathy-glib/_gen/*.h
-CFILE_GLOB=$(top_srcdir)/telepathy-glib/*.c $(top_builddir)/telepathy-glib/_gen/*.c
-
-# Extra header to include when scanning, which are not under DOC_SOURCE_DIR
-# e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
-EXTRA_HFILES=
-
-# Header files or dirs to ignore when scanning. Use base file/dir names
-# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h private_code
-IGNORE_HFILES=\
-    proxy-introspectable.h \
-    $(NULL)
-
-# Images to copy into HTML directory.
-# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
-HTML_IMAGES=
-
-# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
-# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
-content_files=tp-svc.xml version.xml
-
-# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
-# These files must be listed here *and* in content_files
-# e.g. expand_content_files=running.sgml
-expand_content_files=
-
-# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
-# Only needed if you are using gtkdoc-scangobj to dynamically query widget
-# signals and properties.
-# e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
-# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
-GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) @DBUS_CFLAGS@ @GLIB_CFLAGS@
-GTKDOC_LIBS = \
-    $(top_builddir)/telepathy-glib/libtelepathy-glib-1.la \
-    $(top_builddir)/telepathy-glib/libtelepathy-glib-1-dbus.la \
-    $(top_builddir)/telepathy-glib/libtelepathy-glib-1-core.la \
-    $(DBUS_LIBS) \
-    $(GLIB_LIBS) \
-    $(NULL)
-
-# This includes the standard gtk-doc make rules, copied by gtkdocize.
-include $(top_srcdir)/gtk-doc.make
-
-# Other files to distribute
-# e.g. EXTRA_DIST += version.xml.in
-EXTRA_DIST += version.xml.in
-
-# Files not to distribute
-# for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
-# for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
-#DISTCLEANFILES +=
-
-# Work around gtk-doc using an outdated -sections.txt in out-of-tree builds:
-# redo the copy every time the files in the srcdir change
-setup-build.stamp: $(srcdir)/$(DOC_MODULE)-overrides.txt
-setup-build.stamp: $(srcdir)/$(DOC_MODULE)-sections.txt
-setup-build.stamp: $(srcdir)/$(DOC_MAIN_SGML_FILE)
-setup-build.stamp: $(srcdir)/tp-svc.xml
-
-if ENABLE_GTK_DOC
-check-local:
-	@err=0; \
-	if grep '^0 symbols incomplete' \
-		telepathy-glib-undocumented.txt; then\
-		:; \
-	else \
-		cat telepathy-glib-undocumented.txt; \
-		err=1; \
-	fi; \
-	if grep '^0 not documented' \
-		telepathy-glib-undocumented.txt; then\
-		:; \
-	else \
-		cat telepathy-glib-undocumented.txt; \
-		err=1; \
-	fi; \
-	if grep . telepathy-glib-unused.txt; then\
-		echo "^^^ Unused symbols" >&2; \
-		err=1; \
-	fi; \
-	if test -e telepathy-glib-undeclared.txt &&\
-		grep . telepathy-glib-undeclared.txt; then\
-		echo "^^^ Undeclared symbols" >&2; \
-		err=1; \
-	fi; \
-	sed -n -e 's,<FILE>\(.*\)</FILE>,\1,p' telepathy-glib-sections.txt |\
-	while read file; do \
-		if grep -F "xml/$$file.xml" telepathy-glib-docs.sgml \
-			>/dev/null;\
-		then \
-		:; \
-		else \
-			echo "$$file missing from telepathy-glib-docs.sgml"; \
-			err=1; \
-		fi; \
-	done; \
-	case $(enable_fatal_warnings)/$$err in \
-		(yes/1) \
-			echo "Documentation check failed" >&2; \
-			exit $$err; \
-			;; \
-		(*) \
-			exit 0; \
-			;; \
-	esac
-endif
+SUBDIRS = \
+	telepathy-glib \
+	$(NULL)
diff --git a/docs/reference/telepathy-glib/Makefile.am b/docs/reference/telepathy-glib/Makefile.am
new file mode 100644
index 000000000..4f7b9a99b
--- /dev/null
+++ b/docs/reference/telepathy-glib/Makefile.am
@@ -0,0 +1,160 @@
+## Process this file with automake to produce Makefile.in
+
+# We require automake 1.6 at least.
+AUTOMAKE_OPTIONS = 1.6
+
+# This is a blank Makefile.am for using gtk-doc.
+# Copy this to your project's API docs directory and modify the variables to
+# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples
+# of using the various options.
+
+# The name of the module, e.g. 'glib'.
+DOC_MODULE=telepathy-glib
+
+# Uncomment for versioned docs and specify the version of the module, e.g. '2'.
+#DOC_MODULE_VERSION=2
+
+
+# The top-level SGML file. You can change this if you want to.
+DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
+
+# Directories containing the source code, relative to $(srcdir).
+# gtk-doc will search all .c and .h files beneath these paths
+# for inline comments documenting functions and macros.
+# e.g. DOC_SOURCE_DIR=../../../gtk ../../../gdk
+DOC_SOURCE_DIR=$(abs_top_srcdir)/telepathy-glib $(abs_top_builddir)/telepathy-glib
+
+# Extra options to pass to gtkdoc-scangobj. Not normally needed.
+SCANGOBJ_OPTIONS=
+
+# Extra options to supply to gtkdoc-scan.
+# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
+SCAN_OPTIONS=\
+    --deprecated-guards=TP_DISABLE_DEPRECATED \
+    --ignore-decorators='_TP_GNUC_DEPRECATED|_TP_GNUC_DEPRECATED_FOR\s*\([^\)]+\)' \
+    --rebuild-types
+
+# Extra options to supply to gtkdoc-mkdb.
+# e.g. MKDB_OPTIONS=--xml-mode --output-format=xml
+MKDB_OPTIONS=--sgml-mode --output-format=xml
+
+# Extra options to supply to gtkdoc-mktmpl
+# e.g. MKTMPL_OPTIONS=--only-section-tmpl
+MKTMPL_OPTIONS=
+
+# Extra options to supply to gtkdoc-mkhtml
+MKHTML_OPTIONS=
+
+# Extra options to supply to gtkdoc-fixref. Not normally needed.
+# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
+FIXXREF_OPTIONS=
+
+# Used for dependencies. The docs will be rebuilt if any of these change.
+# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
+# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
+HFILE_GLOB=$(top_srcdir)/telepathy-glib/*.h $(top_builddir)/telepathy-glib/_gen/*.h
+CFILE_GLOB=$(top_srcdir)/telepathy-glib/*.c $(top_builddir)/telepathy-glib/_gen/*.c
+
+# Extra header to include when scanning, which are not under DOC_SOURCE_DIR
+# e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
+EXTRA_HFILES=
+
+# Header files or dirs to ignore when scanning. Use base file/dir names
+# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h private_code
+IGNORE_HFILES=\
+    proxy-introspectable.h \
+    $(NULL)
+
+# Images to copy into HTML directory.
+# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
+HTML_IMAGES=
+
+# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
+# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
+content_files=tp-svc.xml version.xml
+
+# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
+# These files must be listed here *and* in content_files
+# e.g. expand_content_files=running.sgml
+expand_content_files=
+
+# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
+# Only needed if you are using gtkdoc-scangobj to dynamically query widget
+# signals and properties.
+# e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
+# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
+GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) @DBUS_CFLAGS@ @GLIB_CFLAGS@
+GTKDOC_LIBS = \
+    $(top_builddir)/telepathy-glib/libtelepathy-glib-1.la \
+    $(top_builddir)/telepathy-glib/libtelepathy-glib-1-dbus.la \
+    $(top_builddir)/telepathy-glib/libtelepathy-glib-1-core.la \
+    $(DBUS_LIBS) \
+    $(GLIB_LIBS) \
+    $(NULL)
+
+# This includes the standard gtk-doc make rules, copied by gtkdocize.
+include $(top_srcdir)/gtk-doc.make
+
+# Other files to distribute
+# e.g. EXTRA_DIST += version.xml.in
+EXTRA_DIST += version.xml.in
+
+# Files not to distribute
+# for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
+# for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
+#DISTCLEANFILES +=
+
+# Work around gtk-doc using an outdated -sections.txt in out-of-tree builds:
+# redo the copy every time the files in the srcdir change
+setup-build.stamp: $(srcdir)/$(DOC_MODULE)-overrides.txt
+setup-build.stamp: $(srcdir)/$(DOC_MODULE)-sections.txt
+setup-build.stamp: $(srcdir)/$(DOC_MAIN_SGML_FILE)
+setup-build.stamp: $(srcdir)/tp-svc.xml
+
+if ENABLE_GTK_DOC
+check-local:
+	@err=0; \
+	if grep '^0 symbols incomplete' \
+		telepathy-glib-undocumented.txt; then\
+		:; \
+	else \
+		cat telepathy-glib-undocumented.txt; \
+		err=1; \
+	fi; \
+	if grep '^0 not documented' \
+		telepathy-glib-undocumented.txt; then\
+		:; \
+	else \
+		cat telepathy-glib-undocumented.txt; \
+		err=1; \
+	fi; \
+	if grep . telepathy-glib-unused.txt; then\
+		echo "^^^ Unused symbols" >&2; \
+		err=1; \
+	fi; \
+	if test -e telepathy-glib-undeclared.txt &&\
+		grep . telepathy-glib-undeclared.txt; then\
+		echo "^^^ Undeclared symbols" >&2; \
+		err=1; \
+	fi; \
+	sed -n -e 's,<FILE>\(.*\)</FILE>,\1,p' telepathy-glib-sections.txt |\
+	while read file; do \
+		if grep -F "xml/$$file.xml" telepathy-glib-docs.sgml \
+			>/dev/null;\
+		then \
+		:; \
+		else \
+			echo "$$file missing from telepathy-glib-docs.sgml"; \
+			err=1; \
+		fi; \
+	done; \
+	case $(enable_fatal_warnings)/$$err in \
+		(yes/1) \
+			echo "Documentation check failed" >&2; \
+			exit $$err; \
+			;; \
+		(*) \
+			exit 0; \
+			;; \
+	esac
+endif
diff --git a/docs/reference/telepathy-glib-docs.sgml b/docs/reference/telepathy-glib/telepathy-glib-docs.sgml
index acb1b1e56..acb1b1e56 100644
--- a/docs/reference/telepathy-glib-docs.sgml
+++ b/docs/reference/telepathy-glib/telepathy-glib-docs.sgml
diff --git a/docs/reference/telepathy-glib-overrides.txt b/docs/reference/telepathy-glib/telepathy-glib-overrides.txt
index e69de29bb..e69de29bb 100644
--- a/docs/reference/telepathy-glib-overrides.txt
+++ b/docs/reference/telepathy-glib/telepathy-glib-overrides.txt
diff --git a/docs/reference/telepathy-glib-sections.txt b/docs/reference/telepathy-glib/telepathy-glib-sections.txt
index e7c96f7f7..e7c96f7f7 100644
--- a/docs/reference/telepathy-glib-sections.txt
+++ b/docs/reference/telepathy-glib/telepathy-glib-sections.txt
diff --git a/docs/reference/tmpl/dummy.sgml b/docs/reference/telepathy-glib/tmpl/dummy.sgml
index e69de29bb..e69de29bb 100644
--- a/docs/reference/tmpl/dummy.sgml
+++ b/docs/reference/telepathy-glib/tmpl/dummy.sgml
diff --git a/docs/reference/tp-svc.xml b/docs/reference/telepathy-glib/tp-svc.xml
index 8c35d6de1..8c35d6de1 100644
--- a/docs/reference/tp-svc.xml
+++ b/docs/reference/telepathy-glib/tp-svc.xml
diff --git a/docs/reference/version.xml.in b/docs/reference/telepathy-glib/version.xml.in
index d78bda934..d78bda934 100644
--- a/docs/reference/version.xml.in
+++ b/docs/reference/telepathy-glib/version.xml.in
diff --git a/tests/all-errors-documented.py b/tests/all-errors-documented.py
index ae66df55f..3fa53fdbf 100755
--- a/tests/all-errors-documented.py
+++ b/tests/all-errors-documented.py
@@ -1,6 +1,6 @@
 #!/usr/bin/python
 # Check if all the errors have been added to
-# docs/reference/telepathy-glib-sections.txt
+# docs/reference/telepathy-glib/telepathy-glib-sections.txt
 
 import os
 import sys
@@ -12,7 +12,7 @@ from libglibcodegen import NS_TP
 def check_all_errors_documented(abs_top_srcdir):
     error_path = os.path.join(abs_top_srcdir, 'spec', 'errors.xml')
     sections_path = os.path.join(abs_top_srcdir, 'docs', 'reference',
-        'telepathy-glib-sections.txt')
+        'telepathy-glib', 'telepathy-glib-sections.txt')
     sections = open(sections_path).readlines()
 
     dom = xml.dom.minidom.parse(error_path)