[Telepathy-commits] [telepathy-doc/master] Makefile reworks

Davyd Madeley davyd at madeley.id.au
Tue Mar 3 17:51:03 PST 2009 

---
 docs/Makefile_web.am_fragment      |   14 -------
 docs/book/C/connection-manager.xml |   72 ------------------------------------
 docs/book/C/telepathy.xml          |    5 +-
 docs/book/Makefile.am              |   12 ++---
 docs/examples/Makefile.am          |    6 +-
 docs/rsync-properties.make         |    7 +++
 6 files changed, 17 insertions(+), 99 deletions(-)
 delete mode 100644 docs/Makefile_web.am_fragment
 delete mode 100644 docs/book/C/connection-manager.xml
 create mode 100644 docs/rsync-properties.make

diff --git a/docs/Makefile_web.am_fragment b/docs/Makefile_web.am_fragment
deleted file mode 100644
index 97cf408..0000000
--- a/docs/Makefile_web.am_fragment
+++ /dev/null
@@ -1,14 +0,0 @@
-web_host = openismus.com
-web_path_telepathydocs = /home/murrayc/openismus.com/temp/telepathy_book
-web_path_docs = $(web_path_telepathydocs)
-
-#--delete and --delete-after are causing
-# "
-# Invalid file index: 1768710413 (count=0) [receiver]
-# rsync error: protocol incompatibility (code 2) at sender.c(156)
-# "
-# with sourceforge recently (May 2005). murrayc.
-#
-#rsync_args = -vz --rsh ssh --delete --delete-after
-rsync_args = -vz --rsh ssh
-
diff --git a/docs/book/C/connection-manager.xml b/docs/book/C/connection-manager.xml
deleted file mode 100644
index 18f2b3d..0000000
--- a/docs/book/C/connection-manager.xml
+++ /dev/null
@@ -1,72 +0,0 @@
-<?xml version='1.0'?>
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
-	       "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-  <!ENTITY mdash "&#8212;">
-  <!ENTITY appversion "0.7">
-  <!ENTITY manrevision "0.2">
-  <!ENTITY date "12 August 2008">
-  <!ENTITY app_no_markup "Telepathy">
-  <!ENTITY app "<application>&app_no_markup;</application>">
-  <!ENTITY url_examples_base "./examples/">
-  <!ENTITY url_spec "http://telepathy.freedesktop.org/spec.html">
-  <!ENTITY url_spec_base "&url_spec;#org.freedesktop.Telepathy.">
-  <!ENTITY url_telepathy_glib_base "http://telepathy.freedesktop.org/doc/telepathy-glib/telepathy-glib-">
-  <!ENTITY url_dbus_spec_base "http://dbus.freedesktop.org/doc/dbus-specification.html#">
-  <!ENTITY url_dbus_glib_base "http://dbus.freedesktop.org/doc/dbus-glib/">
-  <!ENTITY url_dbus_python_base "http://dbus.freedesktop.org/doc/dbus-python/api/">
-]>
-
-<chapter id="chapter-connection-manager">
-  <title>Connection Manager</title>
-
-  <para>
-   Support for the various communication protocols is provided by several
-   <literal>Connection Managers</literal>. For instance, the
-   <literal>telepathy-gabble</literal> Connection Manager provides support
-   for the <acronym>XMPP</acronym> protocol, also known as
-   <literal>Jabber</literal>.
-  </para>
-  
-  <para>
-   There is no central &app; D-Bus service. Instead there are several
-   connection manager services, activated on demand, and each of these
-   connection managers provide the same core set of D-Bus interfaces, such as
-   <interfacename>Connection</interfacename> and
-   <interfacename>Channel</interfacename>, allowing application code to be
-   written generically for all connection managers.
-  </para>
-
-  <para>
-   All Telepathy Connection Managers have <literal>bus name</literal>s that
-   begin with &quot;org.freedesktop.Telepathy.ConnectionManager&quot; so
-   you can discover all available connection managers by calling the D-Bus
-   <methodname>ListActivatableNames</methodname> method and then comparing
-   the names with that prefix. telepathy-glib provides the
-   <ulink url="&url_telepathy_glib_base;connection-manager.html#tp-list-connection-managers"><function>tp_list_connection_managers</function></ulink> function
-   that conveniently does this.
-  </para>
-  
-  <para>
-   You may then discover what protocols are provided by each connection
-   manager by calling the ConnectionManagers's
-   <methodname>ListProtocols</methodname> method. telepathy-glib's
-   <ulink url="&url_telepathy_glib_base;connection-manager.html"><classname>TpConnectionManager</classname></ulink>
-   object calls this automatically and emits the <literal>got-info</literal>
-   signal when it has returned. You can examine the
-   TpConnectionManager::protocols struct field in your signal handler.
-  </para>
-  
-  <para>
-   Applications, such as IM clients, might choose to offer the user a choice
-   from that list of protocols and then use the appropriate connection manager.
-   Others might use only one protocol and therefore hard-code the connection
-   manager's <literal>bus name</literal>.
-  </para> 
-
-  <sect1>
-  <title>Protocols Listing Example</title>
-    <para>This example list all available connection managers and the protocols they support.</para>
-    <para><ulink url="&url_examples_base;list_all_protocols">Source Code</ulink></para>
-  </sect1>
-
-</chapter>
diff --git a/docs/book/C/telepathy.xml b/docs/book/C/telepathy.xml
index 34a9d86..81b9fa4 100644
--- a/docs/book/C/telepathy.xml
+++ b/docs/book/C/telepathy.xml
@@ -48,7 +48,7 @@
     </revhistory> 
 
     <authorgroup>
-      <author role="maintainer"> 
+      <author> 
         <firstname>Murray</firstname> 
         <surname>Cumming</surname> 
         <affiliation> 
@@ -56,7 +56,7 @@
           <address> <email>murrayc at openismus.com</email> </address> 
         </affiliation> 
       </author> 
-      <author>
+      <author role="maintainer">
         <firstname>Davyd</firstname>
         <surname>Madeley</surname>
         <affiliation>
@@ -85,7 +85,6 @@
 <xi:include href="basics.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
 <xi:include href="accounts.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
 <xi:include href="channel-dispatcher.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
-<xi:include href="connection-manager.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
 <xi:include href="connection.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
 <xi:include href="channel.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
 <xi:include href="tubes.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
diff --git a/docs/book/Makefile.am b/docs/book/Makefile.am
index a9e185c..06455fb 100644
--- a/docs/book/Makefile.am
+++ b/docs/book/Makefile.am
@@ -19,7 +19,6 @@ DOC_INCLUDES = \
 	basics.xml \
 	accounts.xml \
 	channel-dispatcher.xml \
-	connection-manager.xml \
 	connection.xml \
 	channel.xml \
 	tubes.xml
@@ -107,17 +106,16 @@ pdf: pdf/telepathy.pdf
 validate: C/$(DOC_MODULE).xml
 	$(XMLLINT) --xinclude --postvalid --noout $<
 
-include $(top_srcdir)/docs/Makefile_web.am_fragment
+include $(top_srcdir)/docs/rsync-properties.make
 include $(top_srcdir)/docs/generate-figures.make
 
 post-online: post-html post-pdf
 
-post-html: html pdf
-	rsync $(rsync_args) -r html/ murrayc@$(web_host):$(web_path_docs)/html/
-	rsync $(rsync_args) -r pdf/ murrayc@$(web_host):$(web_path_docs)/pdf/
+post-html: html
+	rsync $(rsync_args) -r html/ $(rsync_target_html)
 
 post-pdf: pdf
-	rsync $(rsync_args) -r pdf/ murrayc@$(web_host):$(web_path_docs)/pdf/
+	rsync $(rsync_args) -r pdf/ $(rsync_target_pdf)
 
-CLEANFILES = C/telepathy-with-examples.xml C/telepathy_manual.xml
+CLEANFILES = C/telepathy-with-examples.xml
 EXTRA_DIST = 
diff --git a/docs/examples/Makefile.am b/docs/examples/Makefile.am
index 47d12d0..25b31bd 100644
--- a/docs/examples/Makefile.am
+++ b/docs/examples/Makefile.am
@@ -1,4 +1,4 @@
-include $(top_srcdir)/docs/Makefile_web.am_fragment
+include $(top_srcdir)/docs/rsync-properties.make
 
 example_dirs = basics_dbus_glib_methods basics_dbus_glib_properties basics_dbus_python_methods basics_dbus_python_properties basics_dbus_python_signals connect list_all_protocols list_contacts set_presence send_message
 
@@ -6,8 +6,8 @@ SUBDIRS = $(example_dirs)
 
 EXTRA_DIST =  Makefile.am_fragment
 
-exclude_args = --delete-excluded --exclude *.o --exclude .libs --exclude .deps --exclude core --exclude .cvsignore --exclude a.out --exclude Makefile --exclude Makefile.in --exclude example --exclude .svn
+exclude_args = --delete-excluded --exclude *.o --exclude .libs --exclude .deps --exclude core --exclude .cvsignore --exclude a.out --exclude Makefile --exclude Makefile.in --exclude example --exclude .svn --exclude .git
 post-html:
-	rsync $(rsync_args) -a $(exclude_args) $(example_dirs) $$USER@$(web_host):$(web_path)examples
+	rsync $(rsync_args) -a $(exclude_args) $(example_dirs) $(rsync_target_html)/examples/
 
 
diff --git a/docs/rsync-properties.make b/docs/rsync-properties.make
new file mode 100644
index 0000000..359fda7
--- /dev/null
+++ b/docs/rsync-properties.make
@@ -0,0 +1,7 @@
+rsync_host = dhansak
+rsync_target = $(rsync_host):public_html/telepathy-book/
+
+rsync_target_html = $(rsync_target)
+rsync_target_pdf = $(rsync_target)/pdf/
+
+rsync_args = -z --rsh ssh --delete-after
-- 
1.5.6.5

More information about the telepathy-commits mailing list