pkgsrc/textproc/gtk-doc/Makefile

36 lines
1.1 KiB
Makefile
Raw Normal View History

# $NetBSD: Makefile,v 1.30 2008/04/24 21:32:01 wiz Exp $
#
DISTNAME= gtk-doc-1.10
CATEGORIES= textproc
MASTER_SITES= ${MASTER_SITE_GNOME:=sources/gtk-doc/1.10/}
EXTRACT_SUFX= .tar.bz2
MAINTAINER= pkgsrc-users@NetBSD.org
HOMEPAGE= http://www.gtk.org/gtk-doc/
COMMENT= Tools for authors of the GTK+ reference documentation
DEPENDS+= docbook-xml>=4.4nb1:../../textproc/docbook-xml
DEPENDS+= docbook-xsl>=1.68.1:../../textproc/docbook-xsl
GNU_CONFIGURE= YES
PKGCONFIG_OVERRIDE= gtk-doc.pc.in
CONFIGURE_ARGS+= --with-xml-catalog=${XML_DEFAULT_CATALOG:Q}
USE_DIRS+= gnome2-1.6
USE_TOOLS+= perl:run
update to 1.8 pkgsrc change: make SGML output optional, off per default, which saves the heavyweight dependency on jade other changes: o Made it easier to include example code in the source code comment blocks. "|[ ... ]|" can be used to delineate example code (it just gets converted to "<informalexample><programlisting>"), and most of the text in example code is left as it is. The only thing that is still expanded is '#' to allow links to a symbol's documentation, e.g. '#GtkWidget'. o Made the field widths wider for the HTML output, so it looks a bit nicer. o Added a '--rebuild-sections' option to gtkdoc-scan to automatically rebuild the MODULE-sections.txt file. This only works if all the header files are organized neatly and functions don't need rearranging in the docs. o Added a '--rebuild-types' option to gtkdoc-scan to automatically rebuild the MODULE.types file, so you don't need to add new types manually. o Leave CDATA sections as they are, in the extra XML content files and within source code comment blocks. o Allow the section id and #include's to be set within the "SECTION:" comment block, using "@Section_ID:xxx" and "@Include:". o Added "--default-includes" option to specify the default #include's (for people who are using --rebuild-sections and so can't specify it in MODULE-sections.txt). o Added a '--query-child-properties' argument to help document child properties of arbitrary GObjects (used by things like canvas widgets). o Fixed documentation of signals of interfaces.
2007-04-10 19:38:27 +02:00
PKG_OPTIONS_VAR= PKG_OPTIONS.gtkdoc
PKG_SUPPORTED_OPTIONS= sgml
.include "../../mk/bsd.options.mk"
Update to 1.2: 2004-02-16 Damon Chaplin <damon@gnome.org> * Released 1.2. 2004-02-16 Damon Chaplin <damon@gnome.org> * gtk-doc.cat.in: removed public ID for gtk-doc.dtd, since we don't use it any more. Sat Feb 14 02:14:27 2004 Matthias Clasen <maclas@gmx.de> * gtk-doc.m4: Avoid unnecessary checks if gtk-doc is disabled. (#134221, Julio M. Merino Vidal) Sat Feb 14 02:03:01 2004 Matthias Clasen <maclas@gmx.de> * gtk-doc.make: Don't create unneeded empty directories. (#134319, Julio M. Merino Vidal) Sat Feb 14 01:37:38 2004 Matthias Clasen <maclas@gmx.de> * gtk-doc.make: Add an empty all-local target to make it work with non-GNU make. (#134343, Julio M. Merino Vidal) Wed Jan 28 00:52:00 2004 Matthias Clasen <maclas@gmx.de> * gtkdoc-mkdb.in (OutputObjectList): Avoid emitting invalid docbook markup if there are no objects. Partial fix for #132661. Sun Jan 25 22:01:15 2004 Matthias Clasen <maclas@gmx.de> * gtkdoc-mkdb.in: Accept both the old and the new XInclude namespace. (#131675, Edd Dumbill) 2004-01-23 Thomas Vander Stichele <thomas at apestaart dot org> * gtkdoc-mkhtml.in: exit when tools return non-zero so errors can be caught. Thu Jan 15 23:06:10 2004 Matthias Clasen <maclas@gmx.de> * gtk-doc.xsl: Set the chunk.fast parameter, to gain some speed. Thu Jan 15 23:05:23 2004 Matthias Clasen <maclas@gmx.de> * gtkdoc-fixxref.in: Make it work again without explicit --module. Sat Dec 27 01:36:08 2003 Matthias Clasen <maclas@gmx.de> * gtkdoc-scangobj.in: * gtkdoc-mktmpl.in: * gtkdoc-scan.in: * gtkdoc-fixxref.in: Add --help. (#126915) Sat Dec 27 00:43:42 2003 Matthias Clasen <maclas@gmx.de> * gtkdoc-mkdb.in (ParseEnumDeclaration): * gtkdoc-mktmpl.in (ParseEnumDeclaration): Support a trailing , in enum declarations. These are a GNU C extension, but also blessed by C99. (#129949, Thomas Vander Stichele) Sun Nov 16 00:29:03 2003 Matthias Clasen <maclas@gmx.de> * gtkdoc-scangobj.in: Don't use g_strdown(). (#127028, David Schleef) Sun Nov 16 00:26:05 2003 Matthias Clasen <maclas@gmx.de> * gtkdoc-scangobj.in: If compiled against GLib >= 2.3.0, look for properties on interfaces. (#127068, James M. Cape) 2003-11-03 Dan Winship <danw@ximian.com> * gtkdoc-scangobj.in: Clean up $MODULE-scan.o even when using libtool * gtkdoc-scanobj.in: Likewise * gtk-doc.make (CLEANFILES): Remove $(MODULE)-scan.o from here (clean-local): rm -rf .libs Wed Oct 8 01:21:54 2003 Matthias Clasen <maclas@gmx.de> * gtkdoc-scan.in (ScanHeader): Make gtkdoc-scan grok typedef struct { } foo; in addition to the more baroque typedef struct _foo foo; struct _foo { }; (#116807, Malcolm Tredinnick) Wed Oct 8 01:21:35 2003 Matthias Clasen <maclas@gmx.de> * gtkdoc-mkdb.in (OutputParamDescriptions): Remove a pointless warning. 2003-10-01 Matthias Clasen <maclas@gmx.de> Make signals and properties end up in the right template file (#116569, Owen Taylor): * gtkdoc-mktmpl.in (OutputSignalTemplates): (OutputArgTemplates): Return a string rather than directly writing to OUTPUT. (OutputTemplateFile): Don't interpret $title as the name of the object to print signal and property templates for. (UpdateTemplates): Collect signal and property templates for all objects contained in the section. 2003-08-10 James Henstridge <james@daa.com.au> * acinclude.m4 (JH_PATH_XML_CATALOG): allow caller to specify actions if found or not found. (JH_CHECK_XML_CATALOG): when requiring JH_PATH_XML_CATALOG, don't error out if it is not found. 2003-08-03 Matthias Clasen <maclas@gmx.de> * doc/gnome.txt: Add some hints regarding markup of examples. 2003-07-22 Matthias Clasen <maclas@gmx.de> * configure.in: * gtk-doc.cat: Fix a problem with the previous commit. 2003-07-21 Matthias Clasen <maclas@gmx.de> Applied patches from Sebastian Rittau to add maintainer mode and an SGML catalog. (#117955, #117956) * gtk-doc.cat.in: New catalog file. * configure.in: Added gtk-doc.catalog to output files. * Makefile.am: Install gtk-doc.catalog. * configure.in: Added AM_MAINTAINER_MODE. * autogen.sh: Added --enable-maintainer-mode to configure options. 2003-07-09 Matthias Clasen <maclas@gmx.de> * gtkdoc-mktmpl.in (ParseStructDeclaration): * gtkdoc-mkdb.in (ParseStructDeclaration): Accept volatile struct members, which have just made their appearance in glib. 2003-06-29 Matthias Clasen <maclas@gmx.de> * gtkdoc-mkdb.in (ExpandAbbreviations): When expanding @param, catch the common @param->field and @param.field, to reduce the need for littering the C sources with <literal>foo->bar</literal>. 2003-06-25 Matthias Clasen <maclas@gmx.de> Changes for #115528: * gtkdoc-mkdb.in (OutputSGML): Collect hierarchy, interfaces, implementations, prerequisites and derived interfaces separately. (OutputSGMLFile): Take two more arguments: implementations and derived interfaces. (GetHierarchy): Also put immediate children in the local tree. (GetInterfaces): Split into GetInterfaces and GetImplementations. (GetImplementations): New function to get the implementations of an interface. (GetDerived): New function to get the known derived interfaces of an interface. * gtkdoc-mkdb.in (MakeXRef): Accept a second, optional parameter for the text of the link. (ExpandAbbreviations): Add semantic markup inside the links, so that non-crossreferenced symbols come out properly formatted after link removal. (#61345) 2003-06-15 Matthias Clasen <maclas@gmx.de> Support for a flat index of all symbols. (#92861) To use, put an empty <index/> element in your driver document. * gtkdoc-mkdb.in (MakeIndexterms): New function, emits an indexterm. (OutputMacro, OutputTypedef, OutputStruct, OutputEnum, OutputUnion, OutputVariable, OutputFunction): Use MakeIndexterms. to emit indexterms for symbols. * gtkdoc-mkdb.in (GetSignals): (GetArgs): Emit Since: information for signals and properties. Thu Jun 12 15:55:57 2003 Owen Taylor <otaylor@redhat.com> * gtkdoc-mkhtml.in (declaration): Replace head -1 with -n 1. (Merge change by Elliot Lee from Red Hat package) 2003-06-11 Matthias Clasen <maclas@gmx.de> * doc/gnome.txt: Updates to the documentation of inline comments. 2003-06-03 Matthias Clasen <maclas@gmx.de> * gtk-doc.spec.in: Add a missing Provides: and include the .pc file. (#106568, Joe Pranevich) 2003-05-27 Matthias Clasen <maclas@gmx.de> * gtkdoc-mkdb.in (GetSignals): (GetArgs): Add signals and properties to the statistics. (OutputMissingDocumentation): Emit undocumented signals and properties. (#113645) 2003-04-21 Matthias Clasen <maclas@gmx.de> * tools/docpercentages.pl: Fix autolinkification for undocumented symbols. * doc/style-guide.txt: Typo fix.
2004-02-19 17:49:52 +01:00
update to 1.8 pkgsrc change: make SGML output optional, off per default, which saves the heavyweight dependency on jade other changes: o Made it easier to include example code in the source code comment blocks. "|[ ... ]|" can be used to delineate example code (it just gets converted to "<informalexample><programlisting>"), and most of the text in example code is left as it is. The only thing that is still expanded is '#' to allow links to a symbol's documentation, e.g. '#GtkWidget'. o Made the field widths wider for the HTML output, so it looks a bit nicer. o Added a '--rebuild-sections' option to gtkdoc-scan to automatically rebuild the MODULE-sections.txt file. This only works if all the header files are organized neatly and functions don't need rearranging in the docs. o Added a '--rebuild-types' option to gtkdoc-scan to automatically rebuild the MODULE.types file, so you don't need to add new types manually. o Leave CDATA sections as they are, in the extra XML content files and within source code comment blocks. o Allow the section id and #include's to be set within the "SECTION:" comment block, using "@Section_ID:xxx" and "@Include:". o Added "--default-includes" option to specify the default #include's (for people who are using --rebuild-sections and so can't specify it in MODULE-sections.txt). o Added a '--query-child-properties' argument to help document child properties of arbitrary GObjects (used by things like canvas widgets). o Fixed documentation of signals of interfaces.
2007-04-10 19:38:27 +02:00
.if !empty(PKG_OPTIONS:Msgml)
DEPENDS+= dsssl-docbook-modular-[0-9]*:../../textproc/dsssl-docbook-modular
SGML_CATALOGS= ${PREFIX}/share/sgml/gtk-doc/gtk-doc.cat
2004-04-26 12:34:09 +02:00
.include "../../textproc/jade/buildlink3.mk"
update to 1.8 pkgsrc change: make SGML output optional, off per default, which saves the heavyweight dependency on jade other changes: o Made it easier to include example code in the source code comment blocks. "|[ ... ]|" can be used to delineate example code (it just gets converted to "<informalexample><programlisting>"), and most of the text in example code is left as it is. The only thing that is still expanded is '#' to allow links to a symbol's documentation, e.g. '#GtkWidget'. o Made the field widths wider for the HTML output, so it looks a bit nicer. o Added a '--rebuild-sections' option to gtkdoc-scan to automatically rebuild the MODULE-sections.txt file. This only works if all the header files are organized neatly and functions don't need rearranging in the docs. o Added a '--rebuild-types' option to gtkdoc-scan to automatically rebuild the MODULE.types file, so you don't need to add new types manually. o Leave CDATA sections as they are, in the extra XML content files and within source code comment blocks. o Allow the section id and #include's to be set within the "SECTION:" comment block, using "@Section_ID:xxx" and "@Include:". o Added "--default-includes" option to specify the default #include's (for people who are using --rebuild-sections and so can't specify it in MODULE-sections.txt). o Added a '--query-child-properties' argument to help document child properties of arbitrary GObjects (used by things like canvas widgets). o Fixed documentation of signals of interfaces.
2007-04-10 19:38:27 +02:00
.endif
2004-04-26 12:34:09 +02:00
.include "../../textproc/libxslt/buildlink3.mk"
.include "../../textproc/scrollkeeper/omf.mk"
Update to 1.2: 2004-02-16 Damon Chaplin <damon@gnome.org> * Released 1.2. 2004-02-16 Damon Chaplin <damon@gnome.org> * gtk-doc.cat.in: removed public ID for gtk-doc.dtd, since we don't use it any more. Sat Feb 14 02:14:27 2004 Matthias Clasen <maclas@gmx.de> * gtk-doc.m4: Avoid unnecessary checks if gtk-doc is disabled. (#134221, Julio M. Merino Vidal) Sat Feb 14 02:03:01 2004 Matthias Clasen <maclas@gmx.de> * gtk-doc.make: Don't create unneeded empty directories. (#134319, Julio M. Merino Vidal) Sat Feb 14 01:37:38 2004 Matthias Clasen <maclas@gmx.de> * gtk-doc.make: Add an empty all-local target to make it work with non-GNU make. (#134343, Julio M. Merino Vidal) Wed Jan 28 00:52:00 2004 Matthias Clasen <maclas@gmx.de> * gtkdoc-mkdb.in (OutputObjectList): Avoid emitting invalid docbook markup if there are no objects. Partial fix for #132661. Sun Jan 25 22:01:15 2004 Matthias Clasen <maclas@gmx.de> * gtkdoc-mkdb.in: Accept both the old and the new XInclude namespace. (#131675, Edd Dumbill) 2004-01-23 Thomas Vander Stichele <thomas at apestaart dot org> * gtkdoc-mkhtml.in: exit when tools return non-zero so errors can be caught. Thu Jan 15 23:06:10 2004 Matthias Clasen <maclas@gmx.de> * gtk-doc.xsl: Set the chunk.fast parameter, to gain some speed. Thu Jan 15 23:05:23 2004 Matthias Clasen <maclas@gmx.de> * gtkdoc-fixxref.in: Make it work again without explicit --module. Sat Dec 27 01:36:08 2003 Matthias Clasen <maclas@gmx.de> * gtkdoc-scangobj.in: * gtkdoc-mktmpl.in: * gtkdoc-scan.in: * gtkdoc-fixxref.in: Add --help. (#126915) Sat Dec 27 00:43:42 2003 Matthias Clasen <maclas@gmx.de> * gtkdoc-mkdb.in (ParseEnumDeclaration): * gtkdoc-mktmpl.in (ParseEnumDeclaration): Support a trailing , in enum declarations. These are a GNU C extension, but also blessed by C99. (#129949, Thomas Vander Stichele) Sun Nov 16 00:29:03 2003 Matthias Clasen <maclas@gmx.de> * gtkdoc-scangobj.in: Don't use g_strdown(). (#127028, David Schleef) Sun Nov 16 00:26:05 2003 Matthias Clasen <maclas@gmx.de> * gtkdoc-scangobj.in: If compiled against GLib >= 2.3.0, look for properties on interfaces. (#127068, James M. Cape) 2003-11-03 Dan Winship <danw@ximian.com> * gtkdoc-scangobj.in: Clean up $MODULE-scan.o even when using libtool * gtkdoc-scanobj.in: Likewise * gtk-doc.make (CLEANFILES): Remove $(MODULE)-scan.o from here (clean-local): rm -rf .libs Wed Oct 8 01:21:54 2003 Matthias Clasen <maclas@gmx.de> * gtkdoc-scan.in (ScanHeader): Make gtkdoc-scan grok typedef struct { } foo; in addition to the more baroque typedef struct _foo foo; struct _foo { }; (#116807, Malcolm Tredinnick) Wed Oct 8 01:21:35 2003 Matthias Clasen <maclas@gmx.de> * gtkdoc-mkdb.in (OutputParamDescriptions): Remove a pointless warning. 2003-10-01 Matthias Clasen <maclas@gmx.de> Make signals and properties end up in the right template file (#116569, Owen Taylor): * gtkdoc-mktmpl.in (OutputSignalTemplates): (OutputArgTemplates): Return a string rather than directly writing to OUTPUT. (OutputTemplateFile): Don't interpret $title as the name of the object to print signal and property templates for. (UpdateTemplates): Collect signal and property templates for all objects contained in the section. 2003-08-10 James Henstridge <james@daa.com.au> * acinclude.m4 (JH_PATH_XML_CATALOG): allow caller to specify actions if found or not found. (JH_CHECK_XML_CATALOG): when requiring JH_PATH_XML_CATALOG, don't error out if it is not found. 2003-08-03 Matthias Clasen <maclas@gmx.de> * doc/gnome.txt: Add some hints regarding markup of examples. 2003-07-22 Matthias Clasen <maclas@gmx.de> * configure.in: * gtk-doc.cat: Fix a problem with the previous commit. 2003-07-21 Matthias Clasen <maclas@gmx.de> Applied patches from Sebastian Rittau to add maintainer mode and an SGML catalog. (#117955, #117956) * gtk-doc.cat.in: New catalog file. * configure.in: Added gtk-doc.catalog to output files. * Makefile.am: Install gtk-doc.catalog. * configure.in: Added AM_MAINTAINER_MODE. * autogen.sh: Added --enable-maintainer-mode to configure options. 2003-07-09 Matthias Clasen <maclas@gmx.de> * gtkdoc-mktmpl.in (ParseStructDeclaration): * gtkdoc-mkdb.in (ParseStructDeclaration): Accept volatile struct members, which have just made their appearance in glib. 2003-06-29 Matthias Clasen <maclas@gmx.de> * gtkdoc-mkdb.in (ExpandAbbreviations): When expanding @param, catch the common @param->field and @param.field, to reduce the need for littering the C sources with <literal>foo->bar</literal>. 2003-06-25 Matthias Clasen <maclas@gmx.de> Changes for #115528: * gtkdoc-mkdb.in (OutputSGML): Collect hierarchy, interfaces, implementations, prerequisites and derived interfaces separately. (OutputSGMLFile): Take two more arguments: implementations and derived interfaces. (GetHierarchy): Also put immediate children in the local tree. (GetInterfaces): Split into GetInterfaces and GetImplementations. (GetImplementations): New function to get the implementations of an interface. (GetDerived): New function to get the known derived interfaces of an interface. * gtkdoc-mkdb.in (MakeXRef): Accept a second, optional parameter for the text of the link. (ExpandAbbreviations): Add semantic markup inside the links, so that non-crossreferenced symbols come out properly formatted after link removal. (#61345) 2003-06-15 Matthias Clasen <maclas@gmx.de> Support for a flat index of all symbols. (#92861) To use, put an empty <index/> element in your driver document. * gtkdoc-mkdb.in (MakeIndexterms): New function, emits an indexterm. (OutputMacro, OutputTypedef, OutputStruct, OutputEnum, OutputUnion, OutputVariable, OutputFunction): Use MakeIndexterms. to emit indexterms for symbols. * gtkdoc-mkdb.in (GetSignals): (GetArgs): Emit Since: information for signals and properties. Thu Jun 12 15:55:57 2003 Owen Taylor <otaylor@redhat.com> * gtkdoc-mkhtml.in (declaration): Replace head -1 with -n 1. (Merge change by Elliot Lee from Red Hat package) 2003-06-11 Matthias Clasen <maclas@gmx.de> * doc/gnome.txt: Updates to the documentation of inline comments. 2003-06-03 Matthias Clasen <maclas@gmx.de> * gtk-doc.spec.in: Add a missing Provides: and include the .pc file. (#106568, Joe Pranevich) 2003-05-27 Matthias Clasen <maclas@gmx.de> * gtkdoc-mkdb.in (GetSignals): (GetArgs): Add signals and properties to the statistics. (OutputMissingDocumentation): Emit undocumented signals and properties. (#113645) 2003-04-21 Matthias Clasen <maclas@gmx.de> * tools/docpercentages.pl: Fix autolinkification for undocumented symbols. * doc/style-guide.txt: Typo fix.
2004-02-19 17:49:52 +01:00
.include "../../textproc/xmlcatmgr/catalogs.mk"
.include "../../mk/bsd.pkg.mk"