From 9c333ade1a1b694fc6ce22e483f5de3e952c17ad Mon Sep 17 00:00:00 2001
From: Oswald Buddenhagen <oswald.buddenhagen@qt.io>
Date: Mon, 22 May 2017 17:50:30 +0200
Subject: move everying into sources/shiboken2 (5.9 edition)

in preparation for a subtree merge.
this should not be necessary to do in a separate commit, but git is a
tad stupid about following history correctly without it.
---
 sources/shiboken2/doc/projectfile.rst | 65 +++++++++++++++++++++++++++++++++++
 1 file changed, 65 insertions(+)
 create mode 100644 sources/shiboken2/doc/projectfile.rst

(limited to 'sources/shiboken2/doc/projectfile.rst')

diff --git a/sources/shiboken2/doc/projectfile.rst b/sources/shiboken2/doc/projectfile.rst
new file mode 100644
index 000000000..6c9808da4
--- /dev/null
+++ b/sources/shiboken2/doc/projectfile.rst
@@ -0,0 +1,65 @@
+.. _project-file:
+
+********************
+Binding Project File
+********************
+
+Instead of directing the Generator behaviour via command line, the binding developer
+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:
+
+The project file structure
+==========================
+
+Here follows a comprehensive example of a generator project file.
+
+    .. 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
+=================
+
+The generator project file tags are in direct relation to the
+:ref:`command line arguments <command-line>`. All of the current command line
+options provided by |project| were already seen on the :ref:`project-file-structure`,
+for new command line options provided by additional generator modules (e.g.: qtdoc,
+Shiboken) could also be used in the generator project file following simple conversion rules.
+
+For tags without options, just write as an empty tag without any attributes. Example:
+
+    .. code-block:: bash
+
+         --BOOLEAN-ARGUMENT
+
+becomes
+
+    .. code-block:: ini
+
+         BOOLEAN-ARGUMENT
+
+and
+
+    .. code-block:: bash
+
+         --VALUE-ARGUMENT=VALUE
+
+becomes
+
+    .. code-block:: ini
+
+         VALUE-ARGUMENT = VALUE
+
+
-- 
cgit v1.2.3