gtk-doc-1.22 change wrt to tmpl builds

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

gtk-doc-1.22 change wrt to tmpl builds

Stefan Sauer-4
Hi,

The upcoming gtk-doc-1.22 release will switch the default makefile
flavour from "legacy" to "no-tmpl".
If your configure.ac had a line such as
GTK_DOC_CHECK([1.XX])
without any args you were using a doc build that includes the deprecated
'tmpl' build step. If you the tmpl directory is not committed to your
version control than you are fine. If the tmpl dir is in version
control, please check if you are ever edited documentation in the files
in those directories. If no, remove the dir and change your configure.ac
macro to GTK_DOC_CHECK([1.XX],[--flavour no-tmpl]). If you edited the
tmpl files, please consider moving the docs to the sources, this is the
only model we support in the long run. To keep the project building with
gtk-doc-1.22, explicitly specify the makefile flavour:
GTK_DOC_CHECK([1.XX],[--flavour legacy]). We plan to drop the tooling
for tmpl files in one of the next releases. Please get in touch with us,
if you have trouble with the migration.

If you specified the makefile-flavour like in:
GTK_DOC_CHECK([1.XX],[--flavour no-tmpl])
you already use a build that does not use tmpl files and nothing will
change for you.

We are doing this to simplify the doc build. Maintaining comments in the
sources will increase the change that they are keept up-to-date. Having
generated files that need to be committed to source control systems is a
pain, as the files tend to differ if developers have different versions
of the generating tool. And finally dropping this intermediate step
makes the doc build a little faster.

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

Re: gtk-doc-1.22 change wrt to tmpl builds

Milan Crha
On Sun, 2015-04-26 at 21:38 +0200, Stefan Sauer wrote:
> The upcoming gtk-doc-1.22 release will switch the default makefile
> flavour from "legacy" to "no-tmpl".

        Hi,
I'm trying to build evolution-data-server 3.16.2 against gtk-doc-1.22
and it fails [1]. It has its configure.ac with this line:
   GTK_DOC_CHECK([1.14],[--flavour no-tmpl])
thus should not be affected by the change. Trying to build against
gtk-doc 1.21 works flawlessly.

I'm wondering, could there be a regression in the gtk-doc 1.22, or is
there anything I should fix in evolution-data-server? The thing is that
if I understand the errors properly, then it's in the generated files,
which are mostly out of my hands.
        Thanks and bye,
        Milan

[1] The actual build errors with gtk-doc 1.22:

      DOC   Building HTML
    ../xml/e-source-webdav.xml:125: parser error :
    Opening and ending tag mismatch: note line 125 and para
    <para><note></para>
                       ^
    ../xml/e-source
    -webdav.xml:131: parser error : Opening and ending tag mismatch:
    para line 131 and note
    <para></note></para>
                 ^
    ../xml/e-source-webdav.xml:157: parser error : Opening and ending tag mismatch: note line 157 and para
    <para><note></para>
                       ^
    ../xml/e-source-webdav.xml:163: parser error : Opening and ending tag mismatch: para line 163 and note
    <para></note></para>
                 ^
    ../eds-docs.sgml:118: element include: XInclude error : could not load ../xml/e-source-webdav.xml, and no fallback was found
    ../xml/e-book-client-cursor.xml:244: parser error : Opening and ending tag mismatch: programlisting line 242 and para
        gdouble percent;</para>
                               ^
    ../xml/e-book-client-cursor.xml:245: parser error : xmlParseEntityRef: no name
    <para>    // Fetch the position & total
                                     ^
    ../xml/e-book-client-cursor.xml:256: parser error : Sequence ']]>' not allowed in content
    <para>    // Let the user know the percentage of contacts in the list
          ^
    ../xml/e-book-client-cursor.xml:256: parser error : Sequence ']]>' not allowed in content
        update_percentage_of_list_browsed (user_interface, percent);]]></programlist
                                                                    ^
    ../xml/e-book-client-cursor.xml:256: parser error : internal error: detected an error in element content
        update_percentage_of_list_browsed (user_interface, percent);]]></programlist
                                                                    ^
    ../xml/e-book-client-cursor.xml:256: parser error : Extra content at the end of the document
        update_percentage_of_list_browsed (user_interface, percent);]]></programlist
                                                                    ^
    ../eds-docs.sgml:135: element include: XInclude error : could not load ../xml/e-book-client-cursor.xml, and no fallback was found
    ../eds-docs.sgml:1945: element refsect2: validity error : ID CLIENT-BACKEND-PROPERTY-CAPABILITIES:CAPS already defined
    ../eds-docs.sgml:1951: element refsect2: validity error : ID BOOK-BACKEND-PROPERTY-REQUIRED-FIELDS:CAPS already defined
    ../eds-docs.sgml:1957: element refsect2: validity error : ID BOOK-BACKEND-PROPERTY-SUPPORTED-FIELDS:CAPS already defined
    ../xml/e-data-book-cursor.xml:157: parser error : Opening and ending tag mismatch: programlisting line 151 and para
         gint i;</para>
                       ^
    ../xml/e-data-book-cursor.xml:160: parser error : StartTag: invalid element name
         for (i = 0; i < cursor->n_sort_fields; i++) {</para>
                        ^
    ../xml/e-data-book-cursor.xml:174: parser error : Sequence ']]>' not allowed in content
    <para>     state->last_uid = e_contact_get (contact, E_CONTACT_UID);
          ^
    ../xml/e-data-book-cursor.xml:174: parser error : Sequence ']]>' not allowed in content
    ]]></programlisting>
    ^
    ../xml/e-data-book-cursor.xml:174: parser error : internal error: detected an error in element content
    ]]></programlisting>
    ^
    ../xml/e-data-book-cursor.xml:174: parser error : Extra content at the end of the document
    ]]></programlisting>
    ^
_______________________________________________
gtk-doc-list mailing list
[hidden email]
https://mail.gnome.org/mailman/listinfo/gtk-doc-list
Reply | Threaded
Open this post in threaded view
|

Re: gtk-doc-1.22 change wrt to tmpl builds

Milan Crha
On Mon, 2015-05-11 at 11:19 +0200, Milan Crha wrote:
> I'm trying to build evolution-data-server 3.16.2 against gtk-doc-1.22
> and it fails [1]. It has its configure.ac with this line:
>    GTK_DOC_CHECK([1.14],[--flavour no-tmpl])
> thus should not be affected by the change. Trying to build against
> gtk-doc 1.21 works flawlessly.

        Hi,
just a follow up that Stefan didn't forget of me. I filled
https://bugzilla.gnome.org/show_bug.cgi?id=749268
and we continue there. The git master of gtk-doc had this already
fixed.
        Bye,
        Milan
_______________________________________________
gtk-doc-list mailing list
[hidden email]
https://mail.gnome.org/mailman/listinfo/gtk-doc-list
Reply | Threaded
Open this post in threaded view
|

Re: gtk-doc-1.22 change wrt to tmpl builds

Stefan Sauer-4
On 05/13/2015 05:50 PM, Milan Crha wrote:

> On Mon, 2015-05-11 at 11:19 +0200, Milan Crha wrote:
>> I'm trying to build evolution-data-server 3.16.2 against gtk-doc-1.22
>> and it fails [1]. It has its configure.ac with this line:
>>    GTK_DOC_CHECK([1.14],[--flavour no-tmpl])
>> thus should not be affected by the change. Trying to build against
>> gtk-doc 1.21 works flawlessly.
>         Hi,
> just a follow up that Stefan didn't forget of me. I filled
> https://bugzilla.gnome.org/show_bug.cgi?id=749268
> and we continue there. The git master of gtk-doc had this already
> fixed.
>         Bye,
>         Milan
> _______________________________________________
> desktop-devel-list mailing list
> [hidden email]
> https://mail.gnome.org/mailman/listinfo/desktop-devel-list
The new 1.23 is out. Sorry for the hassle with the broken release.

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