1.. Copyright (C) 2014-2020 Free Software Foundation, Inc.
2   Originally contributed by David Malcolm <dmalcolm@redhat.com>
3
4   This is free software: you can redistribute it and/or modify it
5   under the terms of the GNU General Public License as published by
6   the Free Software Foundation, either version 3 of the License, or
7   (at your option) any later version.
8
9   This program is distributed in the hope that it will be useful, but
10   WITHOUT ANY WARRANTY; without even the implied warranty of
11   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12   General Public License for more details.
13
14   You should have received a copy of the GNU General Public License
15   along with this program.  If not, see
16   <http://www.gnu.org/licenses/>.
17
18libgccjit
19=========
20
21This document describes `libgccjit <http://gcc.gnu.org/wiki/JIT>`_, an API
22for embedding GCC inside programs and libraries.
23
24Note that libgccjit is currently of "Alpha" quality;
25the APIs are not yet set in stone, and they shouldn't be used in
26production yet.
27
28There are actually two APIs for the library:
29
30* a pure C API: ``libgccjit.h``
31
32* a C++ wrapper API: ``libgccjit++.h``.  This is a collection of "thin"
33  wrapper classes around the C API, to save typing.
34
35Contents:
36
37.. toctree::
38   :maxdepth: 2
39
40   intro/index.rst
41   topics/index.rst
42   cp/index.rst
43   internals/index.rst
44
45
46Indices and tables
47==================
48
49* :ref:`genindex`
50* :ref:`modindex`
51* :ref:`search`
52
53.. Some notes:
54
55   The Sphinx C domain appears to lack explicit support for enum values,
56   so I've been using :c:macro: for them.
57
58   See http://sphinx-doc.org/domains.html#the-c-domain
59