Mercurial > hg > CbC > CbC_gcc

annotate gcc/jit/docs/index.rst @ 158:494b0b89df80 default tip

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