[PATCH, committed] Document the JIT C++ bindings (libgccjit++.h)

David Malcolm dmalcolm@redhat.com
Wed Jan 1 00:00:00 GMT 2014


The JIT documentation only covered libgccjit.h, not
libgccjit++.h.

The following patch expands the JIT docs to cover these C++ bindings. 

These docs began as a copy of the C documentation, but have numerous
changes and additional material to reflect the differences between the
APIs (e.g. overloaded operators, default params, use of actual
inheritance, etc).

I also ported the examples from the C tutorial to the C++ API, so e.g.
for tut02-square.c there's now also a tut02-square.cc showing the same
material but using the C++ API.

The patch also contains some fixes for the C documentation I noticed at
the same time.

I've verified the build of HTML and PDF docs.

Committed to trunk as r218588.

2014-12-10  David Malcolm  <dmalcolm@redhat.com>

	* docs/cp/index.rst: New file.
	* docs/cp/intro/index.rst: New file.
	* docs/cp/intro/tutorial01.rst: New file.
	* docs/cp/intro/tutorial02.rst: New file.
	* docs/cp/intro/tutorial03.rst: New file.
	* docs/cp/intro/tutorial04.rst: New file.
	* docs/cp/topics/contexts.rst: New file.
	* docs/cp/topics/expressions.rst: New file.
	* docs/cp/topics/functions.rst: New file.
	* docs/cp/topics/index.rst: New file.
	* docs/cp/topics/locations.rst: New file.
	* docs/cp/topics/objects.rst: New file.
	* docs/cp/topics/results.rst: New file.
	* docs/cp/topics/types.rst: New file.
	* docs/examples/tut01-hello-world.cc: New file.
	* docs/examples/tut02-square.c: Fix missing newline in output.
	* docs/examples/tut02-square.cc: New file.
	* docs/examples/tut03-sum-of-squares.cc: New file.
	* docs/examples/tut04-toyvm/toyvm.cc: New file.
	* docs/index.rst: Move summary to above the table of contents.
	Add text about the C vs C++ APIs.
	* docs/topics/contexts.rst: Fix a typo.

	* docs/_build/texinfo/libgccjit.texi: Regenerate.
	* docs/_build/texinfo/factorial1.png: New file.
	* docs/_build/texinfo/sum-of-squares1.png: New file.

-------------- next part --------------
A non-text attachment was scrubbed...
Name: r218588.patch.gz
Type: application/x-gzip
Size: 61201 bytes
Desc: not available
URL: <http://gcc.gnu.org/pipermail/jit/attachments/20140101/f7b9e0e0/attachment.bin>


More information about the Jit mailing list