mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2025-08-20 15:48:54 +02:00
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
This commit is contained in:
Allison Ryan Lortie
@@ -3605,7 +3605,6 @@ docs/reference/glib/version.xml
|
|||||||
docs/reference/gobject/Makefile
|
docs/reference/gobject/Makefile
|
||||||
docs/reference/gobject/version.xml
|
docs/reference/gobject/version.xml
|
||||||
docs/reference/gio/Makefile
|
docs/reference/gio/Makefile
|
||||||
docs/reference/gio/gdbus-object-manager-example/Makefile
|
|
||||||
docs/reference/gio/version.xml
|
docs/reference/gio/version.xml
|
||||||
tests/Makefile
|
tests/Makefile
|
||||||
tests/gobject/Makefile
|
tests/gobject/Makefile
|
||||||
|
|||||||
@@ -1,7 +1,5 @@
|
|||||||
NULL =
|
NULL =
|
||||||
|
|
||||||
SUBDIRS = gdbus-object-manager-example
|
|
||||||
|
|
||||||
# The name of the module.
|
# The name of the module.
|
||||||
DOC_MODULE=gio
|
DOC_MODULE=gio
|
||||||
|
|
||||||
@@ -127,22 +125,6 @@ HTML_IMAGES = \
|
|||||||
menu-example.png \
|
menu-example.png \
|
||||||
menu-model.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 = \
|
content_files = \
|
||||||
version.xml \
|
version.xml \
|
||||||
overview.xml \
|
overview.xml \
|
||||||
@@ -158,7 +140,6 @@ content_files = \
|
|||||||
gresource.xml \
|
gresource.xml \
|
||||||
gdbus.xml \
|
gdbus.xml \
|
||||||
gdbus-codegen.xml \
|
gdbus-codegen.xml \
|
||||||
$(example_files) \
|
|
||||||
$(NULL)
|
$(NULL)
|
||||||
|
|
||||||
expand_content_files = \
|
expand_content_files = \
|
||||||
@@ -210,7 +191,7 @@ XSLTPROC_FLAGS = \
|
|||||||
endif
|
endif
|
||||||
|
|
||||||
CLEANFILES ?=
|
CLEANFILES ?=
|
||||||
CLEANFILES += $(man_MANS) $(example_files)
|
CLEANFILES += $(man_MANS)
|
||||||
|
|
||||||
EXTRA_DIST += $(man_MANS)
|
EXTRA_DIST += $(man_MANS)
|
||||||
|
|
||||||
|
|||||||
@@ -1 +0,0 @@
|
|||||||
gdbus-object-manager-example-overrides.txt
|
|
||||||
@@ -1,67 +0,0 @@
|
|||||||
NULL =
|
|
||||||
|
|
||||||
# The name of the module.
|
|
||||||
DOC_MODULE=gdbus-object-manager-example
|
|
||||||
|
|
||||||
# The top-level SGML file.
|
|
||||||
DOC_MAIN_SGML_FILE=gdbus-object-manager-example-docs.xml
|
|
||||||
|
|
||||||
# Extra options to supply to gtkdoc-scan
|
|
||||||
SCAN_OPTIONS=--deprecated-guards="G_DISABLE_DEPRECATED"
|
|
||||||
|
|
||||||
# The directory containing the source code. Relative to $(srcdir)
|
|
||||||
DOC_SOURCE_DIR=$(top_builddir)/gio/tests/gdbus-object-manager-example
|
|
||||||
|
|
||||||
HFILE_GLOB=$(top_builddir)/gio/tests/gdbus-object-manager-example/*.h
|
|
||||||
CFILE_GLOB=$(top_builddir)/gio/tests/gdbus-object-manager-example/*.c
|
|
||||||
|
|
||||||
# Headers to ignore
|
|
||||||
IGNORE_HFILES = \
|
|
||||||
$(NULL)
|
|
||||||
|
|
||||||
# CFLAGS and LDFLAGS for compiling scan program. Only needed
|
|
||||||
# if $(DOC_MODULE).types is non-empty.
|
|
||||||
AM_CPPFLAGS = \
|
|
||||||
$(gio_INCLUDES) \
|
|
||||||
$(GLIB_DEBUG_FLAGS)
|
|
||||||
|
|
||||||
GTKDOC_LIBS = \
|
|
||||||
$(top_builddir)/glib/libglib-2.0.la \
|
|
||||||
$(top_builddir)/gobject/libgobject-2.0.la \
|
|
||||||
$(top_builddir)/gmodule/libgmodule-2.0.la \
|
|
||||||
$(top_builddir)/gio/libgio-2.0.la \
|
|
||||||
$(top_builddir)/gio/tests/gdbus-object-manager-example/libgdbus-example-objectmanager.la \
|
|
||||||
$(NULL)
|
|
||||||
|
|
||||||
# Extra options to supply to gtkdoc-mkdb
|
|
||||||
MKDB_OPTIONS = --output-format=xml --sgml-mode --name-space=g \
|
|
||||||
$(NULL)
|
|
||||||
|
|
||||||
# Images to copy into HTML directory
|
|
||||||
HTML_IMAGES = \
|
|
||||||
$(NULL)
|
|
||||||
|
|
||||||
content_files = \
|
|
||||||
$(NULL)
|
|
||||||
|
|
||||||
expand_content_files = \
|
|
||||||
$(NULL)
|
|
||||||
|
|
||||||
extra_files = \
|
|
||||||
$(NULL)
|
|
||||||
|
|
||||||
include $(top_srcdir)/gtk-doc.make
|
|
||||||
|
|
||||||
EXTRA_DIST += \
|
|
||||||
$(NULL)
|
|
||||||
|
|
||||||
MAINTAINERCLEANFILES = $(BUILT_SOURCES)
|
|
||||||
|
|
||||||
dist-hook-local: all-local
|
|
||||||
|
|
||||||
gdbus-object-manager-example-docs-clean: clean
|
|
||||||
cd $(srcdir) && rm -rf xml html
|
|
||||||
|
|
||||||
# Nuke installed docs (don't know how to avoid installing them)
|
|
||||||
install-data-hook :
|
|
||||||
rm -rf $(DESTDIR)$(datadir)/gtk-doc/html/gdbus-object-manager-example
|
|
||||||
@@ -1,17 +0,0 @@
|
|||||||
<?xml version="1.0"?>
|
|
||||||
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
|
||||||
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
|
||||||
<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
|
|
||||||
]>
|
|
||||||
<book lang="en" xmlns:xi="http://www.w3.org/2003/XInclude">
|
|
||||||
<part>
|
|
||||||
<title>foo</title>
|
|
||||||
<chapter>
|
|
||||||
<title>bar</title>
|
|
||||||
<xi:include href="xml/ExampleAnimal.xml"/>
|
|
||||||
<xi:include href="xml/ExampleCat.xml"/>
|
|
||||||
<xi:include href="xml/ExampleObject.xml"/>
|
|
||||||
<xi:include href="xml/ExampleObjectManagerClient.xml"/>
|
|
||||||
</chapter>
|
|
||||||
</part>
|
|
||||||
</book>
|
|
||||||
@@ -1,161 +0,0 @@
|
|||||||
<SECTION>
|
|
||||||
<FILE>ExampleAnimal</FILE>
|
|
||||||
<TITLE>ExampleAnimal</TITLE>
|
|
||||||
ExampleAnimal
|
|
||||||
ExampleAnimalIface
|
|
||||||
example_animal_interface_info
|
|
||||||
example_animal_override_properties
|
|
||||||
example_animal_call_poke
|
|
||||||
example_animal_call_poke_finish
|
|
||||||
example_animal_call_poke_sync
|
|
||||||
example_animal_complete_poke
|
|
||||||
example_animal_emit_jumped
|
|
||||||
example_animal_get_mood
|
|
||||||
example_animal_get_foo
|
|
||||||
example_animal_get_bar
|
|
||||||
example_animal_dup_mood
|
|
||||||
example_animal_dup_foo
|
|
||||||
example_animal_dup_bar
|
|
||||||
example_animal_set_mood
|
|
||||||
example_animal_set_foo
|
|
||||||
example_animal_set_bar
|
|
||||||
ExampleAnimalProxy
|
|
||||||
ExampleAnimalProxyClass
|
|
||||||
example_animal_proxy_new
|
|
||||||
example_animal_proxy_new_finish
|
|
||||||
example_animal_proxy_new_sync
|
|
||||||
example_animal_proxy_new_for_bus
|
|
||||||
example_animal_proxy_new_for_bus_finish
|
|
||||||
example_animal_proxy_new_for_bus_sync
|
|
||||||
ExampleAnimalSkeleton
|
|
||||||
ExampleAnimalSkeletonClass
|
|
||||||
example_animal_skeleton_new
|
|
||||||
<SUBSECTION Standard>
|
|
||||||
example_animal_get_type
|
|
||||||
example_animal_proxy_get_type
|
|
||||||
example_animal_skeleton_get_type
|
|
||||||
ExampleAnimalSkeletonPrivate
|
|
||||||
ExampleAnimalProxyPrivate
|
|
||||||
EXAMPLE_TYPE_ANIMAL
|
|
||||||
EXAMPLE_TYPE_ANIMAL_PROXY
|
|
||||||
EXAMPLE_TYPE_ANIMAL_SKELETON
|
|
||||||
EXAMPLE_ANIMAL
|
|
||||||
EXAMPLE_ANIMAL_GET_IFACE
|
|
||||||
EXAMPLE_ANIMAL_PROXY
|
|
||||||
EXAMPLE_ANIMAL_PROXY_CLASS
|
|
||||||
EXAMPLE_ANIMAL_PROXY_GET_CLASS
|
|
||||||
EXAMPLE_ANIMAL_SKELETON
|
|
||||||
EXAMPLE_ANIMAL_SKELETON_CLASS
|
|
||||||
EXAMPLE_ANIMAL_SKELETON_GET_CLASS
|
|
||||||
EXAMPLE_IS_ANIMAL
|
|
||||||
EXAMPLE_IS_ANIMAL_PROXY
|
|
||||||
EXAMPLE_IS_ANIMAL_PROXY_CLASS
|
|
||||||
EXAMPLE_IS_ANIMAL_SKELETON
|
|
||||||
EXAMPLE_IS_ANIMAL_SKELETON_CLASS
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>ExampleCat</FILE>
|
|
||||||
<TITLE>ExampleCat</TITLE>
|
|
||||||
ExampleCat
|
|
||||||
ExampleCatIface
|
|
||||||
example_cat_interface_info
|
|
||||||
example_cat_override_properties
|
|
||||||
ExampleCatProxy
|
|
||||||
ExampleCatProxyClass
|
|
||||||
example_cat_proxy_new
|
|
||||||
example_cat_proxy_new_finish
|
|
||||||
example_cat_proxy_new_sync
|
|
||||||
example_cat_proxy_new_for_bus
|
|
||||||
example_cat_proxy_new_for_bus_finish
|
|
||||||
example_cat_proxy_new_for_bus_sync
|
|
||||||
ExampleCatSkeleton
|
|
||||||
ExampleCatSkeletonClass
|
|
||||||
example_cat_skeleton_new
|
|
||||||
<SUBSECTION Standard>
|
|
||||||
example_cat_get_type
|
|
||||||
example_cat_proxy_get_type
|
|
||||||
example_cat_skeleton_get_type
|
|
||||||
ExampleCatProxyPrivate
|
|
||||||
ExampleCatSkeletonPrivate
|
|
||||||
EXAMPLE_TYPE_CAT
|
|
||||||
EXAMPLE_TYPE_CAT_PROXY
|
|
||||||
EXAMPLE_TYPE_CAT_SKELETON
|
|
||||||
EXAMPLE_CAT
|
|
||||||
EXAMPLE_CAT_GET_IFACE
|
|
||||||
EXAMPLE_CAT_PROXY
|
|
||||||
EXAMPLE_CAT_PROXY_CLASS
|
|
||||||
EXAMPLE_CAT_PROXY_GET_CLASS
|
|
||||||
EXAMPLE_CAT_SKELETON
|
|
||||||
EXAMPLE_CAT_SKELETON_CLASS
|
|
||||||
EXAMPLE_CAT_SKELETON_GET_CLASS
|
|
||||||
EXAMPLE_IS_CAT
|
|
||||||
EXAMPLE_IS_CAT_PROXY
|
|
||||||
EXAMPLE_IS_CAT_PROXY_CLASS
|
|
||||||
EXAMPLE_IS_CAT_SKELETON
|
|
||||||
EXAMPLE_IS_CAT_SKELETON_CLASS
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>ExampleObject</FILE>
|
|
||||||
<TITLE>ExampleObject</TITLE>
|
|
||||||
ExampleObject
|
|
||||||
ExampleObjectIface
|
|
||||||
example_object_get_animal
|
|
||||||
example_object_get_cat
|
|
||||||
example_object_peek_animal
|
|
||||||
example_object_peek_cat
|
|
||||||
ExampleObjectProxy
|
|
||||||
ExampleObjectProxyClass
|
|
||||||
example_object_proxy_new
|
|
||||||
ExampleObjectSkeleton
|
|
||||||
ExampleObjectSkeletonClass
|
|
||||||
example_object_skeleton_new
|
|
||||||
example_object_skeleton_set_animal
|
|
||||||
example_object_skeleton_set_cat
|
|
||||||
<SUBSECTION Standard>
|
|
||||||
example_object_get_type
|
|
||||||
example_object_proxy_get_type
|
|
||||||
example_object_skeleton_get_type
|
|
||||||
ExampleObjectProxyPrivate
|
|
||||||
ExampleObjectSkeletonPrivate
|
|
||||||
EXAMPLE_IS_OBJECT
|
|
||||||
EXAMPLE_IS_OBJECT_PROXY
|
|
||||||
EXAMPLE_IS_OBJECT_PROXY_CLASS
|
|
||||||
EXAMPLE_IS_OBJECT_SKELETON
|
|
||||||
EXAMPLE_IS_OBJECT_SKELETON_CLASS
|
|
||||||
EXAMPLE_OBJECT
|
|
||||||
EXAMPLE_OBJECT_GET_IFACE
|
|
||||||
EXAMPLE_OBJECT_PROXY
|
|
||||||
EXAMPLE_OBJECT_PROXY_CLASS
|
|
||||||
EXAMPLE_OBJECT_PROXY_GET_CLASS
|
|
||||||
EXAMPLE_OBJECT_SKELETON
|
|
||||||
EXAMPLE_OBJECT_SKELETON_CLASS
|
|
||||||
EXAMPLE_OBJECT_SKELETON_GET_CLASS
|
|
||||||
EXAMPLE_TYPE_OBJECT
|
|
||||||
EXAMPLE_TYPE_OBJECT_PROXY
|
|
||||||
EXAMPLE_TYPE_OBJECT_SKELETON
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>ExampleObjectManagerClient</FILE>
|
|
||||||
<TITLE>ExampleObjectManagerClient</TITLE>
|
|
||||||
ExampleObjectManagerClient
|
|
||||||
ExampleObjectManagerClientClass
|
|
||||||
example_object_manager_client_get_proxy_type
|
|
||||||
example_object_manager_client_new
|
|
||||||
example_object_manager_client_new_finish
|
|
||||||
example_object_manager_client_new_sync
|
|
||||||
example_object_manager_client_new_for_bus
|
|
||||||
example_object_manager_client_new_for_bus_finish
|
|
||||||
example_object_manager_client_new_for_bus_sync
|
|
||||||
<SUBSECTION Standard>
|
|
||||||
example_object_manager_client_get_type
|
|
||||||
EXAMPLE_IS_OBJECT_MANAGER_CLIENT
|
|
||||||
EXAMPLE_IS_OBJECT_MANAGER_CLIENT_CLASS
|
|
||||||
EXAMPLE_OBJECT_MANAGER_CLIENT
|
|
||||||
EXAMPLE_OBJECT_MANAGER_CLIENT_CLASS
|
|
||||||
EXAMPLE_OBJECT_MANAGER_CLIENT_GET_CLASS
|
|
||||||
EXAMPLE_TYPE_OBJECT_MANAGER_CLIENT
|
|
||||||
ExampleObjectManagerClientPrivate
|
|
||||||
</SECTION>
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
example_object_get_type
|
|
||||||
example_object_proxy_get_type
|
|
||||||
example_object_skeleton_get_type
|
|
||||||
example_animal_get_type
|
|
||||||
example_animal_proxy_get_type
|
|
||||||
example_animal_skeleton_get_type
|
|
||||||
example_cat_get_type
|
|
||||||
example_cat_proxy_get_type
|
|
||||||
example_cat_skeleton_get_type
|
|
||||||
example_object_manager_client_get_type
|
|
||||||
@@ -241,9 +241,6 @@ on_name_acquired (GDBusConnection *connection,
|
|||||||
</para>
|
</para>
|
||||||
</section>
|
</section>
|
||||||
|
|
||||||
<section>
|
|
||||||
<title>Generating code and docs</title>
|
|
||||||
|
|
||||||
<section id="gdbus-example-gdbus-codegen">
|
<section id="gdbus-example-gdbus-codegen">
|
||||||
<title>Using gdbus-codegen</title>
|
<title>Using gdbus-codegen</title>
|
||||||
|
|
||||||
@@ -270,12 +267,7 @@ gdbus-codegen --interface-prefix org.gtk.GDBus.Example.ObjectManager. \
|
|||||||
generated. Additionally, two XML files
|
generated. Additionally, two XML files
|
||||||
<filename>generated-docs-org.gtk.GDBus.Example.ObjectManager.Animal</filename> and
|
<filename>generated-docs-org.gtk.GDBus.Example.ObjectManager.Animal</filename> and
|
||||||
<filename>generated-docs-org.gtk.GDBus.Example.ObjectManager.Cat</filename>
|
<filename>generated-docs-org.gtk.GDBus.Example.ObjectManager.Cat</filename>
|
||||||
with Docbook XML are generated. For an example of what the docs look
|
with Docbook XML are generated.
|
||||||
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>.
|
|
||||||
</para>
|
</para>
|
||||||
<para>
|
<para>
|
||||||
While the contents of <filename>generated-code.h</filename> and
|
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
|
linkend="gdbus-codegen">gdbus-codegen</link></command> manual
|
||||||
page, brief examples of how this generated code can be used can be found in
|
page, brief examples of how this generated code can be used can be found in
|
||||||
<xref linkend="gdbus-example-codegen-server"/>
|
<xref linkend="gdbus-example-codegen-server"/>
|
||||||
and <xref
|
and <xref linkend="gdbus-example-codegen-client"/>.
|
||||||
linkend="gdbus-example-codegen-client"/>. Additionally, since
|
|
||||||
the generated code has 100% gtk-doc coverage, see
|
|
||||||
#ExampleAnimal, #ExampleCat, #ExampleObject and
|
|
||||||
#ExampleObjectManagerClient pages for documentation.
|
|
||||||
</para>
|
</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>
|
</section>
|
||||||
|
|
||||||
</chapter>
|
</chapter>
|
||||||
|
|||||||
Reference in New Issue
Block a user