Summary
GTK-Doc is used to document C code. It is typically used to document the public API of libraries, such as the GTK+ and GNOME libraries, but it can also be used to document application code.
Versions
v1.25-r1 :: 0 :: gentoo
- Modified
- License
- GPL-2 FDL-1.1
- Keywords
- alpha amd64 arm arm64 hppa ia64 ppc ppc64 s390 sparc x86 ~amd64-linux ~m68k ~mips ~ppc-macos ~sh ~sparc-solaris ~x64-solaris ~x86-linux ~x86-macos
- USE flags
- debug doc emacs highlight test vim
USE flags
General
- debug
- Enable extra debug codepaths, like asserts and extra output. If you want to get meaningful backtraces see https://wiki.gentoo.org/wiki/Project:Quality_Assurance/Backtraces
- doc
- Add extra documentation (API, Javadoc, etc). It is recommended to enable per package instead of globally
- emacs
- Add support for GNU Emacs
- highlight
- Enable source code highlighting
- test
- Enable dependencies and/or preparations necessary to run tests (usually controlled by FEATURES=test but can be toggled independently)
- vim
- Enable source code highlighting through app-editors/vim
python_single_target
- python2_7
- Build for Python 2.7 only
python_targets
- python2_7
- Build with Python 2.7
Dependencies
app-arch / xz-utils : utils for managing LZMA compressed files
app-editors / emacs : The extensible, customizable, self-documenting real-time display editor
app-editors / gvim : GUI version of the Vim text editor
app-editors / vim : Vim, an improved vi-style text editor
app-portage / elt-patches : Collection of patches for libtool.eclass
app-text / docbook-dsssl-stylesheets : DSSSL Stylesheets for DocBook
app-text / docbook-sgml-dtd : Docbook SGML DTD 4.5
app-text / docbook-xml-dtd : Docbook DTD for XML
app-text / docbook-xsl-stylesheets : XSL Stylesheets for Docbook
dev-lang / perl : Larry Wall's Practical Extraction and Report Language
dev-lang / python : An interpreted, interactive, object-oriented programming language
dev-lang / python-exec : Python script wrapper
dev-libs / glib : The GLib library of C routines
dev-libs / libxml2 : XML C parser and toolkit
dev-libs / libxslt : XSLT libraries and tools
dev-util / desktop-file-utils : Command line utilities to work with desktop menu entries
dev-util / gtk-doc-am : Automake files from gtk-doc
dev-util / itstool : Translation tool for XML documents that uses gettext files and ITS rules
dev-util / source-highlight : Generate highlighted source code as an (x)html document
sys-devel / bc : Handy console-based calculator utility
virtual / pkgconfig : Virtual for the pkg-config implementation
x11-misc / shared-mime-info : The Shared MIME-info Database specification
Runtime Dependencies
app-editors / emacs : The extensible, customizable, self-documenting real-time display editor
app-editors / gvim : GUI version of the Vim text editor
app-editors / vim : Vim, an improved vi-style text editor
app-text / docbook-dsssl-stylesheets : DSSSL Stylesheets for DocBook
app-text / docbook-sgml-dtd : Docbook SGML DTD 4.5
app-text / docbook-xml-dtd : Docbook DTD for XML
app-text / docbook-xsl-stylesheets : XSL Stylesheets for Docbook
dev-lang / perl : Larry Wall's Practical Extraction and Report Language
dev-lang / python : An interpreted, interactive, object-oriented programming language
dev-lang / python-exec : Python script wrapper
dev-libs / glib : The GLib library of C routines
dev-libs / libxml2 : XML C parser and toolkit
dev-libs / libxslt : XSLT libraries and tools
dev-util / source-highlight : Generate highlighted source code as an (x)html document
Depending packages
app-editors / gedit : A text editor for the GNOME desktop
app-editors / pluma : Pluma text editor for the MATE desktop
app-i18n / enca : Detect and convert encoding of text files
app-misc / geoclue : A location information D-Bus service
app-text / atril : Atril document viewer for MATE
app-text / libgxps : Library for handling and rendering XPS documents
app-text / liblangtag : An interface library to access tags for identifying languages
dev-libs / appstream-glib : Provides GObjects and helper methods to read and write AppStream metadata
dev-libs / eekboard : An easy to use virtual keyboard toolkit
dev-libs / gom : GObject to SQLite object mapper library
dev-libs / json-glib : Library providing GLib serialization and deserialization for the JSON format
dev-libs / libbytesize : Tiny library providing a C "class" for working with arbitrary big sizes in bytes
dev-libs / libmateweather : MATE library to access weather information from online services
dev-libs / libmirage : CD and DVD image access library
dev-libs / libxmlb : Library to help create and query binary XML blobs
dev-util / devhelp : An API documentation browser for GNOME
dev-util / ostree : Operating system and container binary deployment and upgrades
gnome-extra / cinnamon : A fork of GNOME Shell with layout similar to GNOME 2
gnome-extra / evolution-data-server : Evolution groupware backend
gnome-extra / gnome-software : Gnome install & update software
gnome-extra / nemo : A file manager for Cinnamon, forked from Nautilus
mail-client / evolution : Integrated mail, addressbook and calendaring functionality
mate-base / caja : Caja file manager for the MATE desktop
mate-base / mate-desktop : Libraries for the MATE desktop that are not part of the UI
mate-base / mate-panel : The MATE panel
mate-extra / caja-extensions : Several Caja extensions
mate-extra / mate-polkit : A MATE specific DBUS service that is used to bring up authentication dialogs
mate-extra / mate-utils : Utilities for the MATE desktop
media-gfx / eom : The MATE image viewer
media-gfx / gimp : GNU Image Manipulation Program
media-libs / clutter : Clutter is a library for creating graphical user interfaces
media-libs / libinsane : Crossplatform access to image scanners
media-libs / libiptcdata : library for manipulating the International Press Telecommunications Council (IPTC) metadata
media-libs / libmatemixer : Mixer library for MATE Desktop
media-libs / phat : PHAT is a collection of GTK+ widgets geared toward pro-audio apps
media-sound / denemo : A music notation editor
media-sound / playerctl : A CLI utility to control media players over MPRIS
net-libs / libmbim : Mobile Broadband Interface Model (MBIM) modem protocol helper library
net-libs / libqmi : Qualcomm MSM (Mobile Station Modem) Interface (QMI) modem protocol helper library
net-libs / webkit-gtk : Open source web browser engine
sci-geosciences / geocode-glib : GLib helper library for geocoding services
sci-libs / gts : GNU Triangulated Surface Library
sci-visualization / gwyddion : Framework for Scanning Mode Microscopy data analysis
sys-apps / kmod : library and tools for managing linux kernel modules
sys-apps / kmscon : KMS/DRM based virtual Console Emulator
sys-auth / fprintd : D-Bus service to access fingerprint readers
sys-auth / libfprint : library to add support for consumer fingerprint readers
sys-power / upower : D-Bus abstraction for enumerating power devices, querying history and statistics
x11-apps / igt-gpu-tools : Intel GPU userland tools
x11-libs / colord-gtk : GTK support library for colord
x11-libs / gdk-pixbuf : Image loading library for GTK+
x11-libs / gtk+ : Gimp ToolKit +
x11-libs / libfm : A library for file management
x11-libs / libtinynotify : A lightweight implementation of Desktop Notification Spec
x11-libs / libtinynotify-cli : Common CLI routines for tinynotify-send & sw-notify-send
x11-libs / libtinynotify-systemwide : A system-wide notifications module for libtinynotify
x11-libs / scw : A GTK+ widget set specifically designed for chat programs
x11-libs / xapps : Cross-desktop libraries and common resources
x11-misc / sw-notify-send : A system-wide variant of tinynotify-send
x11-misc / tinynotify-send : A notification sending utility (using libtinynotify)
x11-wm / muffin : Compositing window manager forked from Mutter for use with Cinnamon
Bugs
- 298560
- dev-util/gtk-doc: uses system's libraries to link scanner
- 404495
- dev-util/gtk-doc: automagic build-time detection of pdf generator
- 623422
- dev-util/gtk-doc-1.25-r1 gtkdoc-scan has loud warnings about unescaped "{", will be fatal in Perl 5.30 ( Unescaped left brace in regex is deprecated )
- 646850
- dev-util/gtk-doc fails to generate pdfs, thus whole builds may fail
- 683900
- dev-util/gtk-doc-1.32 version bump
- 685656
- dev-util/gtk-doc-1.25-r1 doesn't install all html doc images for x11-libs/gtk+-3.24.8
Change logs
- Repository mirror & CI · gentoo
Merge updates from master - Ulrich Müller · gentoo
dev-util/gtk-doc: Update virtual/emacs dependency.
The virtual is deprecated, depend on app-editors/emacs instead. Package-Manager: Portage-2.3.82, Repoman-2.3.20 Signed-off-by: Ulrich Müller <ulm@gentoo.org> - Repository mirror & CI · gentoo
Merge updates from master - Matt Turner · gentoo
dev-util/gtk-doc: Restrict tests if USE=-test
Signed-off-by: Matt Turner <mattst88@gentoo.org> - Repository mirror & CI · gentoo
Merge updates from master - Matt Turner · gentoo
dev-util/gtk-doc: Add missing test dependency
Closes: https://bugs.gentoo.org/623420 Signed-off-by: Matt Turner <mattst88@gentoo.org> - Repository mirror & CI · gentoo
Merge updates from master - Michał Górny · gentoo
dev-util: Remove *-fbsd KEYWORDS
Signed-off-by: Michał Górny <mgorny@gentoo.org> - Repository mirror & CI · gentoo
Merge updates from master - Mart Raudsepp · gentoo
dev-util/gtk-doc: restrict parallel running of tests
Tests fail for me with parallel jobs, as tester-docs.xml seems shared across separate tests and is generated and removed multiple times, apparently. Signed-off-by: Mart Raudsepp <leio@gentoo.org> Package-Manager: Portage-2.3.52, Repoman-2.3.11 - Mart Raudsepp · gentoo
dev-util/gtk-doc: remove wrong yelp-tools build depend
Only itstool is needed to build, so pull only that, not the full yelp-tools stack. Signed-off-by: Mart Raudsepp <leio@gentoo.org> Package-Manager: Portage-2.3.52, Repoman-2.3.11 - Repository mirror & CI · gentoo
Merge updates from master - Zac Medico · gentoo
dev-util/gtk-doc: mkpdf: fix exitcode (bug 646850)
Fix gtk-doc exitcode. The problem can be demonstrated by building gtk-doc with dblatex installed, and then building evince with EXTRA_ECONF="--enable-gtk-doc --enable-gtk-doc-pdf". Bug: https://bugs.gentoo.org/646850 See: https://github.com/GNOME/gtk-doc/commit/1baf9a63bdf3283832be06bce151835922909436 Package-Manager: Portage-2.3.48, Repoman-2.3.10 - Repository mirror & CI · gentoo
Merge updates from master - Mikle Kolyada · gentoo
dev-util/gtk-doc: mark s390 stable
Package-Manager: Portage-2.3.40, Repoman-2.3.9 - Repository mirror & CI · gentoo
Merge updates from master - Mart Raudsepp · gentoo
dev-util/gtk-doc: arm64 stable
Package-Manager: Portage-2.3.28, Repoman-2.3.9 - Michał Górny · gentoo
*/*: Remove sparc-fbsd keywords - Gilles Dartiguelongue · gentoo
dev-util/gtk-doc: update homepage
Due to default redirection to SSL. Package-Manager: Portage-2.3.8, Repoman-2.3.3 - Robin H. Johnson · gentoo
Drop $Id$ per council decision in bug #611234.
Signed-off-by: Robin H. Johnson <robbat2@gentoo.org> - Fabian Groffen · gentoo
dev-util/gtk-doc: dropped ~ia64-hpux ~x64-freebsd ~x86-freebsd ~x86-interix
Package-Manager: portage-2.3.3 - T. Malfatti · gentoo
media-libs/portaudio: Version bump - Mart Raudsepp · gentoo
dev-util/gtk-doc: Remove old
Package-Manager: Portage-2.3.3, Repoman-2.3.1 - Agostino Sarubbo · gentoo
dev-util/gtk-doc: ppc64 stable wrt bug #587010
Package-Manager: portage-2.3.0 RepoMan-Options: --include-arches="ppc64" Signed-off-by: Agostino Sarubbo <ago@gentoo.org> - Agostino Sarubbo · gentoo
dev-util/gtk-doc: ia64 stable wrt bug #587010
Package-Manager: portage-2.3.0 RepoMan-Options: --include-arches="ia64" Signed-off-by: Agostino Sarubbo <ago@gentoo.org> - Agostino Sarubbo · gentoo
dev-util/gtk-doc: sparc stable wrt bug #587010
Package-Manager: portage-2.3.0 RepoMan-Options: --include-arches="sparc" Signed-off-by: Agostino Sarubbo <ago@gentoo.org> - Agostino Sarubbo · gentoo
dev-util/gtk-doc: ppc stable wrt bug #587010
Package-Manager: portage-2.3.0 RepoMan-Options: --include-arches="ppc" Signed-off-by: Agostino Sarubbo <ago@gentoo.org> - Markus Meier · gentoo
dev-util/gtk-doc: arm stable, bug #587010
Package-Manager: portage-2.3.2 RepoMan-Options: --include-arches="arm" - Pacho Ramos · gentoo
dev-util/gtk-doc: Drop old
Package-Manager: portage-2.3.2 - Jeroen Roovers · gentoo
dev-util/gtk-doc: Stable for HPPA (bug #587010).
Package-Manager: portage-2.3.1 RepoMan-Options: --ignore-arches - Pacho Ramos · gentoo
dev-util/gtk-doc: x86 stable, bug 587010
Package-Manager: portage-2.3.0 RepoMan-Options: --include-arches="x86" - Pacho Ramos · gentoo
dev-util/gtk-doc: amd64 stable, bug 587010
Package-Manager: portage-2.3.0 RepoMan-Options: --include-arches="amd64" - Tobias Klausmann · gentoo
dev-util/gtk-doc-1.25-r1: add alpha keyword
Gentoo-Bug: 587010 - Gilles Dartiguelongue · gentoo
dev-util/gtk-doc: version bump to 1.25-r1
Switch to EAPI=6. Fix dependencies per configure. USE=debug is a "true" yes/no option, no the kind from Gnome. Package-Manager: portage-2.3.0 - Jeroen Roovers · gentoo
dev-util/gtk-doc: Stable for HPPA PPC64 (bug #584468).
Package-Manager: portage-2.3.0 RepoMan-Options: --ignore-arches - Pacho Ramos · gentoo
dev-util/gtk-doc: ppc stable, bug 584468
Package-Manager: portage-2.3.0 RepoMan-Options: --include-arches="ppc" - Pacho Ramos · gentoo
dev-util/gtk-doc: x86 stable, bug 584468
Package-Manager: portage-2.3.0_rc1 RepoMan-Options: --include-arches="x86" - Pacho Ramos · gentoo
dev-util/gtk-doc: amd64 stable, bug 584468
Package-Manager: portage-2.3.0_rc1 RepoMan-Options: --include-arches="amd64" - Markus Meier · gentoo
dev-util/gtk-doc: arm stable, bug #584468
Package-Manager: portage-2.3.0_rc1 RepoMan-Options: --include-arches="arm" - Tobias Klausmann · gentoo
dev-util/gtk-doc-1.25-r0: add alpha keyword
Gentoo-Bug: 584468 Package-Manager: portage-2.3.0_rc1 - Dennis Lamm · gentoo
dev-util/gtk-doc: Version bump - Robin H. Johnson · gentoo
proj/gentoo: Initial commit
This commit represents a new era for Gentoo: Storing the gentoo-x86 tree in Git, as converted from CVS. This commit is the start of the NEW history. Any historical data is intended to be grafted onto this point. Creation process: 1. Take final CVS checkout snapshot 2. Remove ALL ChangeLog* files 3. Transform all Manifests to thin 4. Remove empty Manifests 5. Convert all stale $Header$/$Id$ CVS keywords to non-expanded Git $Id$ 5.1. Do not touch files with -kb/-ko keyword flags. Signed-off-by: Robin H. Johnson <robbat2@gentoo.org> X-Thanks: Alec Warner <antarus@gentoo.org> - did the GSoC 2006 migration tests X-Thanks: Robin H. Johnson <robbat2@gentoo.org> - infra guy, herding this project X-Thanks: Nguyen Thai Ngoc Duy <pclouds@gentoo.org> - Former Gentoo developer, wrote Git features for the migration X-Thanks: Brian Harring <ferringb@gentoo.org> - wrote much python to improve cvs2svn X-Thanks: Rich Freeman <rich0@gentoo.org> - validation scripts X-Thanks: Patrick Lauer <patrick@gentoo.org> - Gentoo dev, running new 2014 work in migration X-Thanks: Michał Górny <mgorny@gentoo.org> - scripts, QA, nagging X-Thanks: All of other Gentoo developers - many ideas and lots of paint on the bikeshed