summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMarcelo Lira <marcelo.lira@openbossa.org>2011-01-24 21:17:27 -0300
committerMarcelo Lira <marcelo.lira@openbossa.org>2011-01-25 08:32:20 -0300
commit5f6d08e17f214d7d3a41a1cbdfb2d975e02a33cd (patch)
tree4287dc5ba6eafe5db035ea661ef3133a67aa196c /doc
parent13480bf7867bed1cfa64613fddb0d6e53aa36b9e (diff)
downloadgeneratorrunner-5f6d08e17f214d7d3a41a1cbdfb2d975e02a33cd.tar.gz
generatorrunner-5f6d08e17f214d7d3a41a1cbdfb2d975e02a33cd.tar.xz
generatorrunner-5f6d08e17f214d7d3a41a1cbdfb2d975e02a33cd.zip
Modified GeneratorRunner to support a simpler format of project file.
The project file are now just a text file containing key/value pairs. The documentation was updated accordingly, including the man page.
Diffstat (limited to 'doc')
-rw-r--r--doc/projectfile.rst40
1 files changed, 17 insertions, 23 deletions
diff --git a/doc/projectfile.rst b/doc/projectfile.rst
index 6b91bc9..f0ea7b4 100644
--- a/doc/projectfile.rst
+++ b/doc/projectfile.rst
@@ -5,7 +5,7 @@ Binding Project File
********************
Instead of directing the Generator behaviour via command line, the binding developer
-can write a XML project file describing the same information, and avoid the hassle
+can write a text project file describing the same information, and avoid the hassle
of a long stream of command line arguments.
.. _project-file-structure:
@@ -15,24 +15,18 @@ The project file structure
Here follows a comprehensive example of a generator project file.
- .. code-block:: xml
-
- <?xml version="1.0"?>
- <generator-project>
- <generator-set generator="path/to/generator/CHOICE_GENERATOR" />
- <header-file location="DIR/global.h" />
- <typesystem-file location="DIR/typesystem_for_your_binding.xml" />
- <output-directory location="OUTPUTDIR" />
- <include-paths>
- <path location="path/to/library/being/wrapped/headers/1" />
- <path location="path/to/library/being/wrapped/headers/2" />
- </include-paths>
- <typesystem-paths>
- <path location="path/to/directory/containing/type/system/files/1" />
- <path location="path/to/directory/containing/type/system/files/2" />
- </typesystem-paths>
- <enable-parent-ctor-heuristic />
- </generator-project>
+ .. code-block:: ini
+
+ [generator-project]
+ generator-set = path/to/generator/CHOICE_GENERATOR
+ header-file = DIR/global.h" />
+ typesystem-file = DIR/typesystem_for_your_binding.xml
+ output-directory location="OUTPUTDIR" />
+ include-path = path/to/library/being/wrapped/headers/1
+ include-path = path/to/library/being/wrapped/headers/2
+ typesystem-path = path/to/directory/containing/type/system/files/1
+ typesystem-path = path/to/directory/containing/type/system/files/2
+ enable-parent-ctor-heuristic
Project file tags
@@ -52,9 +46,9 @@ For tags without options, just write as an empty tag without any attributes. Exa
becomes
- .. code-block:: xml
+ .. code-block:: ini
- <BOOLEAN-ARGUMENT />
+ BOOLEAN-ARGUMENT
and
@@ -64,8 +58,8 @@ and
becomes
- .. code-block:: xml
+ .. code-block:: ini
- <VALUE-ARGUMENT value="VALUE" />
+ VALUE-ARGUMENT = VALUE