Re: new gtk-doc release

classic Classic list List threaded Threaded
8 messages Options
Reply | Threaded
Open this post in threaded view
|

Re: new gtk-doc release

Damon Chaplin
On Wed, 2005-05-25 at 09:37 +0200, Stefan Kost wrote:
> hi damon,
>
> what do you think about making a new gtk-doc release? On guadec I do a BOF about
> gstreamer api doc and among I suggest to move docs to the sources. when doing
> this cleanup, it would be nice to move the long-description too.

I just did a new release, 1.4 (since I think the latest GTK+ depends on
a new gtk-doc).

I forgot to update NEWS though. Oops.

Damon


_______________________________________________
gtk-doc-list mailing list
[hidden email]
http://mail.gnome.org/mailman/listinfo/gtk-doc-list
Reply | Threaded
Open this post in threaded view
|

Re: new gtk-doc release

Stefan Sauer-4
Hi Damon,

> On Wed, 2005-05-25 at 09:37 +0200, Stefan Kost wrote:
>
>>hi damon,
>>
>>what do you think about making a new gtk-doc release? On guadec I do a BOF about
>>gstreamer api doc and among I suggest to move docs to the sources. when doing
>>this cleanup, it would be nice to move the long-description too.
>
>
> I just did a new release, 1.4 (since I think the latest GTK+ depends on
> a new gtk-doc).
Many thanks!
>
> I forgot to update NEWS though. Oops.
>
> Damon

As long as it is updated in CVS, we'll have the NEWS in version 1.5 ;)

Stefan
_______________________________________________
gtk-doc-list mailing list
[hidden email]
http://mail.gnome.org/mailman/listinfo/gtk-doc-list
Reply | Threaded
Open this post in threaded view
|

Re: new gtk-doc release

Owen Taylor
In reply to this post by Damon Chaplin
On Sun, 2005-07-03 at 23:12 +0100, Damon Chaplin wrote:

> On Wed, 2005-05-25 at 09:37 +0200, Stefan Kost wrote:
> > hi damon,
> >
> > what do you think about making a new gtk-doc release? On guadec I do a BOF about
> > gstreamer api doc and among I suggest to move docs to the sources. when doing
> > this cleanup, it would be nice to move the long-description too.
>
> I just did a new release, 1.4 (since I think the latest GTK+ depends on
> a new gtk-doc).
>
> I forgot to update NEWS though. Oops.
Don't put --only-section-tmpl into NEWS if you do update it ... it
doesn't work :-(

Regards,
                                                Owen


_______________________________________________
gtk-doc-list mailing list
[hidden email]
http://mail.gnome.org/mailman/listinfo/gtk-doc-list

signature.asc (196 bytes) Download Attachment
Reply | Threaded
Open this post in threaded view
|

Re: new gtk-doc release

Stefan Sauer-4
Owen Taylor wrote:

> On Sun, 2005-07-03 at 23:12 +0100, Damon Chaplin wrote:
>
>>On Wed, 2005-05-25 at 09:37 +0200, Stefan Kost wrote:
>>
>>>hi damon,
>>>
>>>what do you think about making a new gtk-doc release? On guadec I do a BOF about
>>>gstreamer api doc and among I suggest to move docs to the sources. when doing
>>>this cleanup, it would be nice to move the long-description too.
>>
>>I just did a new release, 1.4 (since I think the latest GTK+ depends on
>>a new gtk-doc).
>>
>>I forgot to update NEWS though. Oops.
>
>
> Don't put --only-section-tmpl into NEWS if you do update it ... it
> doesn't work :-(
>
??? I don't get it (joking?)

Apart
   http://www.gtk.org/gtk-doc/news.html
   http://www.gtk.org/gtk-doc/download.html
need an update too.
Damon, maybe you can re-release gtk-doc 1.4 with an updated NEWS file.

Stefan
_______________________________________________
gtk-doc-list mailing list
[hidden email]
http://mail.gnome.org/mailman/listinfo/gtk-doc-list
Reply | Threaded
Open this post in threaded view
|

Re: new gtk-doc release

Damon Chaplin
In reply to this post by Owen Taylor
On Tue, 2005-07-05 at 11:16 -0400, Owen Taylor wrote:

> On Sun, 2005-07-03 at 23:12 +0100, Damon Chaplin wrote:
> > On Wed, 2005-05-25 at 09:37 +0200, Stefan Kost wrote:
> > > hi damon,
> > >
> > > what do you think about making a new gtk-doc release? On guadec I do a BOF about
> > > gstreamer api doc and among I suggest to move docs to the sources. when doing
> > > this cleanup, it would be nice to move the long-description too.
> >
> > I just did a new release, 1.4 (since I think the latest GTK+ depends on
> > a new gtk-doc).
> >
> > I forgot to update NEWS though. Oops.
>
> Don't put --only-section-tmpl into NEWS if you do update it ... it
> doesn't work :-(

I'd guess this is because MergeSourceDocumentation() in gtkdoc-mkdb.pl
uses the parameter names and order found in the templates.

You may just need to copy the parameter info from the sources over, as
we already do for signals. (Just a guess.)

   if (!defined ($tmpl_params)) {
       #print "No merge for $symbol\n";
+      $SymbolParams{$symbol} = $SourceSymbolParams{$symbol}
       next;
   }

Damon


_______________________________________________
gtk-doc-list mailing list
[hidden email]
http://mail.gnome.org/mailman/listinfo/gtk-doc-list
Reply | Threaded
Open this post in threaded view
|

Re: new gtk-doc release

Owen Taylor
In reply to this post by Stefan Sauer-4
On Wed, 2005-07-06 at 09:05 +0200, Stefan Kost wrote:

> Owen Taylor wrote:
> > On Sun, 2005-07-03 at 23:12 +0100, Damon Chaplin wrote:
> >
> >>On Wed, 2005-05-25 at 09:37 +0200, Stefan Kost wrote:
> >>
> >>>hi damon,
> >>>
> >>>what do you think about making a new gtk-doc release? On guadec I do a BOF about
> >>>gstreamer api doc and among I suggest to move docs to the sources. when doing
> >>>this cleanup, it would be nice to move the long-description too.
> >>
> >>I just did a new release, 1.4 (since I think the latest GTK+ depends on
> >>a new gtk-doc).
> >>
> >>I forgot to update NEWS though. Oops.
> >
> >
> > Don't put --only-section-tmpl into NEWS if you do update it ... it
> > doesn't work :-(
> >
> ??? I don't get it (joking?)
I mean:

2005-05-10  Owen Taylor  <[hidden email]>

        * gtkdoc-mktmpl.in (OutputTemplateFile): Add an
        --only-section-tmpl flag so that projects that keep everything
        but section descriptions inline can avoid cvs conflicts.

Doesn't work, so shouldn't be mentioned as a new feature in 1.4... what
I tested was that the template files contained the right stuff ...
section headers but no symbol docs.

What I didn't test was that the generated doc-book was correct...
it wasn't: gtkdoc-mkdb uses various structures generated when reading
the the section templates to build the docs.

It's very much fixable, but wasn't trivial ... I spent 30 minutes or
so on it and then gave up. (The immediate task at hand then was to
fix the Cairo docs, which I ended up doing by removing
--only-section-tmpl.)

Regards,
                                                Owen


_______________________________________________
gtk-doc-list mailing list
[hidden email]
http://mail.gnome.org/mailman/listinfo/gtk-doc-list

signature.asc (196 bytes) Download Attachment
Reply | Threaded
Open this post in threaded view
|

Re: new gtk-doc release

Owen Taylor
In reply to this post by Damon Chaplin
On Wed, 2005-07-06 at 11:29 +0100, Damon Chaplin wrote:

> On Tue, 2005-07-05 at 11:16 -0400, Owen Taylor wrote:
> > On Sun, 2005-07-03 at 23:12 +0100, Damon Chaplin wrote:
> > > On Wed, 2005-05-25 at 09:37 +0200, Stefan Kost wrote:
> > > > hi damon,
> > > >
> > > > what do you think about making a new gtk-doc release? On guadec I do a BOF about
> > > > gstreamer api doc and among I suggest to move docs to the sources. when doing
> > > > this cleanup, it would be nice to move the long-description too.
> > >
> > > I just did a new release, 1.4 (since I think the latest GTK+ depends on
> > > a new gtk-doc).
> > >
> > > I forgot to update NEWS though. Oops.
> >
> > Don't put --only-section-tmpl into NEWS if you do update it ... it
> > doesn't work :-(
>
> I'd guess this is because MergeSourceDocumentation() in gtkdoc-mkdb.pl
> uses the parameter names and order found in the templates.
>
> You may just need to copy the parameter info from the sources over, as
> we already do for signals. (Just a guess.)
>
>    if (!defined ($tmpl_params)) {
>        #print "No merge for $symbol\n";
> +      $SymbolParams{$symbol} = $SourceSymbolParams{$symbol}
>        next;
>    }
That's probably part of the fix: it isn't the whole fix because
MergeSourceDocumentation isn't even called for symbols unless they are
found in the template files, at the moment. I have a patch around
that changes MergeSourceDocumentation to take the symbol as a parameter
and then call for each symbol when when reading the symbol file, rather
than the current

    foreach $symbol (keys (%SymbolDocs)) {

But that didn't quite get everything working.

Regards,
                                                Owen




Regards,
                                                Owen


_______________________________________________
gtk-doc-list mailing list
[hidden email]
http://mail.gnome.org/mailman/listinfo/gtk-doc-list

signature.asc (196 bytes) Download Attachment
Reply | Threaded
Open this post in threaded view
|

Re: new gtk-doc release

Roger Leigh
In reply to this post by Stefan Sauer-4
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Stefan Kost <[hidden email]> writes:

> Owen Taylor wrote:
>> On Sun, 2005-07-03 at 23:12 +0100, Damon Chaplin wrote:
>>
>>>On Wed, 2005-05-25 at 09:37 +0200, Stefan Kost wrote:
>>>
>>>>hi damon,
>>>>
>>>> what do you think about making a new gtk-doc release? On guadec I
>>>> do a BOF about gstreamer api doc and among I suggest to move docs
>>>> to the sources. when doing this cleanup, it would be nice to move
>>>> the long-description too.
>>>
>>>I just did a new release, 1.4 (since I think the latest GTK+ depends on
>>>a new gtk-doc).
>>>
>>>I forgot to update NEWS though. Oops.
>> Don't put --only-section-tmpl into NEWS if you do update it ... it
>> doesn't work :-(
>>
> ??? I don't get it (joking?)
>
> Apart
>    http://www.gtk.org/gtk-doc/news.html
>    http://www.gtk.org/gtk-doc/download.html
> need an update too.
> Damon, maybe you can re-release gtk-doc 1.4 with an updated NEWS file.

Since this is now in use, bumping the version number would be nicer.

(http://packages.debian.org/changelogs/pool/main/g/gtk-doc/gtk-doc_1.4-1/changelog)


Thanks,
Roger

- --
Roger Leigh
                Printing on GNU/Linux?  http://gimp-print.sourceforge.net/
                Debian GNU/Linux        http://www.debian.org/
                GPG Public Key: 0x25BFB848.  Please sign and encrypt your mail.
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.1 (GNU/Linux)
Comment: Processed by Mailcrypt 3.5.8 <http://mailcrypt.sourceforge.net/>

iD8DBQFCzBJQVcFcaSW/uEgRAqetAKCW2QmcdfxwtD8KjU9/TU5IBk+q7wCfTGqJ
fQxD2QXO5N3QrQDr5I+i2Cc=
=VetF
-----END PGP SIGNATURE-----
_______________________________________________
gtk-doc-list mailing list
[hidden email]
http://mail.gnome.org/mailman/listinfo/gtk-doc-list