]> git.ipfire.org Git - thirdparty/gcc.git/blame - gcc/jit/docs/index.rst
Merger of dmalcolm/jit branch from git
[thirdparty/gcc.git] / gcc / jit / docs / index.rst
CommitLineData
35485da9
DM
1.. Copyright (C) 2014 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
21Contents:
22
23.. toctree::
24 :maxdepth: 2
25
26 intro/index.rst
27 topics/index.rst
28 internals/index.rst
29
30This document describes `libgccjit <http://gcc.gnu.org/wiki/JIT>`_, an API
31for embedding GCC inside programs and libraries.
32
33Note that libgccjit is currently of "Alpha" quality;
34the APIs are not yet set in stone, and they shouldn't be used in
35production yet.
36
37
38Indices and tables
39==================
40
41* :ref:`genindex`
42* :ref:`modindex`
43* :ref:`search`
44
45.. Some notes:
46
47 The Sphinx C domain appears to lack explicit support for enum values,
48 so I've been using :c:macro: for them.
49
50 See http://sphinx-doc.org/domains.html#the-c-domain