summaryrefslogtreecommitdiff
path: root/docs/g-ir-scanner.1
Commit message (Collapse)AuthorAgeFilesLines
* docs: include '--c-include' in g-ir-scanner man page. Fixes #275Christoph Reiter2019-03-241-0/+4
|
* Sphinx based user documentationChristoph Reiter2018-06-161-114/+137
| | | | | | | | | | | | | | | | | | | | | | The current output (more or less a straight copy of the wiki) is available here: https://gi.readthedocs.io This contains two changes: * Converts all (not completely outdated) wiki pages to a sphinx based documentation. * Converts the man pages to reST and adds a Makefile for building them using rst2man. So they can be easily exposed in the sphinx docs. Goals: * Have a user focused/compact documentation instead of random wiki pages with various todo/ideas pages. * Take advantage of the gitlab MR workflow by * allowing large documentation changes/refactorings with reviews * allowing to combine features changes with documentation changes in MRs
* Update bug reporting links.Tomasz Miąsko2018-03-101-1/+2
| | | | | | Also disable automatic hyphenation in manual pages to prevent wrapping long URLs. Ensures that URLs can be easily navigated by clicking on them.
* Document the newly added GI_HOST_OS envvarEmmanuele Bassi2018-01-251-0/+4
| | | | https://bugzilla.gnome.org/show_bug.cgi?id=761985
* g-ir-scanner: document GI_SCANNER_DEBUG in man pageSebastian Geiger2017-02-141-0/+4
| | | | https://bugzilla.gnome.org/show_bug.cgi?id=778509
* docs: fix manpage flag formatsBen Boeckel2015-09-291-1/+1
| | | | Signed-off-by: Ben Boeckel <mathstuf@gmail.com>
* Update bugzilla product/componentDieter Verfaillie2015-03-041-2/+1
| | | | | | | | | g-i bug reports have been moved from: http://bugzilla.gnome.org/enter_bug.cgi?product=glib&amp;component=introspection to: http://bugzilla.gnome.org/enter_bug.cgi?product=gobject-introspection https://bugzilla.gnome.org/show_bug.cgi?id=745498
* g-ir-scanner.1: Fix doc for --programSimon Kågedal Reimer2013-06-101-1/+1
| | | | | | Binary takes --introspect-dump argument, not --introspect. https://bugzilla.gnome.org/show_bug.cgi?id=701958
* g-ir-scanner.1: English fixColin Walters2012-10-271-1/+1
|
* docs: Show correct path used by g-ir-scannerPierre-Louis Bonicoli2012-10-271-1/+1
| | | | | | Signed-off-by: Colin Walters <walters@verbum.org> https://bugzilla.gnome.org/show_bug.cgi?id=668193
* Add GI_SCANNER_DISABLE_CACHE environment variableColin Walters2011-05-021-0/+3
| | | | https://bugzilla.gnome.org/show_bug.cgi?id=649054
* scanner: Add --include-uninstalledColin Walters2010-09-021-4/+8
| | | | | | | | We need a way to add a .gir file, without also attempting to load the pkg-config file for it (since it may not be installed yet). Example: clutter builds multiple .gir files, Cally-1.0 depends on Clutter-1.0.
* scanner: Add --accept-unprefixedColin Walters2010-09-011-0/+4
| | | | This is necessary for Mutter right now.
* Major rewriteColin Walters2010-08-311-39/+21
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | One of the first big changes in this rewrite is changing the Type object to have separate target_fundamental and target_giname properties, rather than just being strings. Previously in the scanner, it was awful because we used heuristics around strings. The ast.py is refactored so that not everything is a Node - that was a rather useless abstraction. Now, only things which can have a GIName are Node. E.g. Type and Field are no longer Node. More things were merged from glibast.py into ast.py, since it isn't a very useful split. transformer.py gains more intelligence and will e.g. turn GLib.List into a List() object earlier. The namespace processing is a lot cleaner now; since we parse the included .girs, we know the C prefix for each namespace, and have functions to parse both C type names (GtkFooBar) and symbols gtk_foo_bar into their symbols cleanly. Type resolution is much, much saner because we know Type(target_giname=Gtk.Foo) maps to the namespace Gtk. glibtransformer.py now just handles the XML processing from the dump, and a few miscellaneous things. The major heavy lifting now lives in primarytransformer.py, which is a combination of most of annotationparser.py and half of glibtransformer.py. annotationparser.py now literally just parses annotations; it's no longer in the business of e.g. guessing transfer too. finaltransformer.py is a new file which does post-analysis for "introspectability" mainly. girparser.c is fixed for some introspectable=0 processing.
* Makefile.introspection: Add _EXPORT_PACKAGES variable.Luca Bruno2010-08-281-3/+9
| | | | This new variable maps to --pkg-export.
* Remove --noclosure argumentColin Walters2010-08-171-3/+0
| | | | It's obsoleted by the introspectable=0 handling.
* [man] Mention XDG_DATA_DIRSJohan Dahlin2010-08-131-1/+4
|
* In verbose mode, print out the dump compilationColin Walters2010-07-071-0/+3
| | | | | | | | | | | | When debugging the dumper, it's extremely useful to be able to see the argument it's passing to the compiler/linker. This patch makes g-ir-scanner work the same way as libtool basically; we default to printing out stuff, and add a --quiet option. The Makefile.introspection handles passing --quiet automatically. https://bugzilla.gnome.org/show_bug.cgi?id=622751
* Support introspectable=no attribute, add warnings frameworkColin Walters2010-06-171-0/+6
| | | | | | | | | | | | | | | | | | This work allows us to move closer to replacing gtk-doc, among other things. We add a generic attribute "introspectable", and inside the typelib compiler if we see "introspectable=no", we don't put it in the typelib. This replaces the hackish pre-filter for varargs with a much more generic mechanism. The varargs is now handled in the scanner, and we emit introspectable=no for them. Add generic metadata to Node with references to file/line/column, which currently comes from symbols. Add scanner options --warn-all and --warn-error. https://bugzilla.gnome.org/show_bug.cgi?id=621570
* * docs/g-ir-scanner.1: Man page for g-ir-scanner(1) had long options with ↵Saleem Ansari2010-04-261-27/+27
| | | | | | three dashes, changed to two dashes. https://bugzilla.gnome.org/show_bug.cgi?id=616837
* g-ir-scanner.1: add information about include paths for source files.Xan Lopez2009-02-081-0/+6
| | | | svn path=/trunk/; revision=1092
* Add --libtool option which we expect Automake-using people to passColin Walters2008-11-261-0/+3
| | | | svn path=/trunk/; revision=977
* Bug 558436 - avoid having scanner load app codeColin Walters2008-11-131-1/+14
| | | | svn path=/trunk/; revision=912
* Document the renaming options.Johan Dahlin2008-10-311-2/+29
| | | | | | | | | | 2008-10-31 Johan Dahlin <jdahlin@async.com.br> * docs/g-ir-scanner.1: Document the renaming options. svn path=/trunk/; revision=850
* Add --nsversion docsJohan Dahlin2008-10-301-0/+4
| | | | svn path=/trunk/; revision=848
* Add man pages for the generator and compiler.Johan Dahlin2008-08-291-1/+1
| | | | | | | | | | | | | 2008-08-29 Johan Dahlin <johan@gnome.org> * Makefile.am: * docs/g-ir-compiler.1: * docs/g-ir-generate.1: * docs/g-ir-scanner.1: Add man pages for the generator and compiler. svn path=/trunk/; revision=518
* DocumentJohan Dahlin2008-08-291-10/+51
| | | | | | | | | 2008-08-29 Johan Dahlin <johan@gnome.org> * docs/g-ir-scanner.1: Document svn path=/trunk/; revision=517
* Add a basic, unfinshed man page for g-ir-scanner, move documents into .txtJohan Dahlin2008-04-291-0/+44
2008-04-29 Johan Dahlin <jdahlin@async.com.br> * Makefile.am: * docs/g-ir-scanner.1: * metadata-annotations-proposal.txt: * metadata-format.txt: Add a basic, unfinshed man page for g-ir-scanner, move documents into .txt svn path=/trunk/; revision=259