GTK-Doc 1.32 (Aug 15 2019)
===============
Hotfix release.
GTK-Doc 1.31 (Aug 5 2019)
===============
Nonmaintainer release to fix "Wrong permissions for style CSS file" (#84)
GTK-Doc 1.30 (May 08 2019)
===============
GTK-Doc is now using python-pygments to do the syntax highlighing. It is not
depending on highligh or source-highligh anymore.
This version ships with a new expermiental gtkdoc-mkhtml2 toolchain replacing
gktdoc-mkhtml+gtkdoc-fixxref.
GTK-Doc 1.29 (Aug 28 2018)
===============
GTK-Doc now requires python-3.X. It does not requires python-six anymore.
Note that this is a nonmaintainer release and that tests are known to be broken.
Changes
o 674163 : – html-build.stamp rule broken for out-of-tree builds with absolute paths
o 795744 : Too much escaped string - " & lt;child > " in description of " GtkOverlay as GtkBuildable " section
o 796011 : Crash in ScanDirectory caused by overlooked use of renamed `dir` variable
o 796012 : Several places in rebase.py incorrectly use `match.groups(1)` instead of `match.group(1)`, one causes a crash
Contributors
Adam Williamson
Anders Jonsson
Daniel Mustieles
David D
LRN
Marek Cernocky
Martin Blanchard
Michael Biebl
Michael Catanzaro
Rafael Fontenelle
Sebastian Geiger
Stefan Sauer
Tim Sabsch
GTK-Doc 1.28 (Mar 24 2018)
==============
Bug fixes.
o 791928 : gtk-doc doesn't understand 'stability: Obsolete'
o 792148 : cmake: Installed GtkDocConfig.cmake has incorrect bindir path
o 792661 : use pygments to do syntax highlighing
o 793599 : Please run testsuite with V=0
o 794051 : rebase: fix on-line location extraction from devhelp files
o 794182 : private_header regex is broken
GTK-Doc 1.27 (Dec 07 2017)
==============
Finetune the python port.
Changes
o 773879 : scangobj: Do not generate unused parameters
o 786174 : Several test failures on Arch Linux
o 787495 : gtkdoc-fixxref crashes when running vim for syntax highlighting
o 787768 : Aborts when glib2.0-dev is not installed
o 787862 : Always open files in text mode and always use utf-8
o 788473 : fixxref crashes if a .devhelp2.gz file is found
o 789531 : Don't depend on the system shell
o 790022 : mkdb: Add support for (not optional) annotation
o 791131 : gtk-doc and python3: fixxref failures
The current default of vim (if found) is broken, but the upstream patch to
fix it doesn't work in isolation, and updating to the latest release breaks
other things, so this is currently the least-worst option to unbreak other
packages like poppler-glib unfortunately.
Really this should be a package option and set explicitly rather than
relying on finding random binaries on the system. Bump PKGREVISION.
works fine for me with 2.0.2 but with 2.0.4 I see
GEN el/
Error: Could not merge translations:
'NoneType' object is not subscriptable
Makefile:522: recipe for target 'cs/cs.stamp' failed
GTK-Doc 1.26 (Aug 11 2017)
==============
Remove tmpl support (gtkdoc-mktmpl). Port all tools from bash/perl to python.
Changes
o 773879 : - scangobj: Do not generate unused parameters
o 780789 : Convert gtkdoc-scan from Perl to Python
o 752126 : Add support for inline program documentation
o 753052 : _() causes element a: validity error : ID idx already defined
o 758137 : GtkLabel and GtkShortcutsShortcut notes on escaping character entities don't render properly
o 764407 : Broken links to structs in function definitions
o 764543 : /usr/bin/gtkdoc-mkpdf always exits with an error
o 768675 : make check fails on master
o 769125 : gtkdoc-mkhtml/pdf fails on spaces in search path
o 769341 : gtkdoc-mkdb line 3966 triggers " Negative repeat count does nothing " warnings
o 771255 : " Symbol name not found at the start of comment block " warning with " attributes " annotation.
o 773151 : configure: Lower perl dependency to 5.16.0
o 774168 : gobject introspection annotations and gtk-doc parser do not agree
o 774812 : Error messages from xsltproc are hidden by gtkdoc-mkhtml
o 778144 : Allow disabling introspection for ancillary property mechanisms
o 779566 : Replace shell executables with Python
GTK-Doc 1.25 (Mar 21 2016)
==============
Changes
o 763465 : - released version of gtk-doc no longer understands cross-reference data in gtk+
o 742404 : unify index.sgml and *.devhelp2 + change gtkdoc-fixxref to use *.devhelp2
o 743182 : Automatically support PACKAGE variables as XML entities
o 744061 : Skip standard g_iface, parent_instance and parent_class struct members
o 751479 : help: Document the Stability tag for documentation comments
o 751777 : gtk-doc -sections.txt file documentation is a bit confusing
o 751783 : Creating master xml document documentation is a bit lacking
o 751906 : help: Fix incorrect example syntax for embedded images
o 752795 : documentation is not rebuilt when only content of doc comments change
o 753145 : gtkdoc-mkhtml fails on spaces in file names
o 753348 : gtkdocize does not handle -flat flavours
o 756297 : Add CMake module
o 756368 : gtkdocize mistakenly parses options from comments in configure.ac
o 756519 : `make check' fails - Sequence (?R...) not recognized in regex
o 756684 : Support (not nullable) annotation
o 756998 : Support |[ <!-- language= " plain " --> ]|
o 758996 : gtkdoc-mkdb: ensure macros appear in the correct section
o 759017 : autogenerated ids in return and parameter blocks
GTK-Doc 1.24 (May 29 2015)
============
This is another quick bugfix release for a regression, see bug #749591
Changes
o 749591 : gtk-doc 1.23 no longer includes xml namespace in .devhelp2 files
o 749706 : .gitignore files should not be under version control
o 749816 : Support syntax highlighting of different languages (patch included)
o 749901 : Strip common indent when highlighting with vim
GTK-Doc 1.23 (May 17 2015)
============
This is a quick bugfix release for a regression, see bug #749142.
Changes
o 749142 : Can't build totem-pl-parser from master using gtk-doc 1.22
o 749210 : mkman: Use full URL to refer to the docbook manpages stylesheet
GTK-Doc 1.22 (May 07 2015)
============
Important notice - starting with the next release these long deprecated
features will be removed - you'll now see a warning if you actually use these
features. Please write to gtk-doc-list@gnome.org and tell us your concerns:
o gtkdoc-mktmpl - please move all the comments into the sources.
o generating html via sgml tools (jade/openjade), using xsltproc and
docbook-xslt is pretty common and preferred since version 1.6
Changes
o 727778 : - gtk-doc doesn't understand annotations for GList-contained types
o 729911 : Using #TypeName inshort_description makes " - " in HTML index disappear
o 732689 : strange result on a generated html page
o 734689 : " Specific -> General " document title format
o 736073 : Regression: problems with enum constants
o 736725 : Documentation consists mostly of empty space
o 741305 : Scanner issue with enum containing value ='{'
o 741763 : Example Makefile.am improvements
o 741941 : Last function argument missing in docs (possibly due to macro in code)
o 743879 : special case G_DECLARE_*_TYPE
o 743967 : Make build results reproducible
o 744075 : Missing struct members if forward declared in another header
o 744368 : gtkdoc-depscan doesn't handle unicode in .devhelp2 files correctly
o 746118 : gtkdoc-scan: fix regex for get_type() functions
o 746120 : Expand annotation recognition on symbol lines
o 746121 : gtkdoc-mkdb: don't warn on 'deprecated entities'
o 747207 : Typos in documentation
o 747298 : Test still tries to check gtkdoc-scanobj
o 748456 : xsl: Enable ToC generation on empty <toc/> elements
Problems found locating distfiles:
Package cabocha: missing distfile cabocha-0.68.tar.bz2
Package convertlit: missing distfile clit18src.zip
Package php-enchant: missing distfile php-enchant/enchant-1.1.0.tgz
Otherwise, existing SHA1 digests verified and found to be the same on
the machine holding the existing distfiles (morden). All existing
SHA1 digests retained for now as an audit trail.
As per warning in 1.20, gtkdoc-scanobj and generating html via
sgml tools (options.mk) have been removed.
Added
# needed together with pkg-config by gtkdoc-depscan at runtime
.include "../../devel/glib2/buildlink3.mk"
to buildlink3.mk
GTK-Doc 1.21 (Jul 17 2014)
============
Important notice - starting with the next release these long deprecated
features will be removed, please write to gtk-doc-list@gnome.org and tell us
your concerns:
o gtkdoc-mktmpl - please move all the comments into the sources.
o generating html via sgml tools (jade/openjade), using xsltproc and
docbook-xslt is pretty common and preferred since version 1.6
Changes
o 170860 : gtk-doc should have definitions for stability
o 644111 : one cannot specify against which libs gtkdoc-fixxref should
resolve links (problematic with multiple versions)
o 657444 : " enum foo { ... } " ; not recognized
o 671519 : Self-test relies on nonportable (GNU enhanced) 'date' command
o 678094 : the word "returns" in a function description can be parsed as
the "Returns:" section
o 722621 : gtk-doc tarball was created with 32bit uid/gid, unusable with
mingw/msys tar
o 724739 : Self-test fail: gtkdoc-mkdb misusing perl datatype
o 725505 : new syntax highlighting for code is weird
o 725663 : configure: non POSIX test usage
o 730658 : Deprecation warning for non-deprecated type GParamFlags
o 730777 : Add support for nullable and optional annotations
Do it for all packages that
* mention perl, or
* have a directory name starting with p5-*, or
* depend on a package starting with p5-
like last time, for 5.18, where this didn't lead to complaints.
Let me know if you have any this time.
Mark as not ready for python-3.x.
GTK-Doc 1.20 (Feb 16 2014)
============
Important notice - starting with the next release these long deprecated
features will be removed, please write to gtk-doc-list@gnome.org and tell us
your concerns:
o gtkdoc-scanobj (only used for gtkobject)
o return values need to be documented using "Returns:". We will remove the
heuristic that turns a paragraph starting with "Returns " into return docs.
o gtkdoc-mktmpl - please move all the comments into the sources.
o generating html via sgml tools (jade/openjade), using xsltproc and
docbook-xslt is pretty common and preferred since version 1.6
Changes
o 605537 : Returns: listed among parameters
o 624001 : Support attribute-based method to deprecate symbols
o 662424 : Class hierarchy about interfaces not generated by default
o 665926 : should not have to document object structures
o 666509 : Specifying --enable-gtk-doc should not be required to build source packages
o 669417 : Duplicate IDs generated for unions registered as boxed types
o 671519 : Self-test relies on nonportable (GNU enhanced) 'date' command
o 692367 : gtkdocize should take a srcdir argument
o 696570 : style updates
o 697940 : Race condition between setup-build.stamp and scan-build.stamp
o 701259 : /bin/bash: -chmod: command not found
o 701638 : Support automake parallel test harness (fix error with GTKDOC_CHECK)
o 706404 : Minor bug in gtkdoc-mkdb
o 706438 : Empty lines added at the beginning and at the end of a programlisting
o 707426 : master is broken in picking up flavour from configure.ac
o 707717 : Support " Deprecated: X.Y "
o 708268 : New *-insensitive.png files are not distributes
o 710478 : gtkdoc-mkdb: Don't complain about annotations with hyphen
o 711111 : gtkdoc-mkdb: sort entries in the glossary
o 711598 : gtkdoc-scan doesn't ignore decorators containing parentheses
o 719644 : docs: make yelp usage conditional in manual
o 719645 : configure: emit message when looking for yelp
o 720061 : make: create subdirectories of the content_files to the builddir
o 721228 : configure: search for xml catalog in XDG_DATA_DIRS
o 722479 : cp -u is not portable
o 723118 : Mark |[ blocks as CDATA
o 723288 : Fix MarkDown support
o 723417 : New MarkDown parser
o 723696 : Add support for blockquote
o 723812 : Add support for reference links
o 723913 : List in markdown: < p > inside the last element of a < ul > list
o 723991 : Improve the display of the synopsis
o 724002 : gtkdoc-scan: Fix use of uninitialised value in trace logging
Contributors
Alban Browaeys
Alexander Kanavin
Carlos Garcia Campos
Christian Kirbach
Daniel Mustieles
David King
David Nečas
Dieter Verfaillie
Dimitris Spingos
Hib Eris
Matthias Clasen
Philip Chimento
Philip Withnall
Rafael Ferreira
Rico Tzschichholz
Ryan Lortie
Sebastian Rasmussen
Sébastien Wilmet
Stefan Sauer
Stef Walter
William Jon McCann
Zbigniew Jędrzejewski-Szmek
a) refer 'perl' in their Makefile, or
b) have a directory name of p5-*, or
c) have any dependency on any p5-* package
Like last time, where this caused no complaints.
GTK-Doc 1.17 (Feb 16 2011)
============
Changes
o 127049 : building reference documentation fails when builddir != srcdir
o 640241 : non-srcdir builds busted
Contributors
Daniel Mustieles
Javier Jardón
Stefan Kost
GTK-Doc 1.16 (Jan 14 2011)
============
o gtkdoc-check can do more checks, one might need to update Makefile.am from
the examples/Makefile.am
Changes
o 625776 : serialise doubles and floats always with a decimal dot
o 627269 : link to signalflags docs from signal descriptions
o 467488 : GTK+ man pages request
o 481811 : Inline function bodies are confused with declarations
o 501107 : EXTRA_DIST automake warnings
o 512565 : add GTK_DOC_IGNORE
o 518427 : documentation best pratices needed
o 597937 : Function pointers as parameters to other functions are parsed improperly
o 612028 : gtkdoc-fixxref should call /usr/bin/vim -n -e -u NONE -T xterm
o 617478 : Tooltip is a nuisance
o 618379 : Navigation is hiding anchors title
o 620249 : invalid xml for object_index with (n_objects % 3) == 0
o 621931 : support GType and GVariant types
o 622971 : List of typos in the GTK-doc manual
o 623777 : G_TYPE_STRV in signals generate wrong docs
o 623968 : gtkdoc-mkdb generates invalid xml from sgml in inline comments
o 624199 : parser picks up contents of large macros
o 624200 : 'const' confuses the parser
o 627223 : gtkdoc-fixxref vim highlight fails on xhtml suffix
o 627920 : `make check` rule to list xml files missing from DOC_MAIN_SGML_FILE
o 628611 : gtk-doc > = 1.13 creates automagic dependencies on syntax highlighters
o 628794 : Issue in gtkdoc-mkman.in
o 630288 : Fix 'scope notified' annotation
o 631336 : remove lists of gtk+ signal args in gtkdoc-scanobj and -scangobj
o 632587 : gtkdoc-scanner fails to identify (closure) annotation
o 638330 : const in parameter list is ignored
o 638831 : Support GTK+ 3 cell properties
Contributors
Bruno Brouard
Christian Persch
Claude Paroz
Gilles Dartiguelongue
Javier Jardón
Jorge González
Maarten Bosmans
Mario Blättermann
Matej Urbančič
Matthias Clasen
Pablo Castellano
P. F. Chimento
Philip Withnall
Rodrigo Aliste
Simón Pena
Stefan Kost
Tim-Philipp Müller
Vasilis Tsivikis
GTK-Doc 1.13 (Dec 18 2009)
============
o 604891 : gtk-doc tarball does not build
Contributors
Stefan Kost
GTK-Doc 1.12 (Dec 18 2009)
============
Changes
o 591450 : Build related fixes
o 466535 : generate documentation as pdf
o 502191 : acronym support
o 532395 : inline function parsing problems (e.g. in glib api docs)
o 536928 : have syntax highlghted and xrefs source code samples
o 562064 : index generation trouble
o 562310 : glib 2.18.3: /bin/sh: line 1: gtkdoc-rebase: command not found
o 562655 : doesn't produce deprecation note for signals
o 565126 : linking to struct members
o 565835 : Three spelling errors in gtk-doc-manual
o 566911 : add support for --help and --version to remaining tools
o 567132 : Take FOO_GET_INTERFACE as standard
o 568702 : gtkdoc-mkhtml no longer works when symlinked
o 568706 : gtkdoc-scan: use CamelCase id for interfaces
o 568708 : gtkdoc-scan should try not to scan files twice
o 568714 : Perl errors when syntax highlighting is not available
o 568732 : missing long descriptions undetected
o 568734 : configure check for gtk-doc prints that gtk-doc cannot be built
o 569339 : abbreviation are not expanded at the start of text
o 572396 : Fix to use shave + gtk-doc + libtool 1.x
o 572612 : Mistakenly substitute -1 with G_MAXULONG in x86_64
o 572967 : use g_strerror
o 574654 : --ignore-decorators does not ignore trailing stuff
o 575574 : Be more friendly for files with a space in their name
o 575623 : Update FSF address
o 575711 : < table > element mismatch in highlighted code
o 576313 : implicit declarations in testsuite ?
o 577059 : Gnome-doc support can't be disabled
o 577774 : Test suite run even when built with --disable-gtk-doc
o 580206 : gcc warnings in < module > -scan.c
o 580300 : gtkdoc-scan picks up _get_type functions it should not
o 580622 : xml dir is both part of distclean and dist rules
o 581237 : gtk-doc uses wrong gtkdoc-check in " make check " phase
o 584952 : " uninitialized value in concatenation " gtkdoc-mkdb line 938
o 587103 : return values of function-like macros
o 587196 : Typo in a string
o 589426 : Python is a required dependency
o 591789 : master FTBFS with automake 1.11
o 594224 : Please fix manual about inlined SECTION comments (and show warnings when invalid)
o 596730 : Signed vs. unsigned comparison in gtkdoc-scangobj.in causing compile errors
o 596731 : autogen.sh doesn't recognize automake-1.11
o 602026 : Warn if non-existing function gets referenced
o 602518 : Doesn't support " long int " return type
o 604798 : tests/fail.sh and tests/tools.sh.in use bashisms
Contributors
Claude Paroz
Dan Williams
Daniel Mustieles
Daniel Nylander
H. Habighorst
Jannis Pohlmann
Javier Jardón
Jennie Petoumenou
Jorge González
Mario Blättermann
Nicola Fontana
Philip Chimento
Philip Withnall
Simos Xenitellis
Stefan Kost
Sven Herzberg
Shared directories can now be created independently by the pacakges
needing them and will be removed automatically by pkg_delete when empty.
Packages needing empty directories can use the @pkgdir command in PLIST.
Discussed and ok'd in thread starting at
http://mail-index.netbsd.org/tech-pkg/2009/06/30/msg003546.html
