Update build docs.
Reviewer: Lauro Moura <lauro.neto@openbossa.org>
Renato Araújo <renato.filho@openbossa.org>
This commit is contained in:
parent
171c9ed6ef
commit
faa90f5b7b
5 changed files with 29 additions and 21 deletions
|
|
@ -6,9 +6,9 @@ CMake primer
|
||||||
************
|
************
|
||||||
|
|
||||||
This chapter is a basic introduction to CMake, the build system used by PySide
|
This chapter is a basic introduction to CMake, the build system used by PySide
|
||||||
and the boost binding generator.
|
and the bindings generator.
|
||||||
|
|
||||||
The practical steps will focus on how to use cmake on a Unix-like (GNU/Linux)
|
The practical steps will focus on how to use CMake on a Unix-like (GNU/Linux)
|
||||||
environment.
|
environment.
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -20,13 +20,13 @@ Project file - CMakeLists.txt
|
||||||
|
|
||||||
CMake parses the file CMakeLists.txt for information about the project,
|
CMake parses the file CMakeLists.txt for information about the project,
|
||||||
like project name, dependencies, what should be compiled, what should be
|
like project name, dependencies, what should be compiled, what should be
|
||||||
shipped.
|
shipped, and so on.
|
||||||
|
|
||||||
|
|
||||||
CMake variables
|
CMake variables
|
||||||
---------------
|
---------------
|
||||||
|
|
||||||
CMake can have its default behavior modified by providing some
|
CMake can have its default behavior modified by providing some options in the command line:
|
||||||
|
|
||||||
* ``CMAKE_INSTALL_PREFIX=<some path here>`` sets the install prefix to
|
* ``CMAKE_INSTALL_PREFIX=<some path here>`` sets the install prefix to
|
||||||
the specified path.
|
the specified path.
|
||||||
|
|
@ -34,7 +34,7 @@ CMake can have its default behavior modified by providing some
|
||||||
where CMake will try to find its modules.
|
where CMake will try to find its modules.
|
||||||
* ``CMAKE_TOOLCHAIN_FILE=<file path>`` sets the path to the file that
|
* ``CMAKE_TOOLCHAIN_FILE=<file path>`` sets the path to the file that
|
||||||
describes the toolchain used to compile this project. It is very useful
|
describes the toolchain used to compile this project. It is very useful
|
||||||
when using CMake with icecc to speedup compilation.
|
when using CMake with `Icecream <http://en.opensuse.org/Icecream>`_ to speed up compilation.
|
||||||
|
|
||||||
You can define a variable using the ``-D<VARIABLE>`` switch like the example
|
You can define a variable using the ``-D<VARIABLE>`` switch like the example
|
||||||
below.
|
below.
|
||||||
|
|
@ -57,7 +57,7 @@ want it to be installed into ``/opt/sandbox/``, use the following lines::
|
||||||
cmake -DCMAKE_INSTALL_PREFIX=/opt/sandbox ..
|
cmake -DCMAKE_INSTALL_PREFIX=/opt/sandbox ..
|
||||||
|
|
||||||
CMake will process the project file and write the output files in the
|
CMake will process the project file and write the output files in the
|
||||||
current directory
|
current directory.
|
||||||
|
|
||||||
Building
|
Building
|
||||||
========
|
========
|
||||||
|
|
@ -68,5 +68,5 @@ the project using :program:`make`.
|
||||||
Installing
|
Installing
|
||||||
==========
|
==========
|
||||||
|
|
||||||
As in the building process, ``make install`` will install the files into
|
As in the building process, :program:`make install` will install the files into
|
||||||
the target directory.
|
the target directory.
|
||||||
|
|
|
||||||
|
|
@ -8,7 +8,7 @@ API Extractor
|
||||||
Overview
|
Overview
|
||||||
========
|
========
|
||||||
|
|
||||||
The **API Extractor** library is used by the binding generator to
|
The **API Extractor** library is used by the bindings generator to
|
||||||
parse the header and typesystem files to create an internal
|
parse the header and typesystem files to create an internal
|
||||||
representation of the API. It is based on the
|
representation of the API. It is based on the
|
||||||
`QtScriptGenerator <http://labs.trolltech.com/page/Projects/QtScript/Generator>`_
|
`QtScriptGenerator <http://labs.trolltech.com/page/Projects/QtScript/Generator>`_
|
||||||
|
|
@ -23,18 +23,20 @@ Build requirements
|
||||||
==================
|
==================
|
||||||
|
|
||||||
+ CMake >= 2.6.0
|
+ CMake >= 2.6.0
|
||||||
+ Qt4.5 libraries and development headers >= 4.5.0
|
+ Qt4.5 libraries and development headers >= 4.5
|
||||||
|
+ libxml2 libraries and development headers >= 2.6.32
|
||||||
|
+ libxslt libraries and development headers >= 1.1.19
|
||||||
|
|
||||||
Building and installing
|
Building and installing
|
||||||
=======================
|
=======================
|
||||||
|
|
||||||
To build and install just follow the generic cmake instructions in section
|
To build and install just follow the generic CMake instructions in section
|
||||||
:ref:`cmake-primer`.
|
:ref:`cmake-primer`.
|
||||||
|
|
||||||
Debian packaging
|
Debian packaging
|
||||||
================
|
================
|
||||||
|
|
||||||
In order to compile this package in a debian environment, make sure the
|
In order to compile this package in a Debian environment, make sure the
|
||||||
following packages are installed:
|
following packages are installed:
|
||||||
|
|
||||||
* debhelper (>= 5)
|
* debhelper (>= 5)
|
||||||
|
|
|
||||||
|
|
@ -40,7 +40,7 @@ Build requirements
|
||||||
==================
|
==================
|
||||||
|
|
||||||
+ CMake (>= 2.6.0)
|
+ CMake (>= 2.6.0)
|
||||||
+ Qt 4.6 libraries + headers
|
+ Qt4.6 libraries and development headers
|
||||||
+ Python dev libraries
|
+ Python dev libraries
|
||||||
+ Shiboken libraries
|
+ Shiboken libraries
|
||||||
+ :ref:`generator-runner`
|
+ :ref:`generator-runner`
|
||||||
|
|
@ -58,18 +58,23 @@ number of source files that will be compiled.
|
||||||
Debian packaging
|
Debian packaging
|
||||||
================
|
================
|
||||||
|
|
||||||
.. note:: For the time being the Debian packaging uses Qt 4.5 as dependency, therefore the generated bindings will be for this version of Qt.
|
.. note:: Qt 4.6 is available for Debian in the testing branch (squeeze), Ubuntu 10.04 (Lucid Lynx), and in Maemo 5 (Fremantle) in the upcoming PR 1.2 update. For building to Maemo 5, it is advised to get the packaging from the source uploaded to Maemo extras-devel, as it needs minor modifications in order to build.
|
||||||
|
|
||||||
In order to compile this package in a debian environment, make sure the
|
In order to compile this package in a Debian environment, make sure the
|
||||||
following packages are installed:
|
following packages are installed:
|
||||||
|
|
||||||
* debhelper (>= 5)
|
* debhelper (>= 5)
|
||||||
* cdbs
|
* cdbs
|
||||||
* cmake (>= 2.6.0)
|
* cmake (>= 2.6.0)
|
||||||
* python-all-dev
|
* python-all-dev
|
||||||
* python-central (>= 0.6)
|
* python-all-dbg
|
||||||
|
* python-support (>= 0.3.9)
|
||||||
|
* libqt4-dev
|
||||||
|
* libqt4-opengl-dev
|
||||||
|
* shiboken (>= 0.3)
|
||||||
* generatorrunner (>= 0.4)
|
* generatorrunner (>= 0.4)
|
||||||
* libqt4-dev (>= 4.5)
|
* libshiboken-dev (>= 0.3.0)
|
||||||
|
|
||||||
|
|
||||||
And then you can build the package using::
|
And then you can build the package using::
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -9,8 +9,8 @@ Overview
|
||||||
=========================================
|
=========================================
|
||||||
|
|
||||||
The **Generator Runner** (A.K.A. :program:`generatorrunner`) is the
|
The **Generator Runner** (A.K.A. :program:`generatorrunner`) is the
|
||||||
program that controls the binding generation process according to the
|
program that controls the bindings generation process according to the
|
||||||
rules given by the user through headers, type system files and generator
|
rules given by the user through headers, typesystem files and generator
|
||||||
front-ends (such as :ref:`shiboken-generator`). It depends on
|
front-ends (such as :ref:`shiboken-generator`). It depends on
|
||||||
:ref:`api-extractor` library.
|
:ref:`api-extractor` library.
|
||||||
|
|
||||||
|
|
@ -30,13 +30,13 @@ Build requirements
|
||||||
Building and installing
|
Building and installing
|
||||||
=======================
|
=======================
|
||||||
|
|
||||||
To build and install just follow the generic cmake instructions in
|
To build and install just follow the generic CMake instructions in
|
||||||
section :ref:`cmake-primer`.
|
section :ref:`cmake-primer`.
|
||||||
|
|
||||||
Debian packaging
|
Debian packaging
|
||||||
================
|
================
|
||||||
|
|
||||||
In order to compile this package in a debian environment, make sure the
|
In order to compile this package in a Debian environment, make sure the
|
||||||
following packages are installed:
|
following packages are installed:
|
||||||
|
|
||||||
* debhelper (>= 5)
|
* debhelper (>= 5)
|
||||||
|
|
|
||||||
|
|
@ -24,13 +24,14 @@ Build requirements
|
||||||
|
|
||||||
+ CMake >= 2.6.0
|
+ CMake >= 2.6.0
|
||||||
+ Qt libraries and development headers >= 4.5.0
|
+ Qt libraries and development headers >= 4.5.0
|
||||||
|
+ Python development headers >= 2.5
|
||||||
+ :ref:`api-extractor` + development headers
|
+ :ref:`api-extractor` + development headers
|
||||||
+ :ref:`generator-runner` + development headers
|
+ :ref:`generator-runner` + development headers
|
||||||
|
|
||||||
Building and installing
|
Building and installing
|
||||||
=======================
|
=======================
|
||||||
|
|
||||||
To build and install just follow the generic cmake instructions in
|
To build and install just follow the generic CMake instructions in
|
||||||
section :ref:`cmake-primer`.
|
section :ref:`cmake-primer`.
|
||||||
|
|
||||||
Debian packaging
|
Debian packaging
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue