Nabble - Gtk+ - Documentation

Re: Roll Brasero tarballs for 2.29.3

2009-11-30T09:56:11Z

Hey,

(cc'ing gtk-doc-list)

Le lundi 30 novembre 2009, à 17:42 +0000, Luis Medinas a écrit :
> Hi
>
> I would like to ask someone from the release team to roll a 2.29.3 tarball.
> Me and Philippe are pretty busy right now and i don't have a jhbuild
> environment setup.

I'll try to do a tarball, but not before at least 3 hours...

> The main problem is because brasero needs gtk-doc from git master in
> order to have introspection enabled.

This is not really good :/ Does it only affect tarball creation, or will
people building tarballs with --enable-gtk-doc have the issue too?

Is there a gtk-doc release planned in the near future?

Vincent

--
Les gens heureux ne sont pas pressés.
_______________________________________________
gtk-doc-list mailing list
gtk-doc-list@...
http://mail.gnome.org/mailman/listinfo/gtk-doc-list

Re: wrong git-clone link

2009-11-19T19:22:42Z

2009/11/19 David Nečas <yeti@...>:

>
> Hi, the download page
>
> http://www.gtk.org/gtk-doc/download.html
>
> shows wrong git clone command, i.e.
>
> git clone http://git.gnome.org/gtk-doc
>
> instead of
>
> git clone git://git.gnome.org/gtk-doc
>

Fixed, thank you for your report

--
Javier Jardón Cabezas
_______________________________________________
gtk-doc-list mailing list
gtk-doc-list@...
http://mail.gnome.org/mailman/listinfo/gtk-doc-list

wrong git-clone link

2009-11-19T06:22:33Z

Hi, the download page

http://www.gtk.org/gtk-doc/download.html

shows wrong git clone command, i.e.

git clone http://git.gnome.org/gtk-doc

instead of

git clone git://git.gnome.org/gtk-doc

AFAICT git.gnome.org does not work over HTTP.

Yeti

_______________________________________________
gtk-doc-list mailing list
gtk-doc-list@...
http://mail.gnome.org/mailman/listinfo/gtk-doc-list

Re: gobject introspection annotations

2009-10-27T14:13:02Z

Hi,

Stefan Kost wrote:
> Iain Nicol schrieb:
> > Where could the problem lie? -mkdb?
>
> Have you added
> <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
> to your master document? See tests/annotations/docs/tester-docs.xml near to the
> end. The xslt does a fallback if the local links do not exist.
I hadn't; I was looking in the completely wrong place. That solves the
problem. :-)

Thanks,

--
Iain Nicol
<http://www.iainnicol.com./>
_______________________________________________
gtk-doc-list mailing list
gtk-doc-list@...
http://mail.gnome.org/mailman/listinfo/gtk-doc-list

Re: Compile error with make -j2

2009-10-27T13:45:16Z

On Tue, Oct 27, 2009 at 10:25:19PM +0200, Stefan Kost wrote:

> Andy Spencer schrieb:
> > I'm getting a compiler error when compiling my project "make -j2".
> > I'm not sure if I'm doing something wrong (I haven't configured gtk-doc
> > much) or if other projects would have similar problems.
> >
> >
> yes, It seesm to fails. There is a feature request here to support it.
> https://bugzilla.gnome.org/show_bug.cgi?id=543489
>
> It would be great if you/someone can try to track it down.

Funny because I always build the documentation with -j5 and it works
(not that it is any faster, but -j5 is simply used for everything
including the docs).

The problem occurs only if you don't have foo-docs.xml.

> > Steps to reproduce:
> > git clone git://lug.rose-hulman.edu/proj/libgis
> > cd libgis
> > ./autogen.sh --enable-gtk-doc
> > make -j2
> >
> >
> > Output:
> > ...
> > make[2]: Entering directory `/scratch/libgis/docs'
> > Making all in api
> > make[3]: Entering directory `/scratch/libgis/docs/api'
> > make[3]: *** No rule to make target `libgis-docs.sgml', needed by
> > `html-build.stamp'. Stop.
> > make[3]: *** Waiting for unfinished jobs....
> > make[3]: Leaving directory `/scratch/libgis/docs/api'
> > make[2]: *** [all-recursive] Error 1
> > make[2]: Leaving directory `/scratch/libgis/docs'
> > ...

But foo-docs.xml (or .sgml if you insist) is supposed to be maintained
by a human. The fact gtkdoc-mkdb attempts to helpfully create it as a
side-effect (one the Makefile has no knowledge of -- which leads to the
error) does not change a tiny bit on that.

The real fix is to stop creating foo-docs.xml in gtkdoc-mkdb because the
file is not usable as-is anyway. Then everyone is forced to really have
this human-maintained file in the version control system and the above
situation cannot happen.

A suitable foo-docs.xml template can be then provided with gtk-doc (if
it isn't already).

Yeti

_______________________________________________
gtk-doc-list mailing list
gtk-doc-list@...
http://mail.gnome.org/mailman/listinfo/gtk-doc-list

Re: gobject introspection annotations

2009-10-27T13:32:17Z

hi,

Iain Nicol schrieb:

> Hi,
>
> I'm adding gobject introspection annotations to Epiphany, because it
> needs some. My problem is I don't know how to get gtk-doc to recognise
> them. Instead of gtk-doc understanding and describing the annotations,
> gtk-doc creates links to FOLDOC; the symptoms are like in
> <https://bugzilla.gnome.org/show_bug.cgi?id=598732>.
>
> I've compiled gtk-doc from git. In particular, the ``annotations'' test
> that comes with gtk-doc works fine. Yet I don't know how to get it to
> work for Epiphany.
>
> Is there any particular makefile or autofoo stuff or flags I should look
> at?

Not at all.

> Where could the problem lie? -mkdb?

Have you added
<xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
to your master document? See tests/annotations/docs/tester-docs.xml near to the
end. The xslt does a fallback if the local links do not exist.

Stefan

>
>
> Epiphany's doc build process seems fairly normal. It has gtk-doc build
> and run a scanner. Then the templates are created:
> cd . && gtkdoc-mktmpl --module=epiphany
> then:
> cd . && gtkdoc-mkdb --module=epiphany --source-dir=../.. \
> --output-format=xml --sgml-mode --output-format=xml
> and then:
> cd ./html && gtkdoc-mkhtml epiphany ../epiphany-docs.sgml
> and finally:
> cd . && gtkdoc-fixxref --module-dir=html \
> --html-dir=/usr/local/share/gtk-doc/html
>
> There's loads of output from all the commands, but the only relevant
> thing I could see was the following warning from -mkhtml:
>
> In gtk-doc.xsl: For acronym (transfer none) no value found!
>
>
> Thanks,

_______________________________________________
gtk-doc-list mailing list
gtk-doc-list@...
http://mail.gnome.org/mailman/listinfo/gtk-doc-list

Re: Compile error with make -j2

2009-10-27T13:25:19Z

hi,

Andy Spencer schrieb:
> I'm getting a compiler error when compiling my project "make -j2".
> I'm not sure if I'm doing something wrong (I haven't configured gtk-doc
> much) or if other projects would have similar problems.
>
>
yes, It seesm to fails. There is a feature request here to support it.
https://bugzilla.gnome.org/show_bug.cgi?id=543489

It would be great if you/someone can try to track it down.

Stefan

> Steps to reproduce:
> git clone git://lug.rose-hulman.edu/proj/libgis
> cd libgis
> ./autogen.sh --enable-gtk-doc
> make -j2
>
>
> Output:
> ...
> make[2]: Entering directory `/scratch/libgis/docs'
> Making all in api
> make[3]: Entering directory `/scratch/libgis/docs/api'
> make[3]: *** No rule to make target `libgis-docs.sgml', needed by
> `html-build.stamp'. Stop.
> make[3]: *** Waiting for unfinished jobs....
> make[3]: Leaving directory `/scratch/libgis/docs/api'
> make[2]: *** [all-recursive] Error 1
> make[2]: Leaving directory `/scratch/libgis/docs'
> ...
>
>
> ------------------------------------------------------------------------
>
> _______________________________________________
> gtk-doc-list mailing list
> gtk-doc-list@...
> http://mail.gnome.org/mailman/listinfo/gtk-doc-list

_______________________________________________
gtk-doc-list mailing list
gtk-doc-list@...
http://mail.gnome.org/mailman/listinfo/gtk-doc-list

gobject introspection annotations

2009-10-26T14:08:20Z

Hi,

I'm adding gobject introspection annotations to Epiphany, because it
needs some. My problem is I don't know how to get gtk-doc to recognise
them. Instead of gtk-doc understanding and describing the annotations,
gtk-doc creates links to FOLDOC; the symptoms are like in
<https://bugzilla.gnome.org/show_bug.cgi?id=598732>.

I've compiled gtk-doc from git. In particular, the ``annotations'' test
that comes with gtk-doc works fine. Yet I don't know how to get it to
work for Epiphany.

Is there any particular makefile or autofoo stuff or flags I should look
at? Where could the problem lie? -mkdb?

Epiphany's doc build process seems fairly normal. It has gtk-doc build
and run a scanner. Then the templates are created:
cd . && gtkdoc-mktmpl --module=epiphany
then:
cd . && gtkdoc-mkdb --module=epiphany --source-dir=../.. \
--output-format=xml --sgml-mode --output-format=xml
and then:
cd ./html && gtkdoc-mkhtml epiphany ../epiphany-docs.sgml
and finally:
cd . && gtkdoc-fixxref --module-dir=html \
--html-dir=/usr/local/share/gtk-doc/html

There's loads of output from all the commands, but the only relevant
thing I could see was the following warning from -mkhtml:

In gtk-doc.xsl: For acronym (transfer none) no value found!

Thanks,
--
Iain Nicol
<http://www.iainnicol.com./>

_______________________________________________
gtk-doc-list mailing list
gtk-doc-list@...
http://mail.gnome.org/mailman/listinfo/gtk-doc-list

Compile error with make -j2

2009-10-25T14:13:43Z

I'm getting a compiler error when compiling my project "make -j2".
I'm not sure if I'm doing something wrong (I haven't configured gtk-doc
much) or if other projects would have similar problems.

Steps to reproduce:
git clone git://lug.rose-hulman.edu/proj/libgis
cd libgis
./autogen.sh --enable-gtk-doc
make -j2

Output:
...
make[2]: Entering directory `/scratch/libgis/docs'
Making all in api
make[3]: Entering directory `/scratch/libgis/docs/api'
make[3]: *** No rule to make target `libgis-docs.sgml', needed by
`html-build.stamp'. Stop.
make[3]: *** Waiting for unfinished jobs....
make[3]: Leaving directory `/scratch/libgis/docs/api'
make[2]: *** [all-recursive] Error 1
make[2]: Leaving directory `/scratch/libgis/docs'
...

_______________________________________________
gtk-doc-list mailing list
gtk-doc-list@...
http://mail.gnome.org/mailman/listinfo/gtk-doc-list

attachment0 (205 bytes) Download Attachment

Re: Preferred way of putting title in section

2009-09-02T00:17:16Z

On Wed, Sep 02, 2009 at 12:46:56AM +0200, Krzesimir Nowak wrote:
> which way of putting title of section is preferred?
> 1. `@title: my title' in SECTION comment in source code.
> 2. `<TITLE>my title</TITLE> in package-sections.txt.
>
> There is a FIXME in `Documenting section' in gtk-doc manual about this.
> It would be good to have it clarified.

The former because package-sections.txt can be (and should be) generated
nowadays with gtkdoc-scan --rebuild-sections if you have sanely
organized header files.

Yeti

_______________________________________________
gtk-doc-list mailing list
gtk-doc-list@...
http://mail.gnome.org/mailman/listinfo/gtk-doc-list

Preferred way of putting title in section

2009-09-01T15:46:56Z

Hi,

which way of putting title of section is preferred?
1. `@title: my title' in SECTION comment in source code.
2. `<TITLE>my title</TITLE> in package-sections.txt.

There is a FIXME in `Documenting section' in gtk-doc manual about this.
It would be good to have it clarified.

Thanks,
Krzem

_______________________________________________
gtk-doc-list mailing list
gtk-doc-list@...
http://mail.gnome.org/mailman/listinfo/gtk-doc-list

Forward declarations with --rebuild-sections

2009-08-13T10:28:14Z

Hi all,

I'm having some problems using --rebuild-sections. With a
container-child relationship between two types I need this
forward declaration:

/* File: adg-entity.h */
typedef struct _AdgContainer AdgContainer;

/* File: adg-container.h */
#include <adg/adg-entity.h>
struct _AdgContainer {
...
};

With the above code, gtk-doc added AdgContainer both in
<FILE>adg-entity</FILE> and <FILE>adg-container</FILE> sections,
resulting in tons of these warnings when building the HTML:

Warning: multiple "IDs" for constraint linkend: AdgContainer.

To solve this issue I had to trick gtk-doc using the preprocessor:

#define ADG_FORWARD_DECL(id) typedef struct _##id id

/* File: adg-entity.h */
ADG_FORWARD_DECL(AdgContainer);

/* File: adg-container.h */
#include <adg/adg-entity.h>
#if 0
/* AdgContainer declared in adg-entity.h */
typedef struct _AdgContainer AdgContainer;
#endif
struct _AdgContainer {
...
};

This gives the expected result, that is AdgContainer defined only in
<FILE>adg-container</FILE> section.

After taking a look at gtkdoc-scan it seems (from the comments) that
forward declarations of enum are treated properly while struct not
(after all, both of them can be opaque).

I'm not able to provide a valid patch: do you want I submit a bug or
something else? I'll keep the above workaround alive to be backward
compatible with gtk-doc so this is no more a big issue for me.

Ciao
--
Nicola
_______________________________________________
gtk-doc-list mailing list
gtk-doc-list@...
http://mail.gnome.org/mailman/listinfo/gtk-doc-list

Re: Without autotools

2009-08-13T09:21:56Z

The shell quoting failed when I tried CC="gcc" CC='gcc' CC=\"gcc\" and
CC=\'gcc\' when passing variables to the perl script. However if
gtkdoc-scangobj is harmful for my project I guess that point is moot.

The source is here: https://sourceforge.net/projects/mebitag/

I settled on NaturalDocs because I didn't want to spend more time
getting documentation working than writing the actual program. It
doesn't have full C support but I like the readability I get so maybe
this gtkdoc problem isn't a priority for me anymore.
_______________________________________________
gtk-doc-list mailing list
gtk-doc-list@...
http://mail.gnome.org/mailman/listinfo/gtk-doc-list

Re: Without autotools

2009-08-12T14:04:04Z

hi,

On 3:33:43 pm 12/08/2009 Nicola Fontana <ntd@...> wrote:

> Il giorno Tue, 11 Aug 2009 13:48:33 -0400
> Connor Behan <connor.behan@...> ha scritto:
>
> > The comments all follow this format: http://pastebin.com/mc8edc76
>
> Hi,
>
> the docblocks look good to me: the problem is not there.
>
> > What I'm doing (using gtk-doc.make as a guide) is:
> >
> > gtkdoc-scan --module=libmebi --source-dir=.
> > gtkdoc-scangobj --module=libmebi --output-dir=.
> >
> > Then this fails because I hate figuring out how to quote shell

Whats the error?

>
> gtkdoc-scangobj requires a project based on GObject and if libmebi is
> not such kind of project this step is useless (in your case harmful
> too). Just touch the required files, probably:
>
> libmebi.types
> libmebi.args
> libmebi.hierarchy
> libmebi.interfaces
> libmebi.prerequisites
> libmebi.signals
>
> and jump directly to the gtkdoc-mktmpl step. There will probably be
> other adjustments to do: a link to the sources would be more helpful.
>

If you have the doc-comment inside the sources, you can also skip the
gtkdoc-mktmpl step. Users of autotools get the same behaviour when running
gtkdocize --flavour=no-tmpl.

Stefan

> Ciao
> --
> Nicola
> _______________________________________________
> gtk-doc-list mailing list
> gtk-doc-list@...
> http://mail.gnome.org/mailman/listinfo/gtk-doc-list

_______________________________________________
gtk-doc-list mailing list
gtk-doc-list@...
http://mail.gnome.org/mailman/listinfo/gtk-doc-list

Re: Without autotools

2009-08-12T06:33:43Z

Il giorno Tue, 11 Aug 2009 13:48:33 -0400
Connor Behan <connor.behan@...> ha scritto:

> The comments all follow this format: http://pastebin.com/mc8edc76

Hi,

the docblocks look good to me: the problem is not there.

> What I'm doing (using gtk-doc.make as a guide) is:
>
> gtkdoc-scan --module=libmebi --source-dir=.
> gtkdoc-scangobj --module=libmebi --output-dir=.
>
> Then this fails because I hate figuring out how to quote shell

gtkdoc-scangobj requires a project based on GObject and if libmebi is
not such kind of project this step is useless (in your case harmful
too). Just touch the required files, probably:

libmebi.types
libmebi.args
libmebi.hierarchy
libmebi.interfaces
libmebi.prerequisites
libmebi.signals

and jump directly to the gtkdoc-mktmpl step. There will probably be
other adjustments to do: a link to the sources would be more helpful.

Ciao
--
Nicola
_______________________________________________
gtk-doc-list mailing list
gtk-doc-list@...
http://mail.gnome.org/mailman/listinfo/gtk-doc-list

Without autotools

2009-08-11T10:48:33Z

I have a very small program called mebitag and I'd like to document its
library without an ugly doxygen logo on the html. I think this is a
reasonable request but every time I try gtk-doc, it tells me I get 3%
documentation and fills the html files with data structures that are all
missing comments. I am doing this all from the libmebi directory which
contains:

Makefile dbops.h dbquery.h fileio.c mebitag.7
dbops.c dbquery.c errors.h fileio.h types.h

The comments all follow this format: http://pastebin.com/mc8edc76

What I'm doing (using gtk-doc.make as a guide) is:

gtkdoc-scan --module=libmebi --source-dir=.
gtkdoc-scangobj --module=libmebi --output-dir=.

Then this fails because I hate figuring out how to quote shell variables
so I then run:

gcc -o libmebi-scan `pkg-config --cflags --libs gtk+-2.0` libmebi-scan.c

Then I take every file that ends in .new and make a copy of it that
doesn't end in .new, then I run:

gtkdoc-mktmpl --module=libmebi
gtkdoc-mkdb --module=libmebi --output-format=xml
--main-sgml-file=libmebi.sgml
mkdir html && cd html && gtkdoc-mkhtml --path=. libmebi ../libmebi.sgml

This produces the empty html and I have tried for days without finding a
way around that. I could edit the html to put comments in but that
greatly defeats the purpose. Any help would be much appreciated.
_______________________________________________
gtk-doc-list mailing list
gtk-doc-list@...
http://mail.gnome.org/mailman/listinfo/gtk-doc-list

Re: Problem about secondly run "gtkdoc-mkdb"

2009-08-06T06:25:58Z

"--output-format=xml" will still trigger the "DOCTYPE-missing" bug.

I've cloned the git repo, and find it vastly adopts the entities-way. It also has some manual-written sgml or xml files (e.g. glib/docs/reference/glib/gtester-report.xml), which are also DOCTYPE-missing.

BTW, I encounter a new problem: I have some C files which don't include any header files. The symbols in these C files will be imported by the "extern" modifier. gtk-doc seems blind to the comment blocks in these C files, any suggestions?

2009/8/6 Stefan Kost <ensonic@...>

cee1 schrieb:

> I've edited the foo-docs.sgml, following the glib style:
> """
> <!ENTITY bar1 SYSTEM "xml/bar1.xml">
> <!ENTITY bar2 SYSTEM "xml/bar2.xml">
> ...
> """
> , and then reference not include them. The problem can be avoid.

Don't do this. glib is not doing this anymore. This makes your docbuild
slow. Use xml instead of sgml and then use xi:inlcude. Using entities
for includes will expand the entities in each document.

Stefan

>
> 2009/8/3 Stefan Kost <ensonic@...

> <mailto:ensonic@...>>

>
> cee1 schrieb:
> > 2009/8/3 Stefan Kost <ensonic@...

> <mailto:ensonic@...>>

> >
> >> cee1 schrieb:
> >>> 2009/8/2 Stefan Kost <ensonic@...

> <mailto:ensonic@...>>

> >>>
> >>>> hi,
> >>>>
> >>>> cee1 schrieb:
> >>>>> Hi all,
> >>>>> I'm using gtk-doc(1.11) to manager documents of my small
> project. I
> >>>>> encounter some problems like: "../xml/foo.xml:161: parser
> error :
> >> Entity
> >>>>> 'ast' not defined", when secondly running gtk-doc.
> >>>>>
> >>>>> The steps are:
> >>>>> 1) gtkdoc-scan --module=foo --source-dir=../../foo
> >> --ignore-headers="a.h
> >>>>> b.h"
> >>>>> 2) gtkdoc-mkdb --module=foo --source-dir=../../foo
> --output-format=xml
> >>>>> --expand-content-files="" --main-sgml-file=foo-docs.sgml
> --sgml-mode
> >>>>> --output-format=xml --ignore-files="a.c b.h"
> >>>>> ...
> >>>> Are you using the normal gtkdoc.make included in your makefile?
> >>>>
> >>> Yes.
> >>>
> >>>>> I find in the second time, gtkdoc-mkdb generates XML files
> missing the
> >>>>> following:
> >>>>> <?xml version="1.0"?>
> >>>>> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
> >>>>>
> "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd
> >> ">
> >>>> The doctype is copied if the foo-docs.sgml or foo-docs.xml
> main document
> >>>> has it.
> >>>> Is the project publicly available somewhere?
> >>>>
> >>> If the foo-docs.sgml already exists, rerunning gtkdoc-mkdb
> will generate
> >>> doctype-missing XML files, hence cause the
> "../xml/foo.xml:161: parser
> >> error
> >>> : Entity 'ast' not defined".
> >>>
> >> How come it does not exist earlier? gtkdoc creates a template
> on the very
> >> first
> >> run, but you need to edit that to suit you and add it to your
> version
> >> control
> >> system.
> >
> >
> > After first run gtk-doc, the foo-docs.sgml is there. Re-run
> gtkdoc-mkdb
> > will generate doctype-missing XML files, unless delete the
> foo-docs.sgml.
> >
> > The same problem exists in glib, when I do:
> >
> > 1) In the top-level directory of glib, run ./autogen.sh
> --enable-gtk-doc
> >
> > 2) cd docs/reference/glib # could see the glib-docs.sgml
> is shipped
> > with glib
> >
> > 3) make # check files in XML
> directory, they
> > are missing the "doctype"
> >
> > 4) rm -f glib-docs.sgml && make clean && make
> >
> > 5) now check files in XML directory, they are OK.
>
> I had no time to try myself. If the generated foo-docs.sgml has no
> DOCTYPE in
> the header, just add it yourself. Or try adding
> "--output-format=xml" to
> MKDB_OPTIONS in your Makefile.am for the docs.
>
> I had a quick look at the sources though and it needs a fix. If
> there is no
> foo-docs.{sgml,xml} we add a xml DOCTYPE to add generated files,
> but generate
> the main document as sgml. Please file a bug to bugzilla.gnome.org

> <http://bugzilla.gnome.org>.

>
> Stefan
>
> >
> >
> >> Could you also try with gtk-doc from git.gnome.org

> <http://git.gnome.org> - I'd like to release

> >> 1.12 in
> >> september, would be good to see if its already fixed?
> Unfortunately I'll be
> >> on
> >> vacation starting from tomorrow, so I won't be able to reply in
> august
> >> anymore.
> >> Hopefully someone else on the list can help.
> >>
> >> Stefan
> >>
> > OK, thanks any way.
> >
> >>> The project is not public yet, since the documents not ready.
> >>>
> >>>> Stefan
> >>>>
> >>>>> Any suggestions?
> >>>>> Thanks.
> >>>>>
> >
>
>

_______________________________________________
gtk-doc-list mailing list
gtk-doc-list@...
http://mail.gnome.org/mailman/listinfo/gtk-doc-list

Re: Problem about secondly run "gtkdoc-mkdb"

2009-08-06T04:50:20Z

cee1 schrieb:
> I've edited the foo-docs.sgml, following the glib style:
> """
> <!ENTITY bar1 SYSTEM "xml/bar1.xml">
> <!ENTITY bar2 SYSTEM "xml/bar2.xml">
> ...
> """
> , and then reference not include them. The problem can be avoid.
Don't do this. glib is not doing this anymore. This makes your docbuild
slow. Use xml instead of sgml and then use xi:inlcude. Using entities
for includes will expand the entities in each document.

Stefan

>
> 2009/8/3 Stefan Kost <ensonic@...
> <mailto:ensonic@...>>
>
> cee1 schrieb:
> > 2009/8/3 Stefan Kost <ensonic@...
> <mailto:ensonic@...>>
> >
> >> cee1 schrieb:
> >>> 2009/8/2 Stefan Kost <ensonic@...
> <mailto:ensonic@...>>
> >>>
> >>>> hi,
> >>>>
> >>>> cee1 schrieb:
> >>>>> Hi all,
> >>>>> I'm using gtk-doc(1.11) to manager documents of my small
> project. I
> >>>>> encounter some problems like: "../xml/foo.xml:161: parser
> error :
> >> Entity
> >>>>> 'ast' not defined", when secondly running gtk-doc.
> >>>>>
> >>>>> The steps are:
> >>>>> 1) gtkdoc-scan --module=foo --source-dir=../../foo
> >> --ignore-headers="a.h
> >>>>> b.h"
> >>>>> 2) gtkdoc-mkdb --module=foo --source-dir=../../foo
> --output-format=xml
> >>>>> --expand-content-files="" --main-sgml-file=foo-docs.sgml
> --sgml-mode
> >>>>> --output-format=xml --ignore-files="a.c b.h"
> >>>>> ...
> >>>> Are you using the normal gtkdoc.make included in your makefile?
> >>>>
> >>> Yes.
> >>>
> >>>>> I find in the second time, gtkdoc-mkdb generates XML files
> missing the
> >>>>> following:
> >>>>> <?xml version="1.0"?>
> >>>>> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
> >>>>>
> "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd
> >> ">
> >>>> The doctype is copied if the foo-docs.sgml or foo-docs.xml
> main document
> >>>> has it.
> >>>> Is the project publicly available somewhere?
> >>>>
> >>> If the foo-docs.sgml already exists, rerunning gtkdoc-mkdb
> will generate
> >>> doctype-missing XML files, hence cause the
> "../xml/foo.xml:161: parser
> >> error
> >>> : Entity 'ast' not defined".
> >>>
> >> How come it does not exist earlier? gtkdoc creates a template
> on the very
> >> first
> >> run, but you need to edit that to suit you and add it to your
> version
> >> control
> >> system.
> >
> >
> > After first run gtk-doc, the foo-docs.sgml is there. Re-run
> gtkdoc-mkdb
> > will generate doctype-missing XML files, unless delete the
> foo-docs.sgml.
> >
> > The same problem exists in glib, when I do:
> >
> > 1) In the top-level directory of glib, run ./autogen.sh
> --enable-gtk-doc
> >
> > 2) cd docs/reference/glib # could see the glib-docs.sgml
> is shipped
> > with glib
> >
> > 3) make # check files in XML
> directory, they
> > are missing the "doctype"
> >
> > 4) rm -f glib-docs.sgml && make clean && make
> >
> > 5) now check files in XML directory, they are OK.
>
> I had no time to try myself. If the generated foo-docs.sgml has no
> DOCTYPE in
> the header, just add it yourself. Or try adding
> "--output-format=xml" to
> MKDB_OPTIONS in your Makefile.am for the docs.
>
> I had a quick look at the sources though and it needs a fix. If
> there is no
> foo-docs.{sgml,xml} we add a xml DOCTYPE to add generated files,
> but generate
> the main document as sgml. Please file a bug to bugzilla.gnome.org
> <http://bugzilla.gnome.org>.
>
> Stefan
>
> >
> >
> >> Could you also try with gtk-doc from git.gnome.org
> <http://git.gnome.org> - I'd like to release
> >> 1.12 in
> >> september, would be good to see if its already fixed?
> Unfortunately I'll be
> >> on
> >> vacation starting from tomorrow, so I won't be able to reply in
> august
> >> anymore.
> >> Hopefully someone else on the list can help.
> >>
> >> Stefan
> >>
> > OK, thanks any way.
> >
> >>> The project is not public yet, since the documents not ready.
> >>>
> >>>> Stefan
> >>>>
> >>>>> Any suggestions?
> >>>>> Thanks.
> >>>>>
> >
>
>

_______________________________________________
gtk-doc-list mailing list
gtk-doc-list@...
http://mail.gnome.org/mailman/listinfo/gtk-doc-list

Re: Problem about secondly run "gtkdoc-mkdb"

2009-08-03T04:09:02Z

I've edited the foo-docs.sgml, following the glib style:

"""

<!ENTITY bar1 SYSTEM "xml/bar1.xml">

<!ENTITY bar2 SYSTEM "xml/bar2.xml">

...

"""
, and then reference not include them. The problem can be avoid.

2009/8/3 Stefan Kost <ensonic@...>

cee1 schrieb:

> 2009/8/3 Stefan Kost <ensonic@...>
>
>> cee1 schrieb:
>>> 2009/8/2 Stefan Kost <ensonic@...>
>>>
>>>> hi,
>>>>
>>>> cee1 schrieb:
>>>>> Hi all,
>>>>> I'm using gtk-doc(1.11) to manager documents of my small project. I
>>>>> encounter some problems like: "../xml/foo.xml:161: parser error :
>> Entity
>>>>> 'ast' not defined", when secondly running gtk-doc.
>>>>>
>>>>> The steps are:
>>>>> 1) gtkdoc-scan --module=foo --source-dir=../../foo
>> --ignore-headers="a.h
>>>>> b.h"
>>>>> 2) gtkdoc-mkdb --module=foo --source-dir=../../foo --output-format=xml
>>>>> --expand-content-files="" --main-sgml-file=foo-docs.sgml --sgml-mode
>>>>> --output-format=xml --ignore-files="a.c b.h"
>>>>> ...
>>>> Are you using the normal gtkdoc.make included in your makefile?
>>>>
>>> Yes.
>>>
>>>>> I find in the second time, gtkdoc-mkdb generates XML files missing the
>>>>> following:
>>>>> <?xml version="1.0"?>
>>>>> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
>>>>> "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd
>> ">
>>>> The doctype is copied if the foo-docs.sgml or foo-docs.xml main document
>>>> has it.
>>>> Is the project publicly available somewhere?
>>>>
>>> If the foo-docs.sgml already exists, rerunning gtkdoc-mkdb will generate
>>> doctype-missing XML files, hence cause the "../xml/foo.xml:161: parser
>> error
>>> : Entity 'ast' not defined".
>>>
>> How come it does not exist earlier? gtkdoc creates a template on the very
>> first
>> run, but you need to edit that to suit you and add it to your version
>> control
>> system.
>
>
> After first run gtk-doc, the foo-docs.sgml is there. Re-run gtkdoc-mkdb
> will generate doctype-missing XML files, unless delete the foo-docs.sgml.
>
> The same problem exists in glib, when I do:
>
> 1) In the top-level directory of glib, run ./autogen.sh --enable-gtk-doc
>
> 2) cd docs/reference/glib # could see the glib-docs.sgml is shipped
> with glib
>
> 3) make # check files in XML directory, they
> are missing the "doctype"
>
> 4) rm -f glib-docs.sgml && make clean && make
>
> 5) now check files in XML directory, they are OK.

I had no time to try myself. If the generated foo-docs.sgml has no DOCTYPE in
the header, just add it yourself. Or try adding "--output-format=xml" to
MKDB_OPTIONS in your Makefile.am for the docs.

I had a quick look at the sources though and it needs a fix. If there is no
foo-docs.{sgml,xml} we add a xml DOCTYPE to add generated files, but generate
the main document as sgml. Please file a bug to bugzilla.gnome.org.

Stefan

>
>
>> Could you also try with gtk-doc from git.gnome.org - I'd like to release
>> 1.12 in
>> september, would be good to see if its already fixed? Unfortunately I'll be
>> on
>> vacation starting from tomorrow, so I won't be able to reply in august
>> anymore.
>> Hopefully someone else on the list can help.
>>
>> Stefan
>>
> OK, thanks any way.
>
>>> The project is not public yet, since the documents not ready.
>>>
>>>> Stefan
>>>>
>>>>> Any suggestions?
>>>>> Thanks.
>>>>>
>

_______________________________________________
gtk-doc-list mailing list
gtk-doc-list@...
http://mail.gnome.org/mailman/listinfo/gtk-doc-list

Re: Problem about secondly run "gtkdoc-mkdb"

2009-08-03T03:18:26Z

cee1 schrieb:

> 2009/8/3 Stefan Kost <ensonic@...>
>
>> cee1 schrieb:
>>> 2009/8/2 Stefan Kost <ensonic@...>
>>>
>>>> hi,
>>>>
>>>> cee1 schrieb:
>>>>> Hi all,
>>>>> I'm using gtk-doc(1.11) to manager documents of my small project. I
>>>>> encounter some problems like: "../xml/foo.xml:161: parser error :
>> Entity
>>>>> 'ast' not defined", when secondly running gtk-doc.
>>>>>
>>>>> The steps are:
>>>>> 1) gtkdoc-scan --module=foo --source-dir=../../foo
>> --ignore-headers="a.h
>>>>> b.h"
>>>>> 2) gtkdoc-mkdb --module=foo --source-dir=../../foo --output-format=xml
>>>>> --expand-content-files="" --main-sgml-file=foo-docs.sgml --sgml-mode
>>>>> --output-format=xml --ignore-files="a.c b.h"
>>>>> ...
>>>> Are you using the normal gtkdoc.make included in your makefile?
>>>>
>>> Yes.
>>>
>>>>> I find in the second time, gtkdoc-mkdb generates XML files missing the
>>>>> following:
>>>>> <?xml version="1.0"?>
>>>>> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
>>>>> "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd
>> ">
>>>> The doctype is copied if the foo-docs.sgml or foo-docs.xml main document
>>>> has it.
>>>> Is the project publicly available somewhere?
>>>>
>>> If the foo-docs.sgml already exists, rerunning gtkdoc-mkdb will generate
>>> doctype-missing XML files, hence cause the "../xml/foo.xml:161: parser
>> error
>>> : Entity 'ast' not defined".
>>>
>> How come it does not exist earlier? gtkdoc creates a template on the very
>> first
>> run, but you need to edit that to suit you and add it to your version
>> control
>> system.
>
>
> After first run gtk-doc, the foo-docs.sgml is there. Re-run gtkdoc-mkdb
> will generate doctype-missing XML files, unless delete the foo-docs.sgml.
>
> The same problem exists in glib, when I do:
>
> 1) In the top-level directory of glib, run ./autogen.sh --enable-gtk-doc
>
> 2) cd docs/reference/glib # could see the glib-docs.sgml is shipped
> with glib
>
> 3) make # check files in XML directory, they
> are missing the "doctype"
>
> 4) rm -f glib-docs.sgml && make clean && make
>
> 5) now check files in XML directory, they are OK.

I had no time to try myself. If the generated foo-docs.sgml has no DOCTYPE in
the header, just add it yourself. Or try adding "--output-format=xml" to
MKDB_OPTIONS in your Makefile.am for the docs.

I had a quick look at the sources though and it needs a fix. If there is no
foo-docs.{sgml,xml} we add a xml DOCTYPE to add generated files, but generate
the main document as sgml. Please file a bug to bugzilla.gnome.org.

Stefan

>
>
>> Could you also try with gtk-doc from git.gnome.org - I'd like to release
>> 1.12 in
>> september, would be good to see if its already fixed? Unfortunately I'll be
>> on
>> vacation starting from tomorrow, so I won't be able to reply in august
>> anymore.
>> Hopefully someone else on the list can help.
>>
>> Stefan
>>
> OK, thanks any way.
>
>>> The project is not public yet, since the documents not ready.
>>>
>>>> Stefan
>>>>
>>>>> Any suggestions?
>>>>> Thanks.
>>>>>
>

_______________________________________________
gtk-doc-list mailing list
gtk-doc-list@...
http://mail.gnome.org/mailman/listinfo/gtk-doc-list

Re: Problem about secondly run "gtkdoc-mkdb"

2009-08-02T18:23:06Z

2009/8/3 Stefan Kost <ensonic@...>

cee1 schrieb:

> 2009/8/2 Stefan Kost <ensonic@...>
>
>> hi,
>>
>> cee1 schrieb:
>>> Hi all,
>>> I'm using gtk-doc(1.11) to manager documents of my small project. I
>>> encounter some problems like: "../xml/foo.xml:161: parser error : Entity
>>> 'ast' not defined", when secondly running gtk-doc.
>>>
>>> The steps are:
>>> 1) gtkdoc-scan --module=foo --source-dir=../../foo --ignore-headers="a.h
>>> b.h"
>>> 2) gtkdoc-mkdb --module=foo --source-dir=../../foo --output-format=xml
>>> --expand-content-files="" --main-sgml-file=foo-docs.sgml --sgml-mode
>>> --output-format=xml --ignore-files="a.c b.h"
>>> ...
>> Are you using the normal gtkdoc.make included in your makefile?
>>
>
> Yes.
>
>>> I find in the second time, gtkdoc-mkdb generates XML files missing the
>>> following:
>>> <?xml version="1.0"?>
>>> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
>>> "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">
>>>
>> The doctype is copied if the foo-docs.sgml or foo-docs.xml main document
>> has it.
>> Is the project publicly available somewhere?
>>
>
> If the foo-docs.sgml already exists, rerunning gtkdoc-mkdb will generate
> doctype-missing XML files, hence cause the "../xml/foo.xml:161: parser error
> : Entity 'ast' not defined".
>

How come it does not exist earlier? gtkdoc creates a template on the very first
run, but you need to edit that to suit you and add it to your version control
system.

After first run gtk-doc, the foo-docs.sgml is there. Re-run gtkdoc-mkdb will generate doctype-missing XML files, unless delete the foo-docs.sgml.

The same problem exists in glib, when I do:

1) In the top-level directory of glib, run ./autogen.sh --enable-gtk-doc

2) cd docs/reference/glib # could see the glib-docs.sgml is shipped with glib

3) make # check files in XML directory, they are missing the "doctype"

4) rm -f glib-docs.sgml && make clean && make

5) now check files in XML directory, they are OK.

Could you also try with gtk-doc from git.gnome.org - I'd like to release 1.12 in
september, would be good to see if its already fixed? Unfortunately I'll be on
vacation starting from tomorrow, so I won't be able to reply in august anymore.
Hopefully someone else on the list can help.

Stefan

OK, thanks any way.

>
> The project is not public yet, since the documents not ready.
>
>> Stefan
>>
>>> Any suggestions?
>>> Thanks.
>>>

_______________________________________________
gtk-doc-list mailing list
gtk-doc-list@...
http://mail.gnome.org/mailman/listinfo/gtk-doc-list

Re: Problem about secondly run "gtkdoc-mkdb"

2009-08-02T10:50:47Z

cee1 schrieb:

> 2009/8/2 Stefan Kost <ensonic@...>
>
>> hi,
>>
>> cee1 schrieb:
>>> Hi all,
>>> I'm using gtk-doc(1.11) to manager documents of my small project. I
>>> encounter some problems like: "../xml/foo.xml:161: parser error : Entity
>>> 'ast' not defined", when secondly running gtk-doc.
>>>
>>> The steps are:
>>> 1) gtkdoc-scan --module=foo --source-dir=../../foo --ignore-headers="a.h
>>> b.h"
>>> 2) gtkdoc-mkdb --module=foo --source-dir=../../foo --output-format=xml
>>> --expand-content-files="" --main-sgml-file=foo-docs.sgml --sgml-mode
>>> --output-format=xml --ignore-files="a.c b.h"
>>> ...
>> Are you using the normal gtkdoc.make included in your makefile?
>>
>
> Yes.
>
>>> I find in the second time, gtkdoc-mkdb generates XML files missing the
>>> following:
>>> <?xml version="1.0"?>
>>> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
>>> "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">
>>>
>> The doctype is copied if the foo-docs.sgml or foo-docs.xml main document
>> has it.
>> Is the project publicly available somewhere?
>>
>
> If the foo-docs.sgml already exists, rerunning gtkdoc-mkdb will generate
> doctype-missing XML files, hence cause the "../xml/foo.xml:161: parser error
> : Entity 'ast' not defined".
>

How come it does not exist earlier? gtkdoc creates a template on the very first
run, but you need to edit that to suit you and add it to your version control
system.

Could you also try with gtk-doc from git.gnome.org - I'd like to release 1.12 in
september, would be good to see if its already fixed? Unfortunately I'll be on
vacation starting from tomorrow, so I won't be able to reply in august anymore.
Hopefully someone else on the list can help.

Stefan

>
> The project is not public yet, since the documents not ready.
>
>> Stefan
>>
>>> Any suggestions?
>>> Thanks.
>>>
_______________________________________________
gtk-doc-list mailing list
gtk-doc-list@...
http://mail.gnome.org/mailman/listinfo/gtk-doc-list

Re: Problem about secondly run "gtkdoc-mkdb"

2009-08-02T05:20:01Z

2009/8/2 Stefan Kost <ensonic@...>

hi,

cee1 schrieb:

> Hi all,
> I'm using gtk-doc(1.11) to manager documents of my small project. I
> encounter some problems like: "../xml/foo.xml:161: parser error : Entity
> 'ast' not defined", when secondly running gtk-doc.
>
> The steps are:
> 1) gtkdoc-scan --module=foo --source-dir=../../foo --ignore-headers="a.h
> b.h"
> 2) gtkdoc-mkdb --module=foo --source-dir=../../foo --output-format=xml
> --expand-content-files="" --main-sgml-file=foo-docs.sgml --sgml-mode
> --output-format=xml --ignore-files="a.c b.h"
> ...

Are you using the normal gtkdoc.make included in your makefile?

Yes.

>
> I find in the second time, gtkdoc-mkdb generates XML files missing the
> following:
> <?xml version="1.0"?>
> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
> "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">
>

The doctype is copied if the foo-docs.sgml or foo-docs.xml main document has it.
Is the project publicly available somewhere?

If the foo-docs.sgml already exists, rerunning gtkdoc-mkdb will generate doctype-missing XML files, hence cause the "../xml/foo.xml:161: parser error : Entity 'ast' not defined".

The project is not public yet, since the documents not ready.

Stefan

> Any suggestions?
> Thanks.
>
>
>
> ------------------------------------------------------------------------
>
> _______________________________________________
> gtk-doc-list mailing list
> gtk-doc-list@...
> http://mail.gnome.org/mailman/listinfo/gtk-doc-list

_______________________________________________
gtk-doc-list mailing list
gtk-doc-list@...
http://mail.gnome.org/mailman/listinfo/gtk-doc-list

Re: Problem about secondly run "gtkdoc-mkdb"

2009-08-02T05:03:29Z

hi,

cee1 schrieb:

> Hi all,
> I'm using gtk-doc(1.11) to manager documents of my small project. I
> encounter some problems like: "../xml/foo.xml:161: parser error : Entity
> 'ast' not defined", when secondly running gtk-doc.
>
> The steps are:
> 1) gtkdoc-scan --module=foo --source-dir=../../foo --ignore-headers="a.h
> b.h"
> 2) gtkdoc-mkdb --module=foo --source-dir=../../foo --output-format=xml
> --expand-content-files="" --main-sgml-file=foo-docs.sgml --sgml-mode
> --output-format=xml --ignore-files="a.c b.h"
> ...

Are you using the normal gtkdoc.make included in your makefile?

>
> I find in the second time, gtkdoc-mkdb generates XML files missing the
> following:
> <?xml version="1.0"?>
> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
> "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">
>

The doctype is copied if the foo-docs.sgml or foo-docs.xml main document has it.
Is the project publicly available somewhere?

Stefan

> Any suggestions?
> Thanks.
>
>
>
> ------------------------------------------------------------------------
>
> _______________________________________________
> gtk-doc-list mailing list
> gtk-doc-list@...
> http://mail.gnome.org/mailman/listinfo/gtk-doc-list

_______________________________________________
gtk-doc-list mailing list
gtk-doc-list@...
http://mail.gnome.org/mailman/listinfo/gtk-doc-list

Problem about secondly run "gtkdoc-mkdb"

2009-08-02T02:22:27Z

Hi all,

I'm using gtk-doc(1.11) to manager documents of my small project. I encounter some problems like: "../xml/foo.xml:161: parser error : Entity 'ast' not defined", when secondly running gtk-doc.

The steps are:

1) gtkdoc-scan --module=foo --source-dir=../../foo --ignore-headers="a.h b.h"

2) gtkdoc-mkdb --module=foo --source-dir=../../foo --output-format=xml --expand-content-files="" --main-sgml-file=foo-docs.sgml --sgml-mode --output-format=xml --ignore-files="a.c b.h"

...

I find in the second time, gtkdoc-mkdb generates XML files missing the following:

<?xml version="1.0"?>

<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"

"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">

Any suggestions?

Thanks.

_______________________________________________
gtk-doc-list mailing list
gtk-doc-list@...
http://mail.gnome.org/mailman/listinfo/gtk-doc-list

Re: Chapter IDs instead of chapter numbers

2009-07-19T01:56:11Z

On Sun, Jul 19, 2009 at 10:42:02AM +0200, Murray Cumming wrote:
> How can we make gtk-doc use a (DocBook?) specified chapter id (or one
> based on the title) instead of a generated chapter number, so that the
> URL stays the same even if a chapter is added in the middle:

If you give it an id in the DocBook source, e.g.

<refentry id="...">
<chapter id="...">

it should be used because gtk-doc.xsl does

<xsl:param name="use.id.as.filename" select="1"/>

It works for me.

Yeti

_______________________________________________
gtk-doc-list mailing list
gtk-doc-list@...
http://mail.gnome.org/mailman/listinfo/gtk-doc-list

Chapter IDs instead of chapter numbers

2009-07-19T01:42:02Z

How can we make gtk-doc use a (DocBook?) specified chapter id (or one
based on the title) instead of a generated chapter number, so that the
URL stays the same even if a chapter is added in the middle:

For instance:
http://library.gnome.org/devel/libgda/unstable/ch18.html

--
murrayc@...
www.murrayc.com
www.openismus.com

_______________________________________________
gtk-doc-list mailing list
gtk-doc-list@...
http://mail.gnome.org/mailman/listinfo/gtk-doc-list

make check okay again

2009-07-07T05:11:42Z

hi,

thanks to the translators for fixing the translations. Now its make
check clean again.

Stefan
_______________________________________________
gtk-doc-list mailing list
gtk-doc-list@...
http://mail.gnome.org/mailman/listinfo/gtk-doc-list

Re: spanish gtk-doc manual

2009-06-29T09:46:19Z

hi,

Stefan Kost schrieb:

> hi,
>
> could you please fix the xml validity or confirm that the git repo is the
> canonical source and its fine if I fix it there.
>
> Stefan
>
> xmllint --noout --noent --path es:./es --xinclude --postvalid
> ./es/gtk-doc-manual.xml
> ./es/gtk-doc-manual.xml:755: element para: validity error : Element
> placeholder-1 is not declared in para list of possible children
> ./es/gtk-doc-manual.xml:755: element placeholder-1: validity error : No
> declaration for element placeholder-1
> ./es/gtk-doc-manual.xml:765: element para: validity error : Element
> placeholder-1 is not declared in para list of possible children
> ./es/gtk-doc-manual.xml:765: element placeholder-1: validity error : No
> declaration for element placeholder-1
> ./es/gtk-doc-manual.xml:765: element link: validity error : IDREF attribute
> linkend references an unknown ID "documenting_systax"
> Document ./es/gtk-doc-manual.xml does not validate
>

I have fixed 2 errors, but I still wonder about the "placeholder-1"
tags. Can I make them comments. If you don't reply I'll just do it to
get the "make check" back to work.

Also how can I get files in a git checkout which are then untracked?
Whats going on here?

Stefan
_______________________________________________
gtk-doc-list mailing list
gtk-doc-list@...
http://mail.gnome.org/mailman/listinfo/gtk-doc-list

Re: gtk-doc resolution-independen branch

2009-06-01T11:48:58Z

Matthias Clasen schrieb:

> On Sat, May 23, 2009 at 1:56 PM, Stefan Kost <ensonic@...> wrote:
>
>> Yes, something like that. I think its okay to ship the gtk module with gtk-doc
>> unless gtk itself wants to take it. I never did a perl module - so I need to
>> sudy a bit how and where they should be installed.
>
>
> I don't have any particular desire to start shipping perl modules with
> gtk. I think it makes a lot more sense to ship gobject and gtk support
> with gtk-doc, as it has always been.

Don't worry about the gobject stuff. For gtk specific thing it would be good to
somehow pick the bits and pieces and group them in a module. But again for the
sake of backward compat it should be shipped with gtk-doc. Lets discuss this
again in the future if its done and if we still think it should go elsewhere :)

Stefan
_______________________________________________
gtk-doc-list mailing list
gtk-doc-list@...
http://mail.gnome.org/mailman/listinfo/gtk-doc-list

spanish gtk-doc manual

2009-06-01T11:42:09Z

hi,

could you please fix the xml validity or confirm that the git repo is the
canonical source and its fine if I fix it there.

Stefan

xmllint --noout --noent --path es:./es --xinclude --postvalid
./es/gtk-doc-manual.xml
./es/gtk-doc-manual.xml:755: element para: validity error : Element
placeholder-1 is not declared in para list of possible children
./es/gtk-doc-manual.xml:755: element placeholder-1: validity error : No
declaration for element placeholder-1
./es/gtk-doc-manual.xml:765: element para: validity error : Element
placeholder-1 is not declared in para list of possible children
./es/gtk-doc-manual.xml:765: element placeholder-1: validity error : No
declaration for element placeholder-1
./es/gtk-doc-manual.xml:765: element link: validity error : IDREF attribute
linkend references an unknown ID "documenting_systax"
Document ./es/gtk-doc-manual.xml does not validate

_______________________________________________
gtk-doc-list mailing list
gtk-doc-list@...
http://mail.gnome.org/mailman/listinfo/gtk-doc-list

Re: gtk-doc resolution-independen branch

2009-05-29T14:48:18Z

On Sat, May 23, 2009 at 1:56 PM, Stefan Kost <ensonic@...> wrote:

> Yes, something like that. I think its okay to ship the gtk module with gtk-doc
> unless gtk itself wants to take it. I never did a perl module - so I need to
> sudy a bit how and where they should be installed.

I don't have any particular desire to start shipping perl modules with
gtk. I think it makes a lot more sense to ship gobject and gtk support
with gtk-doc, as it has always been.
_______________________________________________
gtk-doc-list mailing list
gtk-doc-list@...
http://mail.gnome.org/mailman/listinfo/gtk-doc-list

Re: gtk-doc resolution-independen branch

2009-05-24T23:22:39Z

On Sat, 2009-05-23 at 20:56 +0300, Stefan Kost wrote:

> Yes, something like that. I think its okay to ship the gtk module with gtk-doc
> unless gtk itself wants to take it. I never did a perl module - so I need to
> sudy a bit how and where they should be installed.
> I should finalize and release 1.12 before though :)

We can install them wherever we like, and then set that install path in
the Perl scangobj program via `use lib`.

Alternatively, we could consider GModules.

--
Davyd Madeley

http://www.davyd.id.au/
08B0 341A 0B9B 08BB 2118 C060 2EDD BB4F 5191 6CDA

_______________________________________________
gtk-doc-list mailing list
gtk-doc-list@...
http://mail.gnome.org/mailman/listinfo/gtk-doc-list

Re: gtk-doc resolution-independen branch

2009-05-23T10:56:22Z

Davyd Madeley schrieb:

> Hey,
>
> Yeah. I did wonder about adding GTK+ specific code there, but I noticed
> there was already a stack of it, so I didn't feel too upset.
>
> I think using plugins is a good idea though.
>
> Maybe the solution is to allow the passing of an optional Perl module
> (e.g. --with-plugin=gtk.pm) that can define certain hooks within the
> scanner e.g. to fiddle with the type handling etc. We can modify the
> gtk-doc.make to provide a WITH_PLUGIN in the Makefile.am.
>

Yes, something like that. I think its okay to ship the gtk module with gtk-doc
unless gtk itself wants to take it. I never did a perl module - so I need to
sudy a bit how and where they should be installed.
I should finalize and release 1.12 before though :)

Stefan

> Thoughts?
>
> --d
>
> On Fri, 2009-05-22 at 22:38 +0300, Stefan Kost wrote:
>> hi,
>>
>> saw your changes for res-indep gtk branch for gtk-doc. I'd like to discuss how
>> we can handle this better in gtk-doc by using some sort of plugins. gtk+ itself
>> has some gtk-specific support in gtk-doc, but e.g. gstreamer has lots of gobject
>> things that could get some special doc treatment.
>>
>> Ideally gtk-doc itself only knows about gobject and all the gtk-specific things
>> go to a module (that could be active by default for backwards compat). gstreamer
>> things go to a gst module. modules can be activated/deactivated in Makefile.am.
>>
>> I don't have thought this any deeper though.
>>
>> Stefan

_______________________________________________
gtk-doc-list mailing list
gtk-doc-list@...
http://mail.gnome.org/mailman/listinfo/gtk-doc-list

Re: gtk-doc resolution-independen branch

2009-05-22T18:25:41Z

Hey,

Yeah. I did wonder about adding GTK+ specific code there, but I noticed
there was already a stack of it, so I didn't feel too upset.

I think using plugins is a good idea though.

Maybe the solution is to allow the passing of an optional Perl module
(e.g. --with-plugin=gtk.pm) that can define certain hooks within the
scanner e.g. to fiddle with the type handling etc. We can modify the
gtk-doc.make to provide a WITH_PLUGIN in the Makefile.am.

Thoughts?

--d

On Fri, 2009-05-22 at 22:38 +0300, Stefan Kost wrote:

> hi,
>
> saw your changes for res-indep gtk branch for gtk-doc. I'd like to discuss how
> we can handle this better in gtk-doc by using some sort of plugins. gtk+ itself
> has some gtk-specific support in gtk-doc, but e.g. gstreamer has lots of gobject
> things that could get some special doc treatment.
>
> Ideally gtk-doc itself only knows about gobject and all the gtk-specific things
> go to a module (that could be active by default for backwards compat). gstreamer
> things go to a gst module. modules can be activated/deactivated in Makefile.am.
>
> I don't have thought this any deeper though.
>
> Stefan

--
Davyd Madeley

http://www.davyd.id.au/
08B0 341A 0B9B 08BB 2118 C060 2EDD BB4F 5191 6CDA

_______________________________________________
gtk-doc-list mailing list
gtk-doc-list@...
http://mail.gnome.org/mailman/listinfo/gtk-doc-list