[ohm] ohm: Branch 'master' - 7 commits
Rob Taylor
robtaylor at kemper.freedesktop.org
Fri Aug 17 04:39:20 PDT 2007
autogen.sh | 6 +
configure.in | 7 +
docs/Makefile.am | 2
docs/reference/Makefile.am | 1
docs/reference/libohm/Makefile.am | 78 ++++++++++++++++++
docs/reference/libohm/libohm-docs.sgml | 10 ++
docs/reference/ohm-plugin/Makefile.am | 89 +++++++++++++++++++++
docs/reference/ohm-plugin/ohm-plugin-decl-list.txt | 26 ++++++
docs/reference/ohm-plugin/ohm-plugin-docs.sgml | 10 ++
docs/reference/ohm-plugin/ohm-plugin-sections.txt | 25 +++++
ohmd/ohm-plugin-internal.h | 8 -
ohmd/ohm-plugin.c | 2
ohmd/ohm-plugin.h | 12 +-
13 files changed, 265 insertions(+), 11 deletions(-)
New commits:
diff-tree 0fe3310d5cce941633c16fc104e92e60bc43bd7f (from 4b60f0883dde5dd74708afdb62092b76c8933f7b)
Author: Rob Taylor <rob.taylor at codethink.co.uk>
Date: Thu Aug 16 14:35:58 2007 +0100
Add missing ohm-plugin-docs.sgml
diff --git a/docs/reference/ohm-plugin/ohm-plugin-docs.sgml b/docs/reference/ohm-plugin/ohm-plugin-docs.sgml
new file mode 100644
index 0000000..942499c
--- /dev/null
+++ b/docs/reference/ohm-plugin/ohm-plugin-docs.sgml
@@ -0,0 +1,10 @@
+<?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>Ohm Plugin Reference Manual</title>
+ </bookinfo>
+
+ <xi:include href="xml/ohm-plugin.xml"/>
+</book>
diff-tree 4b60f0883dde5dd74708afdb62092b76c8933f7b (from bce8e5e54d05bd68d4a74fed4932dddb4d39c41a)
Author: Rob Taylor <rob.taylor at codethink.co.uk>
Date: Thu Aug 16 14:05:47 2007 +0100
ohm-plugin fix
diff --git a/ohmd/ohm-plugin.c b/ohmd/ohm-plugin.c
index 345d63f..4012e48 100644
--- a/ohmd/ohm-plugin.c
+++ b/ohmd/ohm-plugin.c
@@ -49,7 +49,7 @@
#define OHM_PLUGIN_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), OHM_TYPE_PLUGIN, OhmPluginPrivate))
-struct OhmPluginPrivate
+struct _OhmPluginPrivate
{
OhmConf *conf;
GModule *handle;
diff-tree bce8e5e54d05bd68d4a74fed4932dddb4d39c41a (from 21c877d666313a1bd2c98be5618a0a604e6ecd86)
Author: Rob Taylor <rob.taylor at codethink.co.uk>
Date: Thu Aug 16 14:05:20 2007 +0100
call gtkdocize before automake
In autogen.sh, call gtkdocize before automake.
diff --git a/autogen.sh b/autogen.sh
index 4f4a08d..1c19ae6 100755
--- a/autogen.sh
+++ b/autogen.sh
@@ -21,12 +21,13 @@ $AUTOCONF || exit 1
echo "Running $LIBTOOLIZE --automake..."
$LIBTOOLIZE --automake || exit 1
+echo "Running gtkdocize..."
+gtkdocize || exit 1
+
echo "Running $AUTOMAKE..."
$AUTOMAKE -a || exit 1
$AUTOMAKE -a ohmd/Makefile || exit 1
-echo "Running gtkdocize..."
-gtkdocize || exit 1
conf_flags="--enable-gtk-doc"
diff-tree 21c877d666313a1bd2c98be5618a0a604e6ecd86 (from 7b22734c2fe3a076d5c5311e7b032e934e267963)
Author: Rob Taylor <rob.taylor at codethink.co.uk>
Date: Wed Aug 15 20:43:28 2007 +0100
gtk-doc for libohm
Adds docs/reference/libohm with basic gtk-doc generation.
diff --git a/autogen.sh b/autogen.sh
index 323ceca..4f4a08d 100755
--- a/autogen.sh
+++ b/autogen.sh
@@ -28,7 +28,7 @@ $AUTOMAKE -a ohmd/Makefile || exit 1
echo "Running gtkdocize..."
gtkdocize || exit 1
-conf_flags=""
+conf_flags="--enable-gtk-doc"
if test x$NOCONFIGURE = x; then
echo Running $srcdir/configure $conf_flags "$@" ...
diff --git a/configure.in b/configure.in
index 06a32c3..7d81e01 100644
--- a/configure.in
+++ b/configure.in
@@ -325,6 +325,7 @@ docs/Makefile
docs/index.xml
docs/reference/Makefile
docs/reference/ohm-plugin/Makefile
+docs/reference/libohm/Makefile
libohm/Makefile
libidletime/Makefile
tools/Makefile
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
index d1565fd..e11d2d0 100644
--- a/docs/reference/Makefile.am
+++ b/docs/reference/Makefile.am
@@ -1 +1 @@
-SUBDIRS = ohm-plugin
+SUBDIRS = ohm-plugin libohm
diff --git a/docs/reference/libohm/Makefile.am b/docs/reference/libohm/Makefile.am
new file mode 100644
index 0000000..ec58a3d
--- /dev/null
+++ b/docs/reference/libohm/Makefile.am
@@ -0,0 +1,78 @@
+## 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=libohm
+
+# The top-level SGML file. You can change this if you want to.
+DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
+
+# The directory containing the source code. Relative to $(srcdir).
+# gtk-doc will search all .c & .h files beneath here for inline comments
+# documenting the functions and macros.
+# e.g. DOC_SOURCE_DIR=../../../gtk
+DOC_SOURCE_DIR=../../../libohm/
+
+# 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=--sgml-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-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)/libohm/*.h
+CFILE_GLOB=$(top_srcdir)/libohm/*.c
+
+# Header files to ignore when scanning.
+# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
+IGNORE_HFILES= libohm-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=
+
+# 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. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
+# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
+INCLUDES=-I$(top_srcdir) $(GLIB_CFLAGS)
+GTKDOC_LIBS=$(GLIB_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/docs/reference/libohm/libohm-docs.sgml b/docs/reference/libohm/libohm-docs.sgml
new file mode 100644
index 0000000..9f8a81c
--- /dev/null
+++ b/docs/reference/libohm/libohm-docs.sgml
@@ -0,0 +1,10 @@
+<?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>LibOhm Reference Manual</title>
+ </bookinfo>
+
+ <xi:include href="xml/libohm.xml"/>
+</book>
diff-tree 7b22734c2fe3a076d5c5311e7b032e934e267963 (from 4f6b30eea8c5d175f1131c46d2c6d888177329a4)
Author: Rob Taylor <rob.taylor at codethink.co.uk>
Date: Wed Aug 15 14:35:52 2007 +0100
output whether gtk-doc is enabled at end of configure
Indicate whether gtk-doc is enabled at end of running configure.
diff --git a/configure.in b/configure.in
index 967ffc0..06a32c3 100644
--- a/configure.in
+++ b/configure.in
@@ -351,4 +351,5 @@ echo "
cflags: ${CFLAGS}
DPMS support: ${have_dpms}
Docbook support: ${enable_docbook_docs}
+ Gtk-doc support: ${enable_gtk_doc}
"
diff-tree 4f6b30eea8c5d175f1131c46d2c6d888177329a4 (from 18c21ca0a0ba3a662f17249a5bdd9ce040594e72)
Author: Rob Taylor <rob.taylor at codethink.co.uk>
Date: Thu Aug 16 13:52:10 2007 +0100
gtk-doc for Ohm plugin interface
Add basic gtk-doc generation for ohm-plugin.h
diff --git a/autogen.sh b/autogen.sh
index e79ff89..323ceca 100755
--- a/autogen.sh
+++ b/autogen.sh
@@ -25,6 +25,9 @@ echo "Running $AUTOMAKE..."
$AUTOMAKE -a || exit 1
$AUTOMAKE -a ohmd/Makefile || exit 1
+echo "Running gtkdocize..."
+gtkdocize || exit 1
+
conf_flags=""
if test x$NOCONFIGURE = x; then
diff --git a/configure.in b/configure.in
index 5409e22..967ffc0 100644
--- a/configure.in
+++ b/configure.in
@@ -29,6 +29,9 @@ AC_PROG_INTLTOOL([0.33.0])
AM_GLIB_GNU_GETTEXT
AC_PATH_PROG(GLIB_GENMARSHAL, glib-genmarshal)
+
+GTK_DOC_CHECK([1.8])
+
ALL_LINGUAS="en_GB"
AC_SUBST(ALL_LINGUAS)
@@ -320,6 +323,8 @@ ohmd/Makefile
po/Makefile.in
docs/Makefile
docs/index.xml
+docs/reference/Makefile
+docs/reference/ohm-plugin/Makefile
libohm/Makefile
libidletime/Makefile
tools/Makefile
diff --git a/docs/Makefile.am b/docs/Makefile.am
index c9639e5..8c0a548 100644
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -1,3 +1,5 @@
+SUBDIRS = reference
+
IMAGE_FILES = \
ohm-logo.png \
ohm-logo.svg \
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
new file mode 100644
index 0000000..d1565fd
--- /dev/null
+++ b/docs/reference/Makefile.am
@@ -0,0 +1 @@
+SUBDIRS = ohm-plugin
diff --git a/docs/reference/ohm-plugin/Makefile.am b/docs/reference/ohm-plugin/Makefile.am
new file mode 100644
index 0000000..7fa3707
--- /dev/null
+++ b/docs/reference/ohm-plugin/Makefile.am
@@ -0,0 +1,89 @@
+## 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=ohm-plugin
+
+# The top-level SGML file. You can change this if you want to.
+DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
+
+# The directory containing the source code. Relative to $(srcdir).
+# gtk-doc will search all .c & .h files beneath here for inline comments
+# documenting the functions and macros.
+# e.g. DOC_SOURCE_DIR=../../../gtk
+DOC_SOURCE_DIR=../../../ohmd/
+
+# 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=--sgml-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-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)/ohmd/ohm-plugin.h
+CFILE_GLOB=
+
+# Header files to ignore when scanning.
+# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
+IGNORE_HFILES= \
+ ohm-common.h \
+ ohm-conf.h \
+ ohm-confobj.h \
+ ohm-dbus-keystore.h \
+ ohm-dbus-manager.h \
+ ohm-debug.h \
+ ohm-keystore.h \
+ ohm-manager.h \
+ ohm-marshal.h \
+ ohm-module.h \
+ ohm-plugin-internal.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=
+
+# 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. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
+# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
+INCLUDES=-I$(top_srcdir) $(GLIB_CFLAGS)
+GTKDOC_LIBS=$(GLIB_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/docs/reference/ohm-plugin/ohm-plugin-decl-list.txt b/docs/reference/ohm-plugin/ohm-plugin-decl-list.txt
new file mode 100644
index 0000000..8fc373d
--- /dev/null
+++ b/docs/reference/ohm-plugin/ohm-plugin-decl-list.txt
@@ -0,0 +1,26 @@
+<SECTION>
+<FILE>ohm-plugin</FILE>
+OhmPlugin
+OhmPluginDesc
+OhmPluginKeyIdMap
+OhmLicenseType
+OHM_PLUGIN_DESCRIPTION
+OHM_PLUGIN_INTERESTED
+OHM_PLUGIN_PROVIDES
+OHM_PLUGIN_REQUIRES
+OHM_PLUGIN_SUGGESTS
+OHM_PLUGIN_PREVENTS
+OhmPluginHalPropMod
+OhmPluginHalCondition
+ohm_plugin_spawn_async
+ohm_plugin_conf_get_key
+ohm_plugin_conf_set_key
+ohm_plugin_hal_init
+ohm_plugin_hal_use_property_modified
+ohm_plugin_hal_use_condition
+ohm_plugin_hal_get_bool
+ohm_plugin_hal_get_int
+ohm_plugin_hal_get_udi
+ohm_plugin_hal_add_device_capability
+</SECTION>
+
diff --git a/docs/reference/ohm-plugin/ohm-plugin-overrides.txt b/docs/reference/ohm-plugin/ohm-plugin-overrides.txt
new file mode 100644
index 0000000..e69de29
diff --git a/docs/reference/ohm-plugin/ohm-plugin-sections.txt b/docs/reference/ohm-plugin/ohm-plugin-sections.txt
new file mode 100644
index 0000000..3858d3c
--- /dev/null
+++ b/docs/reference/ohm-plugin/ohm-plugin-sections.txt
@@ -0,0 +1,25 @@
+<SECTION>
+<FILE>ohm-plugin</FILE>
+OhmPlugin
+OhmPluginDesc
+OhmPluginKeyIdMap
+OhmLicenseType
+OHM_PLUGIN_DESCRIPTION
+OHM_PLUGIN_INTERESTED
+OHM_PLUGIN_PROVIDES
+OHM_PLUGIN_REQUIRES
+OHM_PLUGIN_SUGGESTS
+OHM_PLUGIN_PREVENTS
+OhmPluginHalPropMod
+OhmPluginHalCondition
+ohm_plugin_spawn_async
+ohm_plugin_conf_get_key
+ohm_plugin_conf_set_key
+ohm_plugin_hal_init
+ohm_plugin_hal_use_property_modified
+ohm_plugin_hal_use_condition
+ohm_plugin_hal_get_bool
+ohm_plugin_hal_get_int
+ohm_plugin_hal_get_udi
+ohm_plugin_hal_add_device_capability
+</SECTION>
diff-tree 18c21ca0a0ba3a662f17249a5bdd9ce040594e72 (from 268a4c0485cb0b9ec7ce89f1e72a2fede65c909f)
Author: Rob Taylor <rob.taylor at codethink.co.uk>
Date: Wed Aug 15 20:58:14 2007 +0100
prefix struct names with underscore in public api
In preparation for having to cope with gtk-doc's limitations, prefix struct
names with underscore in ohm-plugin.h.
diff --git a/ohmd/ohm-plugin-internal.h b/ohmd/ohm-plugin-internal.h
index fb5d8f9..92c9bcb 100644
--- a/ohmd/ohm-plugin-internal.h
+++ b/ohmd/ohm-plugin-internal.h
@@ -33,10 +33,10 @@ G_BEGIN_DECLS
#define OHM_IS_PLUGIN_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), OHM_TYPE_PLUGIN))
#define OHM_PLUGIN_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), OHM_TYPE_PLUGIN, OhmPluginClass))
-typedef struct OhmPluginPrivate OhmPluginPrivate;
-typedef struct OhmPluginClass OhmPluginClass;
+typedef struct _OhmPluginPrivate OhmPluginPrivate;
+typedef struct _OhmPluginClass OhmPluginClass;
-struct OhmPlugin
+struct _OhmPlugin
{
GObject parent;
const OhmPluginDesc *desc;
@@ -48,7 +48,7 @@ struct OhmPlugin
OhmPluginPrivate *priv;
};
-struct OhmPluginClass
+struct _OhmPluginClass
{
GObjectClass parent_class;
};
diff --git a/ohmd/ohm-plugin.h b/ohmd/ohm-plugin.h
index 606acaa..382aeec 100644
--- a/ohmd/ohm-plugin.h
+++ b/ohmd/ohm-plugin.h
@@ -21,11 +21,13 @@
#ifndef __OHM_PLUGIN_H
#define __OHM_PLUGIN_H
-typedef struct OhmPlugin OhmPlugin;
-typedef struct OhmPluginDesc OhmPluginDesc;
-typedef struct OhmPluginKeyIdMap OhmPluginKeyIdMap;
+G_BEGIN_DECLS
-struct OhmPluginKeyIdMap {
+typedef struct _OhmPlugin OhmPlugin;
+typedef struct _OhmPluginDesc OhmPluginDesc;
+typedef struct _OhmPluginKeyIdMap OhmPluginKeyIdMap;
+
+struct _OhmPluginKeyIdMap {
const char *key_name;
gint local_key_id;
};
@@ -51,7 +53,7 @@ typedef enum {
* #OHM_PLUGIN_INTERESTED
* @padding: Padding for future expansion
*/
-struct OhmPluginDesc {
+struct _OhmPluginDesc {
const char *description;
const char *version;
const char *author;
More information about the Ohm-devel
mailing list