luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-11-07 01:46:16 +01:00
Code Issues Packages Projects Releases Wiki Activity
20d54ba5f1
glib/docs/reference/girepository/gi-compile-repository.rst

104 lines
2.4 KiB
ReStructuredText
Raw Normal View History

Add metadata header to gi-* man pages Signed-off-by: Simon McVittie <smcv@collabora.com>
2024-02-13 16:53:47 +01:00
.. _gi-compile-repository(1):
.. meta::
:copyright: Copyright 2010 Johan Dahlin
:copyright: Copyright 2015 Ben Boeckel
:copyright: Copyright 2013, 2015 Dieter Verfaillie
:copyright: Copyright 2018 Emmanuele Bassi
:copyright: Copyright 2018 Tomasz Miąsko
:copyright: Copyright 2018 Christoph Reiter
:copyright: Copyright 2020 Jan Tojnar
Retitle gi-* man pages and update content gi-compile-repository --module and gi-decompile-typelib --shlib are intentionally undocumented here: they will be removed in !3926. Signed-off-by: Simon McVittie <smcv@collabora.com>
2024-02-13 17:14:54 +01:00
:copyright: Copyright 2024 Collabora Ltd.
Add metadata header to gi-* man pages Signed-off-by: Simon McVittie <smcv@collabora.com>
2024-02-13 16:53:47 +01:00
:license: LGPL-2.1-or-later
..
This has to be duplicated from above to make it machine-readable by `reuse`:
SPDX-FileCopyrightText: 2010 Johan Dahlin
SPDX-FileCopyrightText: 2015 Ben Boeckel
SPDX-FileCopyrightText: 2013, 2015 Dieter Verfaillie
SPDX-FileCopyrightText: 2018 Emmanuele Bassi
SPDX-FileCopyrightText: 2018 Tomasz Miąsko
SPDX-FileCopyrightText: 2018 Christoph Reiter
SPDX-FileCopyrightText: 2020 Jan Tojnar
Retitle gi-* man pages and update content gi-compile-repository --module and gi-decompile-typelib --shlib are intentionally undocumented here: they will be removed in !3926. Signed-off-by: Simon McVittie <smcv@collabora.com>
2024-02-13 17:14:54 +01:00
SPDX-FileCopyrightText: 2024 Collabora Ltd.
Add metadata header to gi-* man pages Signed-off-by: Simon McVittie <smcv@collabora.com>
2024-02-13 16:53:47 +01:00
SPDX-License-Identifier: LGPL-2.1-or-later
Retitle gi-* man pages and update content gi-compile-repository --module and gi-decompile-typelib --shlib are intentionally undocumented here: they will be removed in !3926. Signed-off-by: Simon McVittie <smcv@collabora.com>
2024-02-13 17:14:54 +01:00
=====================
gi-compile-repository
=====================
Sphinx based user documentation 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
2018-06-10 11:24:47 +02:00
----------------
Typelib compiler
----------------
:Manual section: 1
SYNOPSIS
========
Retitle gi-* man pages and update content gi-compile-repository --module and gi-decompile-typelib --shlib are intentionally undocumented here: they will be removed in !3926. Signed-off-by: Simon McVittie <smcv@collabora.com>
2024-02-13 17:14:54 +01:00
**gi-compile-repository** [*OPTION*…] *GIRFILE*
Sphinx based user documentation 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
2018-06-10 11:24:47 +02:00
DESCRIPTION
===========
Retitle gi-* man pages and update content gi-compile-repository --module and gi-decompile-typelib --shlib are intentionally undocumented here: they will be removed in !3926. Signed-off-by: Simon McVittie <smcv@collabora.com>
2024-02-13 17:14:54 +01:00
gi-compile-repository converts one or more GIR files into one or more typelibs.
The output will be written to standard output unless the ``--output`` is
Sphinx based user documentation 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
2018-06-10 11:24:47 +02:00
specified.
OPTIONS
=======
Retitle gi-* man pages and update content gi-compile-repository --module and gi-decompile-typelib --shlib are intentionally undocumented here: they will be removed in !3926. Signed-off-by: Simon McVittie <smcv@collabora.com>
2024-02-13 17:14:54 +01:00
``--help``
Show help options.
Sphinx based user documentation 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
2018-06-10 11:24:47 +02:00
Retitle gi-* man pages and update content gi-compile-repository --module and gi-decompile-typelib --shlib are intentionally undocumented here: they will be removed in !3926. Signed-off-by: Simon McVittie <smcv@collabora.com>
2024-02-13 17:14:54 +01:00
``--output`` *FILENAME*, ``-o`` *FILENAME*
Save the resulting output in *FILENAME*.
Sphinx based user documentation 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
2018-06-10 11:24:47 +02:00
Retitle gi-* man pages and update content gi-compile-repository --module and gi-decompile-typelib --shlib are intentionally undocumented here: they will be removed in !3926. Signed-off-by: Simon McVittie <smcv@collabora.com>
2024-02-13 17:14:54 +01:00
``--verbose``
Show verbose messages.
Sphinx based user documentation 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
2018-06-10 11:24:47 +02:00
Retitle gi-* man pages and update content gi-compile-repository --module and gi-decompile-typelib --shlib are intentionally undocumented here: they will be removed in !3926. Signed-off-by: Simon McVittie <smcv@collabora.com>
2024-02-13 17:14:54 +01:00
``--debug``
Show debug messages.
Sphinx based user documentation 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
2018-06-10 11:24:47 +02:00
Retitle gi-* man pages and update content gi-compile-repository --module and gi-decompile-typelib --shlib are intentionally undocumented here: they will be removed in !3926. Signed-off-by: Simon McVittie <smcv@collabora.com>
2024-02-13 17:14:54 +01:00
``--includedir`` *DIRECTORY*
Add *DIRECTORY* to the search path for GIR XML.
This option can be used more than once.
The first *DIRECTORY* on the command-line will be searched first
(highest precedence).
Sphinx based user documentation 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
2018-06-10 11:24:47 +02:00
Retitle gi-* man pages and update content gi-compile-repository --module and gi-decompile-typelib --shlib are intentionally undocumented here: they will be removed in !3926. Signed-off-by: Simon McVittie <smcv@collabora.com>
2024-02-13 17:14:54 +01:00
``--shared-library`` *FILENAME*, ``-l`` *FILENAME*
Sphinx based user documentation 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
2018-06-10 11:24:47 +02:00
Specifies the shared library where the symbols in the typelib can be
found. The name of the library should not contain the ending shared
library suffix.
Retitle gi-* man pages and update content gi-compile-repository --module and gi-decompile-typelib --shlib are intentionally undocumented here: they will be removed in !3926. Signed-off-by: Simon McVittie <smcv@collabora.com>
2024-02-13 17:14:54 +01:00
This option can be used more than once, for typelibs that describe
more than one shared library.
Sphinx based user documentation 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
2018-06-10 11:24:47 +02:00
Retitle gi-* man pages and update content gi-compile-repository --module and gi-decompile-typelib --shlib are intentionally undocumented here: they will be removed in !3926. Signed-off-by: Simon McVittie <smcv@collabora.com>
2024-02-13 17:14:54 +01:00
``--version``
Show program’s version number and exit.
Add a --version option to g-ir-compiler and g-ir-generate. Resolves: gobject-introspection#55
2018-12-16 13:42:27 +01:00
Sphinx based user documentation 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
2018-06-10 11:24:47 +02:00
g-ir- tools: Add examples to man pages Signed-off-by: Simon McVittie <smcv@collabora.com>
2024-02-14 12:41:14 +01:00
EXAMPLE
=======
::
$ gi-compile-repository -o Gio-2.0.typelib /usr/share/gir-1.0/Gio-2.0.gir
Sphinx based user documentation 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
2018-06-10 11:24:47 +02:00
BUGS
====
Retitle gi-* man pages and update content gi-compile-repository --module and gi-decompile-typelib --shlib are intentionally undocumented here: they will be removed in !3926. Signed-off-by: Simon McVittie <smcv@collabora.com>
2024-02-13 17:14:54 +01:00
Report bugs at https://gitlab.gnome.org/GNOME/glib/-/issues
Sphinx based user documentation 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
2018-06-10 11:24:47 +02:00
HOMEPAGE and CONTACT
====================
docs: Update website link
2020-05-15 21:19:54 +02:00
https://gi.readthedocs.io/
Sphinx based user documentation 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
2018-06-10 11:24:47 +02:00
AUTHORS
=======
Spell Matthias' name correctly in the gi-* man pages This was wrong since 2008. Signed-off-by: Simon McVittie <smcv@collabora.com>
2024-02-13 17:15:07 +01:00
Matthias Clasen
Reference in New Issue Copy Permalink