summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorWill Thompson <will.thompson@collabora.co.uk>2011-09-07 16:38:37 +0100
committerWill Thompson <will.thompson@collabora.co.uk>2011-09-07 16:42:57 +0100
commit047a42ee82fa0d664d510f0ccbd13a802a98ca90 (patch)
tree61e2a2f259e3f37071e6669d77b6e5b71f61a3dc
parent6de9a91e02906b1cb8536010a71175e0dafb43e6 (diff)
Stop building docs for libmissioncontrol-server
I'm hitting a weird issue in gtk-doc where the handwritten .types file is overwritten with a generated one during distcheck (but not during normal out-of-tree builds). Given that we have a newer plugin API we're keener on, let's just stop building documentation for the old one. (Most distros do not distribute libmissioncontrol-server as a library anyway.) The mission-control-plugins documentation doesn't hit this issue because it doesn't have a handwritten .types file. Instead, it relies on gtk-doc generating it, and uses IGNORE_HFILES to filter out internal headers. This seems more maintainable, so if anyone wants to resurrect this old documentation, I'd do it that way.
-rw-r--r--configure.ac1
-rw-r--r--doc/reference/Makefile.am4
-rw-r--r--doc/reference/libmissioncontrol-server/Makefile.am107
-rw-r--r--doc/reference/libmissioncontrol-server/libmissioncontrol-server-docs.sgml25
-rw-r--r--doc/reference/libmissioncontrol-server/libmissioncontrol-server-overrides.txt0
-rw-r--r--doc/reference/libmissioncontrol-server/libmissioncontrol-server-sections.txt214
-rw-r--r--doc/reference/libmissioncontrol-server/libmissioncontrol-server.types26
-rw-r--r--doc/reference/libmissioncontrol-server/tmpl/dummy.sgml1
8 files changed, 0 insertions, 378 deletions
diff --git a/configure.ac b/configure.ac
index 691e0e71..d689c78c 100644
--- a/configure.ac
+++ b/configure.ac
@@ -361,7 +361,6 @@ AC_OUTPUT([
Makefile \
doc/Makefile \
doc/reference/Makefile \
-doc/reference/libmissioncontrol-server/Makefile \
doc/reference/mission-control-plugins/Makefile \
m4/Makefile \
mission-control.pc \
diff --git a/doc/reference/Makefile.am b/doc/reference/Makefile.am
index 2c31b407..75e686e9 100644
--- a/doc/reference/Makefile.am
+++ b/doc/reference/Makefile.am
@@ -1,5 +1 @@
SUBDIRS = mission-control-plugins
-
-if ENABLE_MCD_PLUGINS
-SUBDIRS += libmissioncontrol-server
-endif
diff --git a/doc/reference/libmissioncontrol-server/Makefile.am b/doc/reference/libmissioncontrol-server/Makefile.am
deleted file mode 100644
index cd2066d9..00000000
--- a/doc/reference/libmissioncontrol-server/Makefile.am
+++ /dev/null
@@ -1,107 +0,0 @@
-## 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=libmissioncontrol-server
-
-# 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)/src $(abs_top_builddir)/src
-
-# 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=
-
-# 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)/src/*.h
-CFILE_GLOB=$(top_srcdir)/src/*.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= stamp-mcd-enum-types.h \
- mcd-service-gen.h \
- mcd-signals-marshal.h
-
-# 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=
-
-# 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=
-
-# Undefine this so the scanner doesn't inherit the ultra-pedantic warnings used
-# for real code.
-AM_CFLAGS =
-
-# 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) \
- -I$(top_srcdir)/src \
- -I$(top_builddir)/src \
- $(DBUS_CFLAGS) \
- $(TELEPATHY_CFLAGS)
-GTKDOC_LIBS = \
- $(top_builddir)/mission-control-plugins/libmission-control-plugins.la \
- $(top_builddir)/src/libmissioncontrol-server.la \
- $(GCONF_LIBS) \
- $(GLIB_LIBS) \
- $(DBUS_LIBS) \
- $(TELEPATHY_LIBS)
-
-# 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 +=
diff --git a/doc/reference/libmissioncontrol-server/libmissioncontrol-server-docs.sgml b/doc/reference/libmissioncontrol-server/libmissioncontrol-server-docs.sgml
deleted file mode 100644
index 58de9ffd..00000000
--- a/doc/reference/libmissioncontrol-server/libmissioncontrol-server-docs.sgml
+++ /dev/null
@@ -1,25 +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">
-<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
- <bookinfo>
- <title>libmissioncontrol-server Reference Manual</title>
- </bookinfo>
-
- <chapter>
- <title>libmissioncontrol-server</title>
- <xi:include href="xml/mcd-master.xml"/>
- <xi:include href="xml/mcd-connection.xml"/>
- <xi:include href="xml/mcd-operation.xml"/>
- <xi:include href="xml/mcd-service.xml"/>
- <xi:include href="xml/mcd-channel.xml"/>
- <xi:include href="xml/mcd-manager.xml"/>
- <xi:include href="xml/mcd-mission.xml"/>
- <xi:include href="xml/mcd-proxy.xml"/>
- <xi:include href="xml/mcd-controller.xml"/>
- <xi:include href="xml/mcd-dispatcher.xml"/>
- <xi:include href="xml/mcd-dispatcher-context.xml"/>
- <xi:include href="xml/mcd-debug.xml"/>
- <xi:include href="xml/mcd-enum-types.xml"/>
- </chapter>
-</book>
diff --git a/doc/reference/libmissioncontrol-server/libmissioncontrol-server-overrides.txt b/doc/reference/libmissioncontrol-server/libmissioncontrol-server-overrides.txt
deleted file mode 100644
index e69de29b..00000000
--- a/doc/reference/libmissioncontrol-server/libmissioncontrol-server-overrides.txt
+++ /dev/null
diff --git a/doc/reference/libmissioncontrol-server/libmissioncontrol-server-sections.txt b/doc/reference/libmissioncontrol-server/libmissioncontrol-server-sections.txt
deleted file mode 100644
index d9a49f9b..00000000
--- a/doc/reference/libmissioncontrol-server/libmissioncontrol-server-sections.txt
+++ /dev/null
@@ -1,214 +0,0 @@
-<SECTION>
-<FILE>mcd-master</FILE>
-<TITLE>McdMaster</TITLE>
-McdMaster
-<SUBSECTION Standard>
-MCD_MASTER
-MCD_IS_MASTER
-MCD_TYPE_MASTER
-mcd_master_get_type
-MCD_MASTER_CLASS
-MCD_IS_MASTER_CLASS
-MCD_MASTER_GET_CLASS
-</SECTION>
-
-<SECTION>
-<FILE>mcd-connection</FILE>
-McdConnection
-mcd_connection_get_account
-mcd_connection_request_channel
-mcd_connection_cancel_channel_request
-mcd_connection_close
-<SUBSECTION Standard>
-MCD_CONNECTION
-MCD_IS_CONNECTION
-MCD_TYPE_CONNECTION
-mcd_connection_get_type
-MCD_CONNECTION_CLASS
-MCD_IS_CONNECTION_CLASS
-MCD_CONNECTION_GET_CLASS
-</SECTION>
-
-<SECTION>
-<FILE>mcd-operation</FILE>
-<TITLE>McdOperation</TITLE>
-McdOperation
-mcd_operation_new
-mcd_operation_take_mission
-mcd_operation_remove_mission
-mcd_operation_foreach
-mcd_operation_get_missions
-<SUBSECTION Standard>
-MCD_OPERATION
-MCD_IS_OPERATION
-MCD_TYPE_OPERATION
-mcd_operation_get_type
-MCD_OPERATION_CLASS
-MCD_IS_OPERATION_CLASS
-MCD_OPERATION_GET_CLASS
-</SECTION>
-
-<SECTION>
-<FILE>mcd-service</FILE>
-<TITLE>McdService</TITLE>
-McdService
-mcd_service_new
-mcd_service_run
-<SUBSECTION Standard>
-MCD_IS_SERVICE
-MCD_TYPE_SERVICE
-mcd_service_get_type
-MCD_IS_SERVICE_CLASS
-</SECTION>
-
-<SECTION>
-<FILE>mcd-channel</FILE>
-McdChannel
-McdChannelStatus
-<TITLE>McdChannel</TITLE>
-mcd_channel_get_status
-mcd_channel_get_members_accepted
-mcd_channel_get_channel_type
-mcd_channel_get_channel_type_quark
-mcd_channel_get_object_path
-mcd_channel_get_handle
-mcd_channel_get_handle_type
-mcd_channel_get_name
-mcd_channel_is_requested
-mcd_channel_get_account
-<SUBSECTION Standard>
-MCD_CHANNEL
-MCD_IS_CHANNEL
-MCD_TYPE_CHANNEL
-mcd_channel_get_type
-MCD_CHANNEL_CLASS
-MCD_IS_CHANNEL_CLASS
-MCD_CHANNEL_GET_CLASS
-</SECTION>
-
-<SECTION>
-<FILE>mcd-manager</FILE>
-<TITLE>McdManager</TITLE>
-McdManager
-mcd_manager_new
-mcd_manager_cancel_channel_request
-mcd_manager_get_connection
-<SUBSECTION Standard>
-MCD_MANAGER
-MCD_IS_MANAGER
-MCD_TYPE_MANAGER
-mcd_manager_get_type
-MCD_MANAGER_CLASS
-MCD_IS_MANAGER_CLASS
-MCD_MANAGER_GET_CLASS
-</SECTION>
-
-<SECTION>
-<FILE>mcd-mission</FILE>
-McdMission
-<TITLE>McdMission</TITLE>
-mcd_mission_new
-mcd_mission_is_connected
-mcd_mission_get_parent
-mcd_mission_abort
-mcd_mission_set_parent
-mcd_mission_connect
-mcd_mission_disconnect
-<SUBSECTION Standard>
-MCD_MISSION
-MCD_IS_MISSION
-MCD_TYPE_MISSION
-mcd_mission_get_type
-MCD_MISSION_CLASS
-MCD_IS_MISSION_CLASS
-MCD_MISSION_GET_CLASS
-</SECTION>
-
-<SECTION>
-<FILE>mcd-proxy</FILE>
-<TITLE>McdProxy</TITLE>
-McdProxy
-mcd_proxy_new
-mcd_proxy_get_proxy_object
-<SUBSECTION Standard>
-MCD_PROXY
-MCD_IS_PROXY
-MCD_TYPE_PROXY
-mcd_proxy_get_type
-MCD_PROXY_CLASS
-MCD_IS_PROXY_CLASS
-MCD_PROXY_GET_CLASS
-</SECTION>
-
-<SECTION>
-<FILE>mcd-controller</FILE>
-<TITLE>McdController</TITLE>
-McdController
-mcd_controller_new
-mcd_controller_shutdown
-mcd_controller_cancel_shutdown
-<SUBSECTION Standard>
-MCD_CONTROLLER
-MCD_IS_CONTROLLER
-MCD_TYPE_CONTROLLER
-mcd_controller_get_type
-MCD_CONTROLLER_CLASS
-MCD_IS_CONTROLLER_CLASS
-MCD_CONTROLLER_GET_CLASS
-</SECTION>
-
-<SECTION>
-<FILE>mcd-dispatcher</FILE>
-McdDispatcher
-<TITLE>McdDispatcher</TITLE>
-mcd_dispatcher_new
-mcd_dispatcher_get_channel_type_usage
-mcd_dispatcher_add_filter
-mcd_dispatcher_add_filters
-<SUBSECTION Standard>
-MCD_DISPATCHER
-MCD_IS_DISPATCHER
-MCD_TYPE_DISPATCHER
-mcd_dispatcher_get_type
-MCD_DISPATCHER_CLASS
-MCD_IS_DISPATCHER_CLASS
-MCD_DISPATCHER_GET_CLASS
-</SECTION>
-
-<SECTION>
-<FILE>mcd-dispatcher-context</FILE>
-MCD_PLUGIN_INIT_FUNC
-MCD_FILTER_IN
-MCD_FILTER_OUT
-McdDispatcherContext
-McdFilterFunc
-MCD_FILTER_PRIORITY_CRITICAL
-MCD_FILTER_PRIORITY_SYSTEM
-MCD_FILTER_PRIORITY_USER
-MCD_FILTER_PRIORITY_NOTICE
-MCD_FILTER_PRIORITY_LOW
-McdFilter
-mcd_dispatcher_context_get_dispatcher
-mcd_dispatcher_context_get_channel_object
-mcd_dispatcher_context_get_connection_object
-mcd_dispatcher_context_get_channel
-mcd_dispatcher_context_get_channels
-mcd_dispatcher_context_get_channel_by_type
-mcd_dispatcher_context_get_connection
-mcd_dispatcher_context_process
-</SECTION>
-
-<SECTION>
-<FILE>mcd-debug</FILE>
-mcd_debug_init
-mcd_debug_ref
-mcd_debug_unref
-mcd_debug_print_tree
-</SECTION>
-
-<SECTION>
-<FILE>mcd-enum-types</FILE>
-mcd_channel_status_get_type
-MCD_TYPE_CHANNEL_STATUS
-</SECTION>
-
diff --git a/doc/reference/libmissioncontrol-server/libmissioncontrol-server.types b/doc/reference/libmissioncontrol-server/libmissioncontrol-server.types
deleted file mode 100644
index f261f5a7..00000000
--- a/doc/reference/libmissioncontrol-server/libmissioncontrol-server.types
+++ /dev/null
@@ -1,26 +0,0 @@
-#include <mcd-channel.h>
-#include <mcd-connection.h>
-#include <mcd-controller.h>
-#include <mcd-dispatcher.h>
-#include <mcd-manager.h>
-#include <mcd-enum-types.h>
-#include <mcd-master.h>
-#include <mcd-mission.h>
-#include <mcd-operation.h>
-#include <mcd-proxy.h>
-#include <mcd-provisioning.h>
-#include <mcd-provisioning-factory.h>
-#include <mcd-service.h>
-
-mcd_channel_get_type
-mcd_connection_get_type
-mcd_controller_get_type
-mcd_dispatcher_get_type
-mcd_manager_get_type
-mcd_master_get_type
-mcd_mission_get_type
-mcd_operation_get_type
-mcd_provisioning_get_type
-mcd_provisioning_factory_get_type
-mcd_proxy_get_type
-mcd_service_get_type
diff --git a/doc/reference/libmissioncontrol-server/tmpl/dummy.sgml b/doc/reference/libmissioncontrol-server/tmpl/dummy.sgml
deleted file mode 100644
index e70c3972..00000000
--- a/doc/reference/libmissioncontrol-server/tmpl/dummy.sgml
+++ /dev/null
@@ -1 +0,0 @@
-this file only exists because gtkdoc gets confused easily