DBus Menu

Merge lp:~charlesk/libdbusmenu/lp-1083399 into lp:libdbusmenu/13.04

  1. lp-1083399
  2. Merge into trunk.13.04
Proposed by Charles Kerr
Status: Merged
Merged at revision: 435
Proposed branch: lp:~charlesk/libdbusmenu/lp-1083399
Merge into: lp:libdbusmenu/13.04
Diff against target: 326 lines (+23/-221)
7 files modified
autogen.sh (+2/-0)
configure.ac (+1/-1)
docs/libdbusmenu-glib/reference/Makefile.am (+9/-12)
docs/libdbusmenu-gtk/reference/Makefile.am (+10/-11)
gtk-doc.local.make (+0/-194)
libdbusmenu-glib/menuitem.c (+0/-2)
libdbusmenu-glib/menuitem.h (+1/-1)
To merge this branch: bzr merge lp:~charlesk/libdbusmenu/lp-1083399
Reviewer Review Type Date Requested Status
Mathieu Trudel-Lapierre Needs Fixing
Ted Gould (community) Needs Fixing
PS Jenkins bot (community) continuous-integration Needs Fixing
Review via email: mp+137885@code.launchpad.net

Commit message

gtk-doc fixes

Description of the change

These are the same changes as before, but based off of trunk rather than inline s.t. they can land before the inline patch.

1. garden variety gtk-doc fixes for code and comments that gtk-doc threw errors on because it couldn't parse them.

2. update gtk-doc use from 1.4 to 1.14 wrt removing dummy templates and especially wrt not bundling our own gtk-doc makefiles, but instead letting gtkdocize get a fresh copy on its own when invoked by autogen. The newer makefile rules that ship with gtk-doc fix a bug #1083399 issue of not finding documents on code generated in the builddir from a template file in the srcdir.

To post a comment you must log in.
Revision history for this message
PS Jenkins bot (ps-jenkins) wrote :

FAILED: Continuous integration, rev:437
http://jenkins.qa.ubuntu.com/job/dbusmenu-ci/15/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/dbusmenu-ci/./build=pbuilder,distribution=raring,flavor=amd64/15/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/dbusmenu-ci/./build=pbuilder,distribution=raring,flavor=i386/15/console

Click here to trigger a rebuild:
http://jenkins.qa.ubuntu.com/job/dbusmenu-ci/15//rebuild/?

review: Needs Fixing (continuous-integration)
Revision history for this message
Mathieu Trudel-Lapierre (cyphermox) wrote :

Approve

review: Approve
Revision history for this message
Ted Gould (ted) wrote :

This removes the testing to make sure the docs are complete. This line needs to be uncommented.

#TESTS = $(GTKDOC_CHECK)

Twice in fact :-)

review: Needs Fixing
Revision history for this message
Mathieu Trudel-Lapierre (cyphermox) wrote :

Tests would fail a different way (with tests uncommented as Ted suggests):

make[4]: Leaving directory `/«PKGBUILDDIR»/builddir/gtk2/tests'
make[3]: Leaving directory `/«PKGBUILDDIR»/builddir/gtk2/tests'
Making check in docs
make[3]: Entering directory `/«PKGBUILDDIR»/builddir/gtk2/docs'
Making check in libdbusmenu-glib
make[4]: Entering directory `/«PKGBUILDDIR»/builddir/gtk2/docs/libdbusmenu-glib'
Making check in reference
make[5]: Entering directory `/«PKGBUILDDIR»/builddir/gtk2/docs/libdbusmenu-glib/reference'
make check-TESTS
make[6]: Entering directory `/«PKGBUILDDIR»/builddir/gtk2/docs/libdbusmenu-glib/reference'
Running suite(s): gtk-doc-libdbusmenu-glib
libdbusmenu-glib-undocumented.txt:1:E: 139 undocumented or incomplete symbols
/«PKGBUILDDIR»/builddir/gtk2/docs/libdbusmenu-glib/reference/libdbusmenu-glib-undeclared.txt:1:E: 129 undeclared symbols
50.0%: Checks 4, Failures: 2
FAIL: /usr/bin/gtkdoc-check
==================================
1 of 1 test failed
Please report to <email address hidden>
==================================

review: Needs Fixing

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
=== modified file 'autogen.sh'
--- autogen.sh 2010-06-22 15:37:15 +0000
+++ autogen.sh 2012-12-04 15:47:23 +0000
@@ -7,6 +7,8 @@
7 exit 17 exit 1
8}8}
99
10gtkdocize || exit 1
11
10USE_GNOME2_MACROS=1 \12USE_GNOME2_MACROS=1 \
11USE_COMMON_DOC_BUILD=yes \13USE_COMMON_DOC_BUILD=yes \
12gnome-autogen.sh --enable-gtk-doc $@14gnome-autogen.sh --enable-gtk-doc $@
1315
=== modified file 'configure.ac'
--- configure.ac 2012-10-03 15:57:01 +0000
+++ configure.ac 2012-12-04 15:47:23 +0000
@@ -27,7 +27,7 @@
27# GTK Doc 27# GTK Doc
28###########################28###########################
2929
30GTK_DOC_CHECK([1.4])30GTK_DOC_CHECK([1.14],[--flavour no-tmpl])
31GNOME_DOC_INIT31GNOME_DOC_INIT
3232
33###########################33###########################
3434
=== modified file 'docs/libdbusmenu-glib/reference/Makefile.am'
--- docs/libdbusmenu-glib/reference/Makefile.am 2011-02-24 15:38:18 +0000
+++ docs/libdbusmenu-glib/reference/Makefile.am 2012-12-04 15:47:23 +0000
@@ -78,7 +78,7 @@
78GTKDOC_LIBS=$(top_builddir)/libdbusmenu-glib/libdbusmenu-glib.la 78GTKDOC_LIBS=$(top_builddir)/libdbusmenu-glib/libdbusmenu-glib.la
7979
80# This includes the standard gtk-doc make rules, copied by gtkdocize.80# This includes the standard gtk-doc make rules, copied by gtkdocize.
81include $(top_srcdir)/gtk-doc.local.make81include $(top_srcdir)/gtk-doc.make
8282
83# Other files to distribute83# Other files to distribute
84# e.g. EXTRA_DIST += version.xml.in84# e.g. EXTRA_DIST += version.xml.in
@@ -89,14 +89,11 @@
89# for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt89# for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
90#DISTCLEANFILES +=90#DISTCLEANFILES +=
9191
92# Comment this out if you want your docs-status tested during 'make check'92# Comment this out if you want 'make check' to test you doc status
93TESTS = gtkdoc-in-srcdir93# and run some sanity checks
9494if ENABLE_GTK_DOC
95gtkdoc-in-srcdir: Makefile.am95 TESTS_ENVIRONMENT = cd $(srcdir) && \
96 @echo "#!/bin/sh" > $@96 DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \
97 @echo "cd \"$(srcdir)\"" >> $@97 SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir)
98 @echo "$(GTKDOC_CHECK)" >> $@98#TESTS = $(GTKDOC_CHECK)
99 @chmod +x $@99endif
100
101DISTCLEANFILES = gtkdoc-in-srcdir
102
103100
=== removed directory 'docs/libdbusmenu-glib/reference/tmpl'
=== removed file 'docs/libdbusmenu-glib/reference/tmpl/dummy.sgml'
=== modified file 'docs/libdbusmenu-gtk/reference/Makefile.am'
--- docs/libdbusmenu-gtk/reference/Makefile.am 2011-08-24 20:41:09 +0000
+++ docs/libdbusmenu-gtk/reference/Makefile.am 2012-12-04 15:47:23 +0000
@@ -78,7 +78,7 @@
78GTKDOC_LIBS=$(top_builddir)/libdbusmenu-gtk/libdbusmenu-gtk$(VER).la $(DBUSMENUGLIB_LIBS) $(DBUSMENUGTK_LIBS)78GTKDOC_LIBS=$(top_builddir)/libdbusmenu-gtk/libdbusmenu-gtk$(VER).la $(DBUSMENUGLIB_LIBS) $(DBUSMENUGTK_LIBS)
7979
80# This includes the standard gtk-doc make rules, copied by gtkdocize.80# This includes the standard gtk-doc make rules, copied by gtkdocize.
81include $(top_srcdir)/gtk-doc.local.make81include $(top_srcdir)/gtk-doc.make
8282
83# Other files to distribute83# Other files to distribute
84# e.g. EXTRA_DIST += version.xml.in84# e.g. EXTRA_DIST += version.xml.in
@@ -89,13 +89,12 @@
89# for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt89# for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
90#DISTCLEANFILES +=90#DISTCLEANFILES +=
9191
92# Comment this out if you want your docs-status tested during 'make check'92# Comment this out if you want 'make check' to test you doc status
93TESTS = gtkdoc-in-srcdir93# and run some sanity checks
9494if ENABLE_GTK_DOC
95gtkdoc-in-srcdir: Makefile.am95 TESTS_ENVIRONMENT = cd $(srcdir) && \
96 @echo "#!/bin/sh" > $@96 DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \
97 @echo "cd \"$(srcdir)\"" >> $@97 SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir)
98 @echo "$(GTKDOC_CHECK)" >> $@98#TESTS = $(GTKDOC_CHECK)
99 @chmod +x $@99endif
100100
101DISTCLEANFILES = gtkdoc-in-srcdir
102101
=== removed directory 'docs/libdbusmenu-gtk/reference/tmpl'
=== removed file 'docs/libdbusmenu-gtk/reference/tmpl/dummy.sgml'
=== removed file 'gtk-doc.local.make'
--- gtk-doc.local.make 2010-06-09 16:24:31 +0000
+++ gtk-doc.local.make 1970-01-01 00:00:00 +0000
@@ -1,194 +0,0 @@
1# -*- mode: makefile -*-
2
3####################################
4# Everything below here is generic #
5####################################
6
7if GTK_DOC_USE_LIBTOOL
8GTKDOC_CC = $(LIBTOOL) --mode=compile $(CC) $(INCLUDES) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS)
9GTKDOC_LD = $(LIBTOOL) --mode=link $(CC) $(AM_CFLAGS) $(CFLAGS) $(AM_LDFLAGS) $(LDFLAGS)
10GTKDOC_RUN = $(LIBTOOL) --mode=execute
11else
12GTKDOC_CC = $(CC) $(INCLUDES) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS)
13GTKDOC_LD = $(CC) $(AM_CFLAGS) $(CFLAGS) $(AM_LDFLAGS) $(LDFLAGS)
14GTKDOC_RUN = sh -c
15endif
16
17# We set GPATH here; this gives us semantics for GNU make
18# which are more like other make's VPATH, when it comes to
19# whether a source that is a target of one rule is then
20# searched for in VPATH/GPATH.
21#
22GPATH = $(srcdir)
23
24TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)
25
26EXTRA_DIST = \
27 $(content_files) \
28 $(HTML_IMAGES) \
29 $(DOC_MAIN_SGML_FILE)
30
31DOC_STAMPS=scan-build.stamp tmpl-build.stamp sgml-build.stamp html-build.stamp \
32 $(srcdir)/tmpl.stamp $(srcdir)/sgml.stamp $(srcdir)/html.stamp
33
34SCANOBJ_FILES = \
35 $(DOC_MODULE).args \
36 $(DOC_MODULE).hierarchy \
37 $(DOC_MODULE).interfaces \
38 $(DOC_MODULE).prerequisites \
39 $(DOC_MODULE).signals
40
41REPORT_FILES = \
42 $(DOC_MODULE)-undocumented.txt \
43 $(DOC_MODULE)-undeclared.txt \
44 $(DOC_MODULE)-unused.txt
45
46CLEANFILES = $(SCANOBJ_FILES) $(REPORT_FILES) $(DOC_STAMPS)
47
48if ENABLE_GTK_DOC
49all-local: html-build.stamp
50else
51all-local:
52endif
53
54docs: html-build.stamp
55
56$(REPORT_FILES): sgml-build.stamp
57
58#### scan ####
59
60scan-build.stamp: $(HFILE_GLOB) $(CFILE_GLOB)
61 @echo 'gtk-doc: Scanning header files'
62 @-chmod -R u+w $(srcdir)
63 cd $(srcdir) && \
64 gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="$(IGNORE_HFILES)" $(SCAN_OPTIONS) $(EXTRA_HFILES)
65 if grep -l '^..*$$' $(srcdir)/$(DOC_MODULE).types > /dev/null 2>&1 ; then \
66 CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" RUN="$(GTKDOC_RUN)" CFLAGS="$(GTKDOC_CFLAGS) $(CFLAGS)" LDFLAGS="$(GTKDOC_LIBS) $(LDFLAGS)" gtkdoc-scangobj $(SCANGOBJ_OPTIONS) --module=$(DOC_MODULE) --output-dir=$(srcdir) ; \
67 else \
68 cd $(srcdir) ; \
69 for i in $(SCANOBJ_FILES) ; do \
70 test -f $$i || touch $$i ; \
71 done \
72 fi
73 touch scan-build.stamp
74
75$(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt: scan-build.stamp
76 @true
77
78#### templates ####
79
80tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt
81 @echo 'gtk-doc: Rebuilding template files'
82 @-chmod -R u+w $(srcdir)
83 cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE) $(MKTMPL_OPTIONS)
84 touch tmpl-build.stamp
85
86tmpl.stamp: tmpl-build.stamp
87 @true
88
89tmpl/*.sgml:
90 @true
91
92
93#### xml ####
94
95sgml-build.stamp: tmpl.stamp $(HFILE_GLOB) $(CFILE_GLOB) $(DOC_MODULE)-sections.txt $(srcdir)/tmpl/*.sgml $(expand_content_files)
96 @echo 'gtk-doc: Building XML'
97 @-chmod -R u+w $(srcdir)
98 cd $(srcdir) && \
99 gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --output-format=xml --expand-content-files="$(expand_content_files)" --main-sgml-file=$(DOC_MAIN_SGML_FILE) $(MKDB_OPTIONS)
100 touch sgml-build.stamp
101
102sgml.stamp: sgml-build.stamp
103 @true
104
105#### html ####
106
107html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
108 @echo 'gtk-doc: Building HTML'
109 @-chmod -R u+w $(srcdir)
110 rm -rf $(srcdir)/html
111 mkdir $(srcdir)/html
112 mkhtml_options=""; \
113 gtkdoc-mkhtml 2>&1 --help | grep >/dev/null "\-\-path"; \
114 if test "$(?)" = "0"; then \
115 mkhtml_options=--path="$(srcdir)"; \
116 fi
117 cd $(srcdir)/html && gtkdoc-mkhtml $(mkhtml_options) $(MKHTML_OPTIONS) $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
118 test "x$(HTML_IMAGES)" = "x" || ( cd $(srcdir) && cp $(HTML_IMAGES) html )
119 @echo 'gtk-doc: Fixing cross-references'
120 cd $(srcdir) && gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
121 touch html-build.stamp
122
123##############
124
125clean-local:
126 rm -f *~ *.bak
127 rm -rf .libs
128
129distclean-local:
130 cd $(srcdir) && \
131 rm -rf xml $(REPORT_FILES) \
132 $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
133
134maintainer-clean-local: clean
135 cd $(srcdir) && rm -rf xml html
136
137install-data-local:
138 installfiles=`echo $(srcdir)/html/*`; \
139 if test "$$installfiles" = '$(srcdir)/html/*'; \
140 then echo '-- Nothing to install' ; \
141 else \
142 if test -n "$(DOC_MODULE_VERSION)"; then \
143 installdir="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \
144 else \
145 installdir="$(DESTDIR)$(TARGET_DIR)"; \
146 fi; \
147 $(mkinstalldirs) $${installdir} ; \
148 for i in $$installfiles; do \
149 echo '-- Installing '$$i ; \
150 $(INSTALL_DATA) $$i $${installdir}; \
151 done; \
152 if test -n "$(DOC_MODULE_VERSION)"; then \
153 mv -f $${installdir}/$(DOC_MODULE).devhelp2 \
154 $${installdir}/$(DOC_MODULE)-$(DOC_MODULE_VERSION).devhelp2; \
155 mv -f $${installdir}/$(DOC_MODULE).devhelp \
156 $${installdir}/$(DOC_MODULE)-$(DOC_MODULE_VERSION).devhelp; \
157 fi; \
158 ! which gtkdoc-rebase >/dev/null 2>&1 || \
159 gtkdoc-rebase --relative --dest-dir=$(DESTDIR) --html-dir=$${installdir} ; \
160 fi
161
162uninstall-local:
163 if test -n "$(DOC_MODULE_VERSION)"; then \
164 installdir="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \
165 else \
166 installdir="$(DESTDIR)$(TARGET_DIR)"; \
167 fi; \
168 rm -rf $${installdir}
169
170#
171# Require gtk-doc when making dist
172#
173if ENABLE_GTK_DOC
174dist-check-gtkdoc:
175else
176dist-check-gtkdoc:
177 @echo "*** gtk-doc must be installed and enabled in order to make dist"
178 @false
179endif
180
181dist-hook: dist-check-gtkdoc dist-hook-local
182 mkdir $(distdir)/tmpl
183 mkdir $(distdir)/xml
184 mkdir $(distdir)/html
185 -cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl
186 -cp $(srcdir)/xml/*.xml $(distdir)/xml
187 -cp $(srcdir)/html/* $(distdir)/html
188 -cp $(srcdir)/$(DOC_MODULE).types $(distdir)/
189 -cp $(srcdir)/$(DOC_MODULE)-sections.txt $(distdir)/
190 cd $(distdir) && rm -f $(DISTCLEANFILES)
191 ! which gtkdoc-rebase >/dev/null 2>&1 || \
192 gtkdoc-rebase --online --relative --html-dir=$(distdir)/html
193
194.PHONY : dist-hook-local docs
1950
=== modified file 'libdbusmenu-glib/menuitem.c'
--- libdbusmenu-glib/menuitem.c 2012-10-26 11:56:50 +0000
+++ libdbusmenu-glib/menuitem.c 2012-12-04 15:47:23 +0000
@@ -1590,8 +1590,6 @@
1590 * 1590 *
1591 * This function sets the internal value of whether this is a1591 * This function sets the internal value of whether this is a
1592 * root node or not.1592 * root node or not.
1593 *
1594 * Return value: None
1595 */1593 */
1596void1594void
1597dbusmenu_menuitem_set_root (DbusmenuMenuitem * mi, gboolean root)1595dbusmenu_menuitem_set_root (DbusmenuMenuitem * mi, gboolean root)
15981596
=== modified file 'libdbusmenu-glib/menuitem.h'
--- libdbusmenu-glib/menuitem.h 2012-10-07 15:35:50 +0000
+++ libdbusmenu-glib/menuitem.h 2012-12-04 15:47:23 +0000
@@ -455,7 +455,7 @@
455 /* Virtual functions */455 /* Virtual functions */
456 dbusmenu_menuitem_buildvariant_slot_t buildvariant;456 dbusmenu_menuitem_buildvariant_slot_t buildvariant;
457 void (*handle_event) (DbusmenuMenuitem * mi, const gchar * name, GVariant * variant, guint timestamp);457 void (*handle_event) (DbusmenuMenuitem * mi, const gchar * name, GVariant * variant, guint timestamp);
458 void (*send_about_to_show) (DbusmenuMenuitem * mi, void (*cb) (DbusmenuMenuitem * mi, gpointer user_data), gpointer cb_data);458 void (*send_about_to_show) (DbusmenuMenuitem * mi, dbusmenu_menuitem_about_to_show_cb cb, gpointer cb_data);
459459
460 void (*show_to_user) (DbusmenuMenuitem * mi, guint timestamp, gpointer cb_data);460 void (*show_to_user) (DbusmenuMenuitem * mi, guint timestamp, gpointer cb_data);
461 gboolean (*about_to_show) (void);461 gboolean (*about_to_show) (void);

Subscribers

People subscribed via source and target branches

to all changes: