The gtk-doc documentation isn't buildable because the makefiles were not hooked up, and after fixing that the documentation has bitrotted sufficiently that it's not useful.
Signed-off-by: Ross Burton <[email protected]> --- .gitignore | 4 - HACKING | 35 --------- Makefile.am | 3 +- acinclude.m4 | 34 --------- bootstrap-configure | 4 - configure.ac | 4 +- doc/Makefile.am | 38 ---------- doc/connman-docs.xml | 121 ------------------------------ doc/connman-introduction.xml | 15 ---- doc/gtk-doc.make | 173 ------------------------------------------- doc/version.xml.in | 1 - 11 files changed, 2 insertions(+), 430 deletions(-) delete mode 100644 doc/Makefile.am delete mode 100644 doc/connman-docs.xml delete mode 100644 doc/connman-introduction.xml delete mode 100644 doc/gtk-doc.make delete mode 100644 doc/version.xml.in diff --git a/.gitignore b/.gitignore index fef03aa..05e27fb 100644 --- a/.gitignore +++ b/.gitignore @@ -67,10 +67,6 @@ doc/connman.* !doc/connman.8 !doc/connman.conf.5 doc/connman-*.txt -doc/*.sgml -doc/version.xml -doc/xml -doc/html vpn/builtin.h vpn/connman-vpnd diff --git a/HACKING b/HACKING index 05fb69c..80382ed 100644 --- a/HACKING +++ b/HACKING @@ -107,38 +107,3 @@ can get very complex. The first detail inside "{ ... }" is the interface name (without its service name prefix). The second detail inside "[ ... ]" is the object path. And after that it is followed by a key and value of the property that changed. - - -Generating source code documentation -==================================== - -The source code is annotated using the gtk-doc style documentation. This -allows an easy way of generating API documentation. The "bootstrap-configure" -script will use the "--enable-gtk-doc" configure to enable the generation of -the documentation. - -To make the gtk-doc process work, the gtk-doc tools need to be installed. -Every distribution should provide a package for this, but the naming of the -package might be different: - - Debian - # apt-get install gtk-doc-tools - - Ubuntu - # apt-get install gtk-doc-utils - - Fedora - # yum install gtk-doc - -In case "bootstrap-configure" is not used, the manual steps for generating -the documentation files are like this: - - Configuring the repository - # ./configure --enable-gtk-doc - - Generate the documentation - # cd doc && make - - View documentation - # firefox doc/html/index.html - diff --git a/Makefile.am b/Makefile.am index 5efa811..283e324 100644 --- a/Makefile.am +++ b/Makefile.am @@ -385,8 +385,7 @@ pkgconfigdir = $(libdir)/pkgconfig pkgconfig_DATA = connman.pc -DISTCHECK_CONFIGURE_FLAGS = --disable-gtk-doc \ - --disable-datafiles \ +DISTCHECK_CONFIGURE_FLAGS = --disable-datafiles \ --enable-hh2serial-gps \ --enable-openconnect \ --enable-openvpn \ diff --git a/acinclude.m4 b/acinclude.m4 index 65118da..9e8e0dc 100644 --- a/acinclude.m4 +++ b/acinclude.m4 @@ -25,37 +25,3 @@ AC_DEFUN([COMPILER_FLAGS], [ CFLAGS="$CFLAGS -DG_DISABLE_DEPRECATED" fi ]) - -AC_DEFUN([GTK_DOC_CHECK], -[ - AC_BEFORE([AC_PROG_LIBTOOL],[$0])dnl setup libtool first - AC_BEFORE([AM_PROG_LIBTOOL],[$0])dnl setup libtool first - dnl for overriding the documentation installation directory - AC_ARG_WITH([html-dir], - AS_HELP_STRING([--with-html-dir=PATH], [path to installed docs]),, - [with_html_dir='${datadir}/gtk-doc/html']) - HTML_DIR="$with_html_dir" - AC_SUBST([HTML_DIR]) - - dnl enable/disable documentation building - AC_ARG_ENABLE([gtk-doc], - AS_HELP_STRING([--enable-gtk-doc], - [use gtk-doc to build documentation [[default=no]]]),, - [enable_gtk_doc=no]) - - if test x$enable_gtk_doc = xyes; then - ifelse([$1],[], - [PKG_CHECK_EXISTS([gtk-doc],, - AC_MSG_ERROR([gtk-doc not installed and --enable-gtk-doc requested]))], - [PKG_CHECK_EXISTS([gtk-doc >= $1],, - AC_MSG_ERROR([You need to have gtk-doc >= $1 installed to build gtk-doc]))]) - fi - - AC_MSG_CHECKING([whether to build gtk-doc documentation]) - AC_MSG_RESULT($enable_gtk_doc) - - AC_PATH_PROGS(GTKDOC_CHECK,gtkdoc-check,) - - AM_CONDITIONAL([ENABLE_GTK_DOC], [test x$enable_gtk_doc = xyes]) - AM_CONDITIONAL([GTK_DOC_USE_LIBTOOL], [test -n "$LIBTOOL"]) -]) diff --git a/bootstrap-configure b/bootstrap-configure index 0741bcd..070c676 100755 --- a/bootstrap-configure +++ b/bootstrap-configure @@ -4,10 +4,6 @@ if [ -f config.status ]; then make maintainer-clean fi -if [ ! -f doc/gtk-doc.make ]; then - gtkdocize --copy --docdir doc -fi - ./bootstrap && \ ./configure --enable-maintainer-mode \ --enable-debug \ diff --git a/configure.ac b/configure.ac index ca4852e..534dc14 100644 --- a/configure.ac +++ b/configure.ac @@ -38,8 +38,6 @@ AC_ARG_ENABLE(optimization, AC_HELP_STRING([--disable-optimization], fi ]) -GTK_DOC_CHECK - AC_ARG_ENABLE(debug, AC_HELP_STRING([--enable-debug], [enable compiling with debugging information]), [ if (test "${enableval}" = "yes" && @@ -383,4 +381,4 @@ AM_CONDITIONAL(VPN, test "${enable_openconnect}" != "no" -o \ AC_OUTPUT(Makefile include/version.h src/connman.service vpn/connman-vpn.service vpn/net.connman.vpn.service - scripts/connman doc/version.xml connman.pc) + scripts/connman connman.pc) diff --git a/doc/Makefile.am b/doc/Makefile.am deleted file mode 100644 index ce3e433..0000000 --- a/doc/Makefile.am +++ /dev/null @@ -1,38 +0,0 @@ - -DOC_MODULE = connman - -DOC_MAIN_SGML_FILE = $(DOC_MODULE)-docs.xml - -DOC_SOURCE_DIR = ../src - -SCAN_OPTIONS = --rebuild-sections --source-dir=../include - -MKDB_OPTIONS = --sgml-mode --output-format=xml --tmpl-dir=. \ - --ignore-files=connman \ - --source-dir=../include \ - --source-suffixes=c,h - -MKTMPL_OPTIONS = --output-dir=. - -HFILE_GLOB = $(top_srcdir)/include/*.h -CFILE_GLOB = $(top_srcdir)/src/*.c $(top_srcdir)/src/*.h - -IGNORE_HFILES = connman connman.h - -HTML_IMAGES = - -content_files = connman-introduction.xml - -INCLUDES = -I$(top_srcdir)/include -I$(top_srcdir)/gdbus \ - $(GTHREAD_CFLAGS) $(GMODULE_CFLAGS) $(GLIB_CFLAGS) $(DBUS_CFLAGS) - -GTKDOC_LIBS = $(DBUS_LIBS) $(GLIB_LIBS) $(GMODULE_LIBS) $(GTHREAD_LIBS) - -MAINTAINERCLEANFILES = Makefile.in \ - $(DOC_MODULE).types $(DOC_MODULE)-*.txt *.sgml *.bak - -if ENABLE_GTK_DOC -include $(top_srcdir)/doc/gtk-doc.make -else -EXTRA_DIST = $(DOC_MAIN_SGML_FILE) connman-introduction.xml -endif diff --git a/doc/connman-docs.xml b/doc/connman-docs.xml deleted file mode 100644 index d4059a4..0000000 --- a/doc/connman-docs.xml +++ /dev/null @@ -1,121 +0,0 @@ -<?xml version="1.0"?> -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" - "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"; [ -<!ENTITY version SYSTEM "version.xml"> -]> -<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude";> - <bookinfo> - <title>Connection Manager Reference Manual</title> - <releaseinfo>Version &version;</releaseinfo> - <authorgroup> - <author> - <firstname>Marcel</firstname> - <surname>Holtmann</surname> - <affiliation> - <address> - <email>[email protected]</email> - </address> - </affiliation> - </author> - </authorgroup> - - <copyright> - <year>2007-2008</year> - <holder>Intel Corporation. All rights reserved.</holder> - </copyright> - - <legalnotice> - <para> - Permission is granted to copy, distribute and/or modify this - document under the terms of the <citetitle>GNU Free - Documentation License</citetitle>, Version 1.1 or any later - version published by the Free Software Foundation with no - Invariant Sections, no Front-Cover Texts, and no Back-Cover - Texts. You may obtain a copy of the <citetitle>GNU Free - Documentation License</citetitle> from the Free Software - Foundation by visiting <ulink type="http" - url="http://www.fsf.org";>their Web site</ulink> or by writing - to: - - <address> - The Free Software Foundation, Inc., - <street>59 Temple Place</street> - Suite 330, - <city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode>, - <country>USA</country> - </address> - </para> - </legalnotice> - </bookinfo> - - <reference id="design"> - <title>Design Overview</title> - <partintro> - <para> - This part presents the design documentation for Connection Manager. - </para> - </partintro> - <xi:include href="connman-introduction.xml" /> - </reference> - - <reference id="manager"> - <title>Manager interface</title> - <para> -<programlisting><xi:include href="manager-api.txt" parse="text" /></programlisting> - </para> - </reference> - - <reference id="device"> - <title>Device interface</title> - <para> -<programlisting><xi:include href="device-api.txt" parse="text" /></programlisting> - </para> - </reference> - - <reference id="network"> - <title>Network interface</title> - <para> -<programlisting><xi:include href="network-api.txt" parse="text" /></programlisting> - </para> - </reference> - - <reference id="service"> - <title>Service interface</title> - <para> -<programlisting><xi:include href="service-api.txt" parse="text" /></programlisting> - </para> - </reference> - - <reference id="connection"> - <title>Connection interface</title> - <para> -<programlisting><xi:include href="connection-api.txt" parse="text" /></programlisting> - </para> - </reference> - - <reference id="reference"> - <title>Plugin API Reference</title> - <partintro> - <para> - This part presents the function reference for Connection Manager. - </para> - </partintro> - <xi:include href="xml/log.xml" /> - <xi:include href="xml/plugin.xml" /> - <xi:include href="xml/storage.xml" /> - <xi:include href="xml/security.xml" /> - <xi:include href="xml/resolver.xml" /> - <!-- <xi:include href="xml/device.xml" /> --> - <!-- <xi:include href="xml/network.xml" /> --> - </reference> - - <appendix id="license"> - <title>License</title> - <para> -<programlisting><xi:include href="../COPYING" parse="text" /></programlisting> - </para> - </appendix> - - <index> - <title>Index</title> - </index> -</book> diff --git a/doc/connman-introduction.xml b/doc/connman-introduction.xml deleted file mode 100644 index 4672c2c..0000000 --- a/doc/connman-introduction.xml +++ /dev/null @@ -1,15 +0,0 @@ -<?xml version="1.0"?> -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" - "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd";> - -<chapter id="introduction"> - <title>Introduction</title> - - <sect1 id="intro-about"> - <title>About</title> - - <para> - </para> - </sect1> - -</chapter> diff --git a/doc/gtk-doc.make b/doc/gtk-doc.make deleted file mode 100644 index 354ffb7..0000000 --- a/doc/gtk-doc.make +++ /dev/null @@ -1,173 +0,0 @@ -# -*- mode: makefile -*- - -#################################### -# Everything below here is generic # -#################################### - -if GTK_DOC_USE_LIBTOOL -GTKDOC_CC = $(LIBTOOL) --mode=compile $(CC) $(INCLUDES) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS) -GTKDOC_LD = $(LIBTOOL) --mode=link $(CC) $(AM_CFLAGS) $(CFLAGS) $(AM_LDFLAGS) $(LDFLAGS) -else -GTKDOC_CC = $(CC) $(INCLUDES) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS) -GTKDOC_LD = $(CC) $(AM_CFLAGS) $(CFLAGS) $(AM_LDFLAGS) $(LDFLAGS) -endif - -# 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) - -TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE) - -EXTRA_DIST = \ - $(content_files) \ - $(HTML_IMAGES) \ - $(DOC_MAIN_SGML_FILE) \ - $(DOC_MODULE)-sections.txt \ - $(DOC_MODULE)-overrides.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 \ - $(DOC_MODULE).signals - -REPORT_FILES = \ - $(DOC_MODULE)-undocumented.txt \ - $(DOC_MODULE)-undeclared.txt \ - $(DOC_MODULE)-unused.txt - -CLEANFILES = $(SCANOBJ_FILES) $(REPORT_FILES) $(DOC_STAMPS) - -if ENABLE_GTK_DOC -all-local: html-build.stamp -else -all-local: -endif - -docs: html-build.stamp - -#### scan #### - -scan-build.stamp: $(HFILE_GLOB) $(CFILE_GLOB) - @echo 'gtk-doc: Scanning header files' - @-chmod -R u+w $(srcdir) - cd $(srcdir) && \ - gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="$(IGNORE_HFILES)" $(SCAN_OPTIONS) $(EXTRA_HFILES) - if grep -l '^..*$$' $(srcdir)/$(DOC_MODULE).types > /dev/null 2>&1 ; then \ - CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" CFLAGS="$(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)" gtkdoc-scangobj $(SCANGOBJ_OPTIONS) --module=$(DOC_MODULE) --output-dir=$(srcdir) ; \ - else \ - cd $(srcdir) ; \ - for i in $(SCANOBJ_FILES) ; do \ - test -f $$i || touch $$i ; \ - done \ - fi - touch scan-build.stamp - -$(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt: scan-build.stamp - @true - -#### templates #### - -tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt - @echo 'gtk-doc: Rebuilding template files' - @-chmod -R u+w $(srcdir) - cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE) $(MKTMPL_OPTIONS) - touch tmpl-build.stamp - -tmpl.stamp: tmpl-build.stamp - @true - -tmpl/*.sgml: - @true - - -#### xml #### - -sgml-build.stamp: tmpl.stamp $(HFILE_GLOB) $(CFILE_GLOB) $(DOC_MODULE)-sections.txt $(srcdir)/tmpl/*.sgml $(expand_content_files) - @echo 'gtk-doc: Building XML' - @-chmod -R u+w $(srcdir) - cd $(srcdir) && \ - gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --output-format=xml --expand-content-files="$(expand_content_files)" --main-sgml-file=$(DOC_MAIN_SGML_FILE) $(MKDB_OPTIONS) - touch sgml-build.stamp - -sgml.stamp: sgml-build.stamp - @true - -#### html #### - -html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files) - @echo 'gtk-doc: Building HTML' - @-chmod -R u+w $(srcdir) - rm -rf $(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 'gtk-doc: Fixing cross-references' - cd $(srcdir) && gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS) - touch html-build.stamp - -############## - -clean-local: - rm -f *~ *.bak - rm -rf .libs - -distclean-local: - cd $(srcdir) && \ - rm -rf xml $(REPORT_FILES) \ - $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt - -maintainer-clean-local: clean - cd $(srcdir) && rm -rf xml html - -install-data-local: - -installfiles=`echo $(srcdir)/html/*`; \ - if test "$$installfiles" = '$(srcdir)/html/*'; \ - then echo '-- Nothing to install' ; \ - else \ - $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR); \ - for i in $$installfiles; do \ - echo '-- Installing '$$i ; \ - $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \ - done; \ - echo '-- Installing $(srcdir)/html/index.sgml' ; \ - $(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR) || :; \ - which gtkdoc-rebase >/dev/null && \ - gtkdoc-rebase --relative --dest-dir=$(DESTDIR) --html-dir=$(DESTDIR)$(TARGET_DIR) ; \ - fi - - -uninstall-local: - rm -f $(DESTDIR)$(TARGET_DIR)/* - -# -# Require gtk-doc when making dist -# -if ENABLE_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)/xml/*.xml $(distdir)/xml - cp $(srcdir)/html/* $(distdir)/html - -cp $(srcdir)/$(DOC_MODULE).types $(distdir)/ - -cp $(srcdir)/$(DOC_MODULE)-sections.txt $(distdir)/ - cd $(distdir) && rm -f $(DISTCLEANFILES) - -gtkdoc-rebase --online --relative --html-dir=$(distdir)/html - -.PHONY : dist-hook-local docs diff --git a/doc/version.xml.in b/doc/version.xml.in deleted file mode 100644 index d78bda9..0000000 --- a/doc/version.xml.in +++ /dev/null @@ -1 +0,0 @@ -@VERSION@ -- 1.8.5 _______________________________________________ connman mailing list [email protected] https://lists.connman.net/mailman/listinfo/connman
