[glib] docs: remove GDBusObjectManager example



commit 398c048c66e71ec52a1799ea6fbd4c3b1554ec5e
Author: Allison Ryan Lortie <desrt desrt ca>
Date:   Fri Nov 6 13:08:41 2015 -0500

    docs: remove GDBusObjectManager example
    
    This example has been causing on-and-off build breaks for quite some
    time.  In this case, the code for copying the generated content into the
    main docs of GIO is causing problems with srcdir != destdir builds (due
    to the files also being copied from the read-only srcdir during
    distchecks).
    
    We could probably work around this problem yet again, but since there is
    no real benefit to having this content included, so let's remove it.
    
    https://bugzilla.gnome.org/show_bug.cgi?id=734469

 configure.ac                                       |    1 -
 docs/reference/gio/Makefile.am                     |   21 +---
 .../gio/gdbus-object-manager-example/.gitignore    |    1 -
 .../gio/gdbus-object-manager-example/Makefile.am   |   67 --------
 .../gdbus-object-manager-example-docs.xml          |   17 --
 .../gdbus-object-manager-example-sections.txt      |  161 --------------------
 .../gdbus-object-manager-example.types             |   10 --
 docs/reference/gio/migrating-gdbus.xml             |   29 +----
 8 files changed, 3 insertions(+), 304 deletions(-)
---
diff --git a/configure.ac b/configure.ac
index 2861d20..be43614 100644
--- a/configure.ac
+++ b/configure.ac
@@ -3506,7 +3506,6 @@ docs/reference/glib/version.xml
 docs/reference/gobject/Makefile
 docs/reference/gobject/version.xml
 docs/reference/gio/Makefile
-docs/reference/gio/gdbus-object-manager-example/Makefile
 docs/reference/gio/version.xml
 tests/Makefile
 tests/gobject/Makefile
diff --git a/docs/reference/gio/Makefile.am b/docs/reference/gio/Makefile.am
index 07fe6e6..38666b4 100644
--- a/docs/reference/gio/Makefile.am
+++ b/docs/reference/gio/Makefile.am
@@ -1,7 +1,5 @@
 NULL =
 
-SUBDIRS = gdbus-object-manager-example
-
 # The name of the module.
 DOC_MODULE=gio
 
@@ -127,22 +125,6 @@ HTML_IMAGES =                      \
        menu-example.png        \
        menu-model.png
 
-example_files = \
-       gdbus-example-objectmanager.xml \
-       gdbus-example-objectmanager-server.c \
-       gdbus-example-objectmanager-client.c \
-       gdbus-example-objectmanager-generated-org.gtk.GDBus.Example.ObjectManager.Animal.xml \
-       gdbus-example-objectmanager-generated-org.gtk.GDBus.Example.ObjectManager.Cat.xml \
-       $(NULL)
-
-gdbus-example-objectmanager.xml: %: $(top_srcdir)/gio/tests/gdbus-object-manager-example/%
-gdbus-example-objectmanager-server.c: %: $(top_srcdir)/gio/tests/%
-gdbus-example-objectmanager-client.c: %: $(top_srcdir)/gio/tests/%
-gdbus-example-objectmanager-generated-org.gtk.GDBus.Example.ObjectManager.Animal.xml: %: 
$(top_builddir)/gio/tests/gdbus-object-manager-example/%
-gdbus-example-objectmanager-generated-org.gtk.GDBus.Example.ObjectManager.Cat.xml: %: 
$(top_builddir)/gio/tests/gdbus-object-manager-example/%
-$(example_files):
-       cp $< $@
-
 content_files =                        \
        version.xml             \
        overview.xml            \
@@ -158,7 +140,6 @@ content_files =                     \
        gresource.xml           \
        gdbus.xml               \
        gdbus-codegen.xml       \
-       $(example_files)        \
        $(NULL)
 
 expand_content_files =         \
@@ -210,7 +191,7 @@ XSLTPROC_FLAGS = \
 endif
 
 CLEANFILES ?=
-CLEANFILES += $(man_MANS) $(example_files)
+CLEANFILES += $(man_MANS)
 
 EXTRA_DIST += $(man_MANS)
 
diff --git a/docs/reference/gio/migrating-gdbus.xml b/docs/reference/gio/migrating-gdbus.xml
index d46f98c..bda3f76 100644
--- a/docs/reference/gio/migrating-gdbus.xml
+++ b/docs/reference/gio/migrating-gdbus.xml
@@ -241,9 +241,6 @@ on_name_acquired (GDBusConnection *connection,
     </para>
   </section>
 
-  <section>
-    <title>Generating code and docs</title>
-
   <section id="gdbus-example-gdbus-codegen">
     <title>Using gdbus-codegen</title>
 
@@ -270,12 +267,7 @@ gdbus-codegen --interface-prefix org.gtk.GDBus.Example.ObjectManager. \
       generated. Additionally, two XML files
       <filename>generated-docs-org.gtk.GDBus.Example.ObjectManager.Animal</filename> and
       <filename>generated-docs-org.gtk.GDBus.Example.ObjectManager.Cat</filename>
-      with Docbook XML are generated. For an example of what the docs look
-      like see <link
-      linkend="gdbus-interface-org-gtk-GDBus-Example-ObjectManager-Animal">the Animal D-Bus interface 
documentation</link>.
-      and
-      <link
-      linkend="gdbus-interface-org-gtk-GDBus-Example-ObjectManager-Cat">the Cat D-Bus interface 
documentation</link>.
+      with Docbook XML are generated.
     </para>
     <para>
       While the contents of <filename>generated-code.h</filename> and
@@ -284,26 +276,9 @@ gdbus-codegen --interface-prefix org.gtk.GDBus.Example.ObjectManager. \
       linkend="gdbus-codegen">gdbus-codegen</link></command> manual
       page, brief examples of how this generated code can be used can be found in
       <xref linkend="gdbus-example-codegen-server"/>
-      and <xref
-      linkend="gdbus-example-codegen-client"/>. Additionally, since
-      the generated code has 100% gtk-doc coverage, see
-      #ExampleAnimal, #ExampleCat, #ExampleObject and
-      #ExampleObjectManagerClient pages for documentation.
+      and <xref linkend="gdbus-example-codegen-client"/>.
     </para>
 
-    <example id="gdbus-example-codegen-server"><title>Server-side application using generated 
code</title><programlisting><xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; parse="text" 
href="../gdbus-example-objectmanager-server.c"><xi:fallback>FIXME: MISSING XINCLUDE 
CONTENT</xi:fallback></xi:include></programlisting></example>
-
-    <example id="gdbus-example-codegen-client"><title>Client-side application using generated 
code</title><programlisting><xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; parse="text" 
href="../gdbus-example-objectmanager-client.c"><xi:fallback>FIXME: MISSING XINCLUDE 
CONTENT</xi:fallback></xi:include></programlisting></example>
-
-  </section>
-
-  <xi:include 
href="../gdbus-example-objectmanager-generated-org.gtk.GDBus.Example.ObjectManager.Animal.xml"/>
-  <xi:include href="../gdbus-example-objectmanager-generated-org.gtk.GDBus.Example.ObjectManager.Cat.xml"/>
-  <xi:include href="../gdbus-object-manager-example/xml/ExampleAnimal.xml"/>
-  <xi:include href="../gdbus-object-manager-example/xml/ExampleCat.xml"/>
-  <xi:include href="../gdbus-object-manager-example/xml/ExampleObject.xml"/>
-  <xi:include href="../gdbus-object-manager-example/xml/ExampleObjectManagerClient.xml"/>
-
   </section>
 
 </chapter>


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]