Ubuntu One Client

Merge lp:~rodrigo-moya/ubuntuone-client/libsd-api-docs into lp:ubuntuone-client

  1. libsd-api-docs
  2. Merge into trunk
Proposed by Rodrigo Moya
Status: Merged
Approved by: dobey
Approved revision: 737
Merged at revision: 737
Proposed branch: lp:~rodrigo-moya/ubuntuone-client/libsd-api-docs
Merge into: lp:ubuntuone-client
Diff against target: 233 lines (+149/-10)
6 files modified
.bzrignore (+20/-0)
Makefile.am (+1/-10)
configure.ac (+9/-0)
docs/Makefile.am (+9/-0)
docs/reference/Makefile.am (+62/-0)
docs/reference/libsyncdaemon-docs.sgml (+48/-0)
To merge this branch: bzr merge lp:~rodrigo-moya/ubuntuone-client/libsd-api-docs
Reviewer Review Type Date Requested Status
Stuart Langridge (community) Approve
dobey (community) Approve
Review via email: mp+38832@code.launchpad.net

Commit message

Add infrastructure for auto-generated API docs for libsyncdaemon

Description of the change

Add infrastructure for auto-generated API docs for libsyncdaemon

To post a comment you must log in.
Revision history for this message
dobey (dobey) wrote :

make[3]: Entering directory `/home/dobey/Projects/canonical/ubuntuone-client/libsd-api-docs/docs/reference'
gtk-doc: Scanning header files
gtk-doc: Compiling scanner
libtool: compile: gcc -I../../libsyncdaemon -pthread -I/usr/include/dbus-1.0 -I/usr/lib/dbus-1.0/include -I/usr/include/glib-2.0 -I/usr/lib/glib-2.0/include -g -O2 -Wall -Werror -g -O2 -Wall -Werror -c libsyncdaemon-scan.c -fPIC -DPIC -o .libs/libsyncdaemon-scan.o
libtool: compile: gcc -I../../libsyncdaemon -pthread -I/usr/include/dbus-1.0 -I/usr/lib/dbus-1.0/include -I/usr/include/glib-2.0 -I/usr/lib/glib-2.0/include -g -O2 -Wall -Werror -g -O2 -Wall -Werror -c libsyncdaemon-scan.c -o libsyncdaemon-scan.o >/dev/null 2>&1
gtk-doc: Linking scanner
libtool: link: gcc -g -O2 -Wall -Werror .libs/libsyncdaemon-scan.o -pthread -o .libs/libsyncdaemon-scan -L/lib -ldbus-glib-1 -ldbus-1 -lpthread /usr/lib/libgobject-2.0.so /usr/lib/libgthread-2.0.so -lrt /usr/lib/libglib-2.0.so ../../libsyncdaemon/.libs/libsyncdaemon-1.0.so -pthread
.libs/libsyncdaemon-scan.o: In function `get_object_types':
/home/dobey/Projects/canonical/ubuntuone-client/libsd-api-docs/docs/reference/libsyncdaemon-scan.c:43: undefined reference to `add_contact_dialog_get_type'
/home/dobey/Projects/canonical/ubuntuone-client/libsd-api-docs/docs/reference/libsyncdaemon-scan.c:44: undefined reference to `contacts_view_get_type'
/home/dobey/Projects/canonical/ubuntuone-client/libsd-api-docs/docs/reference/libsyncdaemon-scan.c:45: undefined reference to `file_watcher_get_type'
/home/dobey/Projects/canonical/ubuntuone-client/libsd-api-docs/docs/reference/libsyncdaemon-scan.c:46: undefined reference to `gsd_ubuntuone_get_type'
/home/dobey/Projects/canonical/ubuntuone-client/libsd-api-docs/docs/reference/libsyncdaemon-scan.c:47: undefined reference to `location_widget_get_type'
/home/dobey/Projects/canonical/ubuntuone-client/libsd-api-docs/docs/reference/libsyncdaemon-scan.c:48: undefined reference to `share_dialog_get_type'
/home/dobey/Projects/canonical/ubuntuone-client/libsd-api-docs/docs/reference/libsyncdaemon-scan.c:66: undefined reference to `u1_contacts_picker_get_type'
/home/dobey/Projects/canonical/ubuntuone-client/libsd-api-docs/docs/reference/libsyncdaemon-scan.c:67: undefined reference to `ubuntuone_nautilus_get_type'
collect2: ld returned 1 exit status
Linking of scanner failed:
make[3]: *** [scan-build.stamp] Error 1

review: Needs Fixing
Revision history for this message
dobey (dobey) :
review: Approve
Revision history for this message
Stuart Langridge (sil) :
review: Approve
Revision history for this message
dobey (dobey) wrote :
Download full text (12.5 KiB)

The attempt to merge lp:~rodrigo-moya/ubuntuone-client/libsd-api-docs into lp:ubuntuone-client failed. Below is the output from the failed tests.

/usr/bin/gnome-autogen.sh
checking for autoconf >= 2.53...
  testing autoconf2.50... not found.
  testing autoconf... found 2.67
checking for automake >= 1.10...
  testing automake-1.11... found 1.11.1
checking for libtool >= 1.5...
  testing libtoolize... found 2.2.6b
checking for intltool >= 0.30...
  testing intltoolize... found 0.41.1
checking for pkg-config >= 0.14.0...
  testing pkg-config... found 0.25
checking for gtk-doc >= 1.0...
  testing gtkdocize... found 1.15
Checking for required M4 macros...
Checking for forbidden M4 macros...
Processing ./configure.ac
Running libtoolize...
libtoolize: putting auxiliary files in `.'.
libtoolize: copying file `./ltmain.sh'
libtoolize: putting macros in AC_CONFIG_MACRO_DIR, `m4'.
libtoolize: copying file `m4/libtool.m4'
libtoolize: copying file `m4/ltoptions.m4'
libtoolize: copying file `m4/ltsugar.m4'
libtoolize: copying file `m4/ltversion.m4'
libtoolize: copying file `m4/lt~obsolete.m4'
Running intltoolize...
Running gtkdocize...
Running aclocal-1.11...
Running autoconf...
Running autoheader...
Running automake-1.11...
Running ./configure --enable-gtk-doc --enable-debug --with-protocol=/var/cache/tarmac/ubuntuone-storage-protocol/trunk --with-sso=/var/cache/tarmac/ubuntu-sso-client/trunk ...
checking for a BSD-compatible install... /usr/bin/install -c
checking whether build environment is sane... yes
checking for a thread-safe mkdir -p... /bin/mkdir -p
checking for gawk... gawk
checking whether make sets $(MAKE)... yes
checking for style of include used by make... GNU
checking for gcc... gcc
checking whether the C compiler works... yes
checking for C compiler default output file name... a.out
checking for suffix of executables...
checking whether we are cross compiling... no
checking for suffix of object files... o
checking whether we are using the GNU C compiler... yes
checking whether gcc accepts -g... yes
checking for gcc option to accept ISO C89... none needed
checking dependency style of gcc... gcc3
checking for library containing strerror... none required
checking for gcc... (cached) gcc
checking whether we are using the GNU C compiler... (cached) yes
checking whether gcc accepts -g... (cached) yes
checking for gcc option to accept ISO C89... (cached) none needed
checking dependency style of gcc... (cached) gcc3
checking build system type... i686-pc-linux-gnu
checking host system type... i686-pc-linux-gnu
checking for a sed that does not truncate output... /bin/sed
checking for grep that handles long lines and -e... /bin/grep
checking for egrep... /bin/grep -E
checking for fgrep... /bin/grep -F
checking for ld used by gcc... /usr/bin/ld
checking if the linker (/usr/bin/ld) is GNU ld... yes
checking for BSD- or MS-compatible name lister (nm)... /usr/bin/nm -B
checking the name lister (/usr/bin/nm -B) interface... BSD nm
checking whether ln -s works... yes
checking the maximum length of command line arguments... 1572864
checking whether the shell understands some XSI constructs... yes
checking whether the shell understands "+="... yes
checking ...

Revision history for this message
dobey (dobey) wrote :
Download full text (14.3 KiB)

The attempt to merge lp:~rodrigo-moya/ubuntuone-client/libsd-api-docs into lp:ubuntuone-client failed. Below is the output from the failed tests.

/usr/bin/gnome-autogen.sh
checking for autoconf >= 2.53...
  testing autoconf2.50... not found.
  testing autoconf... found 2.67
checking for automake >= 1.10...
  testing automake-1.11... found 1.11.1
checking for libtool >= 1.5...
  testing libtoolize... found 2.2.6b
checking for intltool >= 0.30...
  testing intltoolize... found 0.41.1
checking for pkg-config >= 0.14.0...
  testing pkg-config... found 0.25
checking for gtk-doc >= 1.0...
  testing gtkdocize... found 1.15
Checking for required M4 macros...
Checking for forbidden M4 macros...
Processing ./configure.ac
Running libtoolize...
libtoolize: putting auxiliary files in `.'.
libtoolize: copying file `./ltmain.sh'
libtoolize: putting macros in AC_CONFIG_MACRO_DIR, `m4'.
libtoolize: copying file `m4/libtool.m4'
libtoolize: copying file `m4/ltoptions.m4'
libtoolize: copying file `m4/ltsugar.m4'
libtoolize: copying file `m4/ltversion.m4'
libtoolize: copying file `m4/lt~obsolete.m4'
Running intltoolize...
Running gtkdocize...
Running aclocal-1.11...
Running autoconf...
Running autoheader...
Running automake-1.11...
Running ./configure --enable-gtk-doc --enable-debug --with-protocol=/var/cache/tarmac/ubuntuone-storage-protocol/trunk --with-sso=/var/cache/tarmac/ubuntu-sso-client/trunk ...
checking for a BSD-compatible install... /usr/bin/install -c
checking whether build environment is sane... yes
checking for a thread-safe mkdir -p... /bin/mkdir -p
checking for gawk... gawk
checking whether make sets $(MAKE)... yes
checking for style of include used by make... GNU
checking for gcc... gcc
checking whether the C compiler works... yes
checking for C compiler default output file name... a.out
checking for suffix of executables...
checking whether we are cross compiling... no
checking for suffix of object files... o
checking whether we are using the GNU C compiler... yes
checking whether gcc accepts -g... yes
checking for gcc option to accept ISO C89... none needed
checking dependency style of gcc... gcc3
checking for library containing strerror... none required
checking for gcc... (cached) gcc
checking whether we are using the GNU C compiler... (cached) yes
checking whether gcc accepts -g... (cached) yes
checking for gcc option to accept ISO C89... (cached) none needed
checking dependency style of gcc... (cached) gcc3
checking build system type... i686-pc-linux-gnu
checking host system type... i686-pc-linux-gnu
checking for a sed that does not truncate output... /bin/sed
checking for grep that handles long lines and -e... /bin/grep
checking for egrep... /bin/grep -E
checking for fgrep... /bin/grep -F
checking for ld used by gcc... /usr/bin/ld
checking if the linker (/usr/bin/ld) is GNU ld... yes
checking for BSD- or MS-compatible name lister (nm)... /usr/bin/nm -B
checking the name lister (/usr/bin/nm -B) interface... BSD nm
checking whether ln -s works... yes
checking the maximum length of command line arguments... 1572864
checking whether the shell understands some XSI constructs... yes
checking whether the shell understands "+="... yes
checking ...

Revision history for this message
dobey (dobey) wrote :
Download full text (8.5 KiB)

The attempt to merge lp:~rodrigo-moya/ubuntuone-client/libsd-api-docs into lp:ubuntuone-client failed. Below is the output from the failed tests.

/usr/bin/gnome-autogen.sh
checking for autoconf >= 2.53...
(B testing autoconf2.50... not found.
  testing autoconf... found 2.67
checking for automake >= 1.10...
(B testing automake-1.11... found 1.11.1
checking for libtool >= 1.5...
(B testing libtoolize... found 2.2.6b
checking for intltool >= 0.30...
(B testing intltoolize... found 0.41.0
checking for pkg-config >= 0.14.0...
(B testing pkg-config... found 0.25
checking for gtk-doc >= 1.0...
(B testing gtkdocize... found 1.15
Checking for required M4 macros...
(BChecking for forbidden M4 macros...
(BProcessing ./configure.ac
(BRunning libtoolize...
(Blibtoolize: putting auxiliary files in `.'.
libtoolize: copying file `./ltmain.sh'
libtoolize: putting macros in AC_CONFIG_MACRO_DIR, `m4'.
libtoolize: copying file `m4/libtool.m4'
libtoolize: copying file `m4/ltoptions.m4'
libtoolize: copying file `m4/ltsugar.m4'
libtoolize: copying file `m4/ltversion.m4'
libtoolize: copying file `m4/lt~obsolete.m4'
Running intltoolize...
(BRunning gtkdocize...
(BRunning aclocal-1.11...
(BRunning autoconf...
(BRunning autoheader...
(BRunning automake-1.11...
(BRunning ./configure --enable-gtk-doc --enable-debug --with-protocol=/var/cache/tarmac/ubuntuone-storage-protocol/trunk --with-sso=/var/cache/tarmac/ubuntu-sso-client/trunk ...
(Bchecking for a BSD-compatible install... /usr/bin/install -c
checking whether build environment is sane... yes
checking for a thread-safe mkdir -p... /bin/mkdir -p
checking for gawk... gawk
checking whether make sets $(MAKE)... yes
checking for style of include used by make... GNU
checking for gcc... gcc
checking whether the C compiler works... yes
checking for C compiler default output file name... a.out
checking for suffix of executables...
checking whether we are cross compiling... no
checking for suffix of object files... o
checking whether we are using the GNU C compiler... yes
checking whether gcc accepts -g... yes
checking for gcc option to accept ISO C89... none needed
checking dependency style of gcc... gcc3
checking for library containing strerror... none required
checking for gcc... (cached) gcc
checking whether we are using the GNU C compiler... (cached) yes
checking whether gcc accepts -g... (cached) yes
checking for gcc option to accept ISO C89... (cached) none needed
checking dependency style of gcc... (cached) gcc3
checking build system type... i686-pc-linux-gnu
checking host system type... i686-pc-linux-gnu
checking for a sed that does not truncate output... /bin/sed
checking for grep that handles long lines and -e... /bin/grep
checking for egrep... /bin/grep -E
checking for fgrep... /bin/grep -F
checking for ld used by gcc... /usr/bin/ld
checking if the linker (/usr/bin/ld) is GNU ld... yes
checking for BSD- or MS-compatible name lister (nm)... /usr/bin/nm -B
checking the name lister (/usr/bin/nm -B) interface... BSD nm
checking whether ln -s works... yes
checking the maximum ...

Read more...

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== modified file '.bzrignore'
2--- .bzrignore 2010-07-20 20:18:56 +0000
3+++ .bzrignore 2010-10-19 15:39:44 +0000
4@@ -38,6 +38,7 @@
5 *.rendercache
6 *.service
7 .intltool-merge-cache
8+gtk-doc.make
9
10 ubuntuone-client-*.tar.*
11 hicolor
12@@ -45,6 +46,25 @@
13 storageprotocol
14 clientdefs.py
15 docs/syncdaemon_dbus_api.txt
16+docs/reference/html*
17+docs/reference/libsyncdaemon-decl-list.txt
18+docs/reference/libsyncdaemon-decl-list.txt.bak
19+docs/reference/libsyncdaemon-decl.txt
20+docs/reference/libsyncdaemon-decl.txt.bak
21+docs/reference/libsyncdaemon-overrides.txt
22+docs/reference/libsyncdaemon-sections.txt
23+docs/reference/libsyncdaemon-undeclared.txt
24+docs/reference/libsyncdaemon-undocumented.txt
25+docs/reference/libsyncdaemon-unused.txt
26+docs/reference/libsyncdaemon.args
27+docs/reference/libsyncdaemon.hierarchy
28+docs/reference/libsyncdaemon.interfaces
29+docs/reference/libsyncdaemon.prerequisites
30+docs/reference/libsyncdaemon.signals
31+docs/reference/libsyncdaemon.types
32+docs/reference/*.stamp
33+docs/reference/tmpl
34+docs/reference/xml*
35 logging.conf
36 ubuntuone-marshallers.[ch]
37
38
39=== modified file 'Makefile.am'
40--- Makefile.am 2010-10-07 16:04:50 +0000
41+++ Makefile.am 2010-10-19 15:39:44 +0000
42@@ -1,6 +1,4 @@
43-DISTCHECK_CONFIGURE_FLAGS = --disable-rendering --enable-pycentral --enable-debug
44-
45-SUBDIRS = data libsyncdaemon nautilus po gsd-plugin
46+SUBDIRS = data libsyncdaemon nautilus po gsd-plugin docs
47
48 # Shut libtoolize up
49 ACLOCAL_AMFLAGS = -I m4
50@@ -26,12 +24,6 @@
51 libexec_SCRIPTS = \
52 bin/ubuntuone-syncdaemon
53
54-manfilesdir = $(mandir)/man1
55-manfiles_DATA = \
56- docs/man/ubuntuone-preferences.1 \
57- docs/man/u1sdtool.1 \
58- docs/man/u1sync.1
59-
60 clientdefsdir = $(pythondir)/ubuntuone
61 clientdefs_in_files = ubuntuone/clientdefs.py.in
62 clientdefs_DATA = $(clientdefs_in_files:.py.in=.py)
63@@ -141,7 +133,6 @@
64 HACKING \
65 bin \
66 contrib \
67- docs \
68 tests \
69 pylintrc
70
71
72=== modified file 'configure.ac'
73--- configure.ac 2010-10-08 14:17:47 +0000
74+++ configure.ac 2010-10-19 15:39:44 +0000
75@@ -154,6 +154,13 @@
76 fi
77
78 ##################################################
79+# Check for gtk-doc.
80+##################################################
81+GTK_DOC_CHECK(1.0)
82+DISTCHECK_CONFIGURE_FLAGS="--enable-gtk-doc --disable-rendering --enable-pycentral --enable-debug"
83+AC_SUBST(DISTCHECK_CONFIGURE_FLAGS)
84+
85+##################################################
86 # Check for introspection
87 ##################################################
88 GOBJECT_INTROSPECTION_CHECK([0.6.4])
89@@ -222,6 +229,8 @@
90 nautilus/Makefile
91 po/Makefile.in
92 gsd-plugin/Makefile
93+docs/Makefile
94+docs/reference/Makefile
95 ])
96
97 AC_OUTPUT
98
99=== added file 'docs/Makefile.am'
100--- docs/Makefile.am 1970-01-01 00:00:00 +0000
101+++ docs/Makefile.am 2010-10-19 15:39:44 +0000
102@@ -0,0 +1,9 @@
103+SUBDIRS = reference
104+
105+manfilesdir = $(mandir)/man1
106+manfiles_DATA = \
107+ man/ubuntuone-preferences.1 \
108+ man/u1sdtool.1 \
109+ man/u1sync.1
110+
111+EXTRA_DIST=$(manfiles_DATA)
112\ No newline at end of file
113
114=== added directory 'docs/reference'
115=== added file 'docs/reference/Makefile.am'
116--- docs/reference/Makefile.am 1970-01-01 00:00:00 +0000
117+++ docs/reference/Makefile.am 2010-10-19 15:39:44 +0000
118@@ -0,0 +1,62 @@
119+## Process this file with automake to produce Makefile.in
120+
121+# Dummy targets we need to make distcheck and check pass
122+test test-report perf-report full-report:
123+ ## Ignore
124+
125+# automake requirements
126+AUTOMAKE_OPTIONS = 1.7
127+
128+# The name of the module
129+DOC_MODULE=libsyncdaemon
130+
131+# The top-level SGML file. You can change this if you want to.
132+DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
133+
134+# The directory containing the source code. Relative to $(srcdir).
135+DOC_SOURCE_DIR=../../libsyncdaemon
136+
137+# Extra options to pass to gtkdoc-scangobj. Not normally needed.
138+SCANGOBJ_OPTIONS=
139+
140+# Extra options to supply to gtkdoc-scan.
141+# Fx --rebuild-types --rebuild-sections
142+SCAN_OPTIONS=
143+
144+# Extra options to supply to gtkdoc-mkdb.
145+MKDB_OPTIONS=--sgml-mode --output-format=xml --ignore-files=trio
146+
147+# Extra options to supply to gtkdoc-fixref. Not normally needed.
148+FIXXREF_OPTIONS=
149+
150+# Used for dependencies. The docs will be rebuilt if any of these change.
151+HFILE_GLOB=$(top_srcdir)/libsyncdaemon/syncdaemon-*.h
152+CFILE_GLOB=$(top_srcdir)/libsyncdaemon/syncdaemon-*.c
153+
154+# Header files to ignore when scanning.
155+IGNORE_HFILES= \
156+ utils.h
157+
158+# Images to copy into HTML directory.
159+HTML_IMAGES=
160+
161+# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
162+content_files =
163+
164+# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
165+INCLUDES=-I$(top_srcdir)/libsyncdaemon \
166+ $(DBUS_CFLAGS)
167+
168+GTKDOC_LIBS=$(DBUS_LIBS) \
169+ $(top_builddir)/libsyncdaemon/libsyncdaemon-1.0.la
170+
171+# This includes the standard gtk-doc make rules, copied by gtkdocize.
172+include $(top_srcdir)/gtk-doc.make
173+
174+# Other files to distribute
175+# e.g. EXTRA_DIST += version.xml.in
176+EXTRA_DIST += \
177+ libsyncdaemon.types \
178+ libsyncdaemon-docs.sgml
179+# libsyncdaemon-sections.txt
180+
181
182=== added file 'docs/reference/libsyncdaemon-docs.sgml'
183--- docs/reference/libsyncdaemon-docs.sgml 1970-01-01 00:00:00 +0000
184+++ docs/reference/libsyncdaemon-docs.sgml 2010-10-19 15:39:44 +0000
185@@ -0,0 +1,48 @@
186+<?xml version="1.0"?>
187+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
188+ "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
189+[
190+ <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
191+]>
192+<book id="index">
193+ <bookinfo>
194+ <title>libsyncdaemon Reference Manual</title>
195+ <releaseinfo>
196+ for libsyncdaemon [VERSION].
197+ The latest version of this documentation can be found on-line at
198+ <ulink role="online-location" url="http://[SERVER]/libsyncdaemon/index.html">http://[SERVER]/libsyncdaemon/</ulink>.
199+ </releaseinfo>
200+ </bookinfo>
201+
202+ <chapter>
203+ <title>[Insert title here]</title>
204+ <xi:include href="xml/syncdaemon-metadata.xml"/>
205+ <xi:include href="xml/syncdaemon-events-interface.xml"/>
206+ <xi:include href="xml/syncdaemon-file-info.xml"/>
207+ <xi:include href="xml/syncdaemon-transfer-info.xml"/>
208+ <xi:include href="xml/syncdaemon-share-info.xml"/>
209+ <xi:include href="xml/syncdaemon-filesystem-interface.xml"/>
210+ <xi:include href="xml/syncdaemon-status-interface.xml"/>
211+ <xi:include href="xml/syncdaemon-config-interface.xml"/>
212+ <xi:include href="xml/syncdaemon-publicfiles-interface.xml"/>
213+ <xi:include href="xml/syncdaemon-authentication.xml"/>
214+ <xi:include href="xml/syncdaemon-shares-interface.xml"/>
215+ <xi:include href="xml/syncdaemon-credentials.xml"/>
216+ <xi:include href="xml/syncdaemon-folders-interface.xml"/>
217+ <xi:include href="xml/syncdaemon-daemon.xml"/>
218+ <xi:include href="xml/syncdaemon-interface.xml"/>
219+ <xi:include href="xml/syncdaemon-folder-info.xml"/>
220+ <xi:include href="xml/syncdaemon-status-info.xml"/>
221+
222+ </chapter>
223+ <chapter id="object-tree">
224+ <title>Object Hierarchy</title>
225+ <xi:include href="xml/tree_index.sgml"/>
226+ </chapter>
227+ <index id="api-index-full">
228+ <title>API Index</title>
229+ <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
230+ </index>
231+
232+ <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
233+</book>

Subscribers

People subscribed via source and target branches