lubuntu-desktop team mailing list archive

[Jonathan Marsden <jmarsden@xxxxxxxxxxx>]

On 05/22/2011 08:43 PM, PCMan wrote:

> Another problem I got in libfm.
> When I tried to add gtk-doc and glib-testing supports to it, some
> errors happened during make.
> Actually I did not know how to correctly use these tools. Help is
> needed in this part.
> An option may be removing gtk-doc support for now since there are no
> usable API docs yet.

I'm very new to GTK programming, but the manual for GTK-Doc at

  http://developer.gnome.org/gtk-doc-manual/

looks reasonably sane.  I can take a look; I'm probably better at
playing with autoconf build infrastructure than at significantly
changing the code  itself, at this point :)

OK, in an Lubuntu 11.04 VM, I did a git pull to update my git repo for
libfm, and then (being paranoid, and just to be really sure to keep my
local git tree clean) I did a git archive, and then unpacked the
archive, and then did a test build inside that tree, with:

  script -c "date && sh ./autogen.sh && ./configure --sysconfdir=/etc \
    --enable-gtk-doc && make && date" ../build-$(date +%F-%H%M%S).log

This configures and makes libfm, with the gtk-doc stuff enabled. (If
this is *not* a sensible way to test build libfm, please correct me!)

The log file contains a lot of warnings about missing documentation of
fields and parameters,  but ignoring those for now (I don't know the
codebase well enough to add them, anyway!):

  grep -v "warning: Field descriptions for" \
    ../build-2011-05-22-230624.log | \
    grep -v "warning: Parameter description for" |less +/^gtk-doc:

displays me the output below this email.  I see only one actual error,
in there, the line saying

ERROR: ENUM has no name ./libfm-decl.txt:1080

The rest are all "just" warnings.

Is that the same error you are seeing?  Just one?  You said "some
errors", so I was expecting to find more than that!  I'll look at it
further, but please just give me a quick sanity check that we are
looking at the same issue, first :)

Jonathan
----------------------------------------------------------------
gtk-doc: Building XML
ERROR: ENUM has no name ./libfm-decl.txt:1080
../../../src/base/fm-path.c:238: warning: Parsing comment block file :
parameter expected.
../../../src/gtk/fm-dnd-auto-scroll.c:139: warning: Parsing comment
block file : parameter expected.
../../../src/gtk/fm-dnd-auto-scroll.c:180: warning: Parsing comment
block file : parameter expected.
../../../src/gtk/fm-gtk-utils.c:74: warning: Parsing comment block file
: parameter expected.
../../../src/gtk/fm-gtk-utils.c:92: warning: Parsing comment block file
: parameter expected.
../../../src/gtk/fm-gtk-utils.c:124: warning: Parsing comment block file
: parameter expected.
../../../src/gtk/fm-dnd-dest.c:483: warning: Parsing comment block file
: parameter expected.
../../../src/gtk/fm-dnd-dest.c:484: warning: Parsing comment block file
: parameter expected.
../../../src/gtk/fm-dnd-dest.c:485: warning: Parsing comment block file
: parameter expected.
../../../src/gtk/fm-dnd-dest.c:488: warning: Free-form return value
description in fm_dnd_dest_get_default_action. Use `Returns:' to avoid
ambiguities.
../../../src/job/fm-job.c:40: warning: Section fmjob is not defined in
the libfm-section.txt file.
./libfm-sections.txt:8: warning: No declaration found for
fm_folder_get_for_path.
:0: warning: Value descriptions for FmPlaceType are missing in source
code comment block.
./libfm-sections.txt:627: warning: No declaration found for
fm_places_select.
./libfm-sections.txt:745: warning: No declaration found for
fm_path_entry_set_model.
See libfm-undeclared.txt for the list of undeclared symbols.
./libfm-unused.txt:1: warning: 68 unused declarations.They should be
added to libfm-sections.txt in the appropriate place.
make[4]: Leaving directory
`/home/jonathan/packages/libfm/gitversion/libfm-20110523/docs/reference/libfm'
make[4]: Entering directory
`/home/jonathan/packages/libfm/gitversion/libfm-20110523/docs/reference'
make[4]: Nothing to be done for `all-am'.
make[4]: Leaving directory
`/home/jonathan/packages/libfm/gitversion/libfm-20110523/docs/reference'
make[3]: Leaving directory
`/home/jonathan/packages/libfm/gitversion/libfm-20110523/docs/reference'
make[3]: Entering directory
`/home/jonathan/packages/libfm/gitversion/libfm-20110523/docs'
make[3]: Nothing to be done for `all-am'.
make[3]: Leaving directory
`/home/jonathan/packages/libfm/gitversion/libfm-20110523/docs'
make[2]: Leaving directory
`/home/jonathan/packages/libfm/gitversion/libfm-20110523/docs'
make[2]: Entering directory
`/home/jonathan/packages/libfm/gitversion/libfm-20110523'
make[2]: Leaving directory
`/home/jonathan/packages/libfm/gitversion/libfm-20110523'
make[1]: Leaving directory
`/home/jonathan/packages/libfm/gitversion/libfm-20110523'
Sun May 22 23:07:17 PDT 2011

Script done on Sun 22 May 2011 11:07:17 PM PDT