summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorBruno dos Santos de Araujo <bruno.araujo@openbossa.org>2010-04-28 17:44:36 -0400
committerBruno dos Santos de Araujo <bruno.araujo@openbossa.org>2010-04-29 13:43:43 -0400
commitfaa90f5b7be896e50018b46778c6cc7aa5aba557 (patch)
treedb3a36d4f3bb9efdebfccf0d13ee6519d7d9e6c9 /doc
parent171c9ed6efaef75ec95fbb96bba890c4a8bf236b (diff)
downloadpyside-faa90f5b7be896e50018b46778c6cc7aa5aba557.tar.gz
pyside-faa90f5b7be896e50018b46778c6cc7aa5aba557.tar.xz
pyside-faa90f5b7be896e50018b46778c6cc7aa5aba557.zip
Update build docs.
Reviewer: Lauro Moura <lauro.neto@openbossa.org> Renato Ara├║jo <renato.filho@openbossa.org>
Diffstat (limited to 'doc')
-rw-r--r--doc/howto-build/cmake-primer.rst14
-rw-r--r--doc/howto-build/setup-apiextractor.rst10
-rw-r--r--doc/howto-build/setup-bindings.rst15
-rw-r--r--doc/howto-build/setup-generator.rst8
-rw-r--r--doc/howto-build/shiboken.rst3
5 files changed, 29 insertions, 21 deletions
diff --git a/doc/howto-build/cmake-primer.rst b/doc/howto-build/cmake-primer.rst
index e839ffc..6d9224c 100644
--- a/doc/howto-build/cmake-primer.rst
+++ b/doc/howto-build/cmake-primer.rst
@@ -6,9 +6,9 @@ CMake primer
************
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.
@@ -20,13 +20,13 @@ Project file - CMakeLists.txt
CMake parses the file CMakeLists.txt for information about the project,
like project name, dependencies, what should be compiled, what should be
-shipped.
+shipped, and so on.
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
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.
* ``CMAKE_TOOLCHAIN_FILE=<file path>`` sets the path to the file that
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
below.
@@ -57,7 +57,7 @@ want it to be installed into ``/opt/sandbox/``, use the following lines::
cmake -DCMAKE_INSTALL_PREFIX=/opt/sandbox ..
CMake will process the project file and write the output files in the
-current directory
+current directory.
Building
========
@@ -68,5 +68,5 @@ the project using :program:`make`.
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.
diff --git a/doc/howto-build/setup-apiextractor.rst b/doc/howto-build/setup-apiextractor.rst
index 63aa8ec..abd556c 100644
--- a/doc/howto-build/setup-apiextractor.rst
+++ b/doc/howto-build/setup-apiextractor.rst
@@ -8,7 +8,7 @@ API Extractor
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
representation of the API. It is based on the
`QtScriptGenerator <http://labs.trolltech.com/page/Projects/QtScript/Generator>`_
@@ -23,18 +23,20 @@ Build requirements
==================
+ 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
=======================
-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`.
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:
* debhelper (>= 5)
diff --git a/doc/howto-build/setup-bindings.rst b/doc/howto-build/setup-bindings.rst
index 3e31b7c..945e16f 100644
--- a/doc/howto-build/setup-bindings.rst
+++ b/doc/howto-build/setup-bindings.rst
@@ -40,7 +40,7 @@ Build requirements
==================
+ CMake (>= 2.6.0)
- + Qt 4.6 libraries + headers
+ + Qt4.6 libraries and development headers
+ Python dev libraries
+ Shiboken libraries
+ :ref:`generator-runner`
@@ -58,18 +58,23 @@ number of source files that will be compiled.
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:
* debhelper (>= 5)
* cdbs
* cmake (>= 2.6.0)
* 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)
-* libqt4-dev (>= 4.5)
+* libshiboken-dev (>= 0.3.0)
+
And then you can build the package using::
diff --git a/doc/howto-build/setup-generator.rst b/doc/howto-build/setup-generator.rst
index a0b4090..ae6e594 100644
--- a/doc/howto-build/setup-generator.rst
+++ b/doc/howto-build/setup-generator.rst
@@ -9,8 +9,8 @@ Overview
=========================================
The **Generator Runner** (A.K.A. :program:`generatorrunner`) is the
-program that controls the binding generation process according to the
-rules given by the user through headers, type system files and generator
+program that controls the bindings generation process according to the
+rules given by the user through headers, typesystem files and generator
front-ends (such as :ref:`shiboken-generator`). It depends on
:ref:`api-extractor` library.
@@ -30,13 +30,13 @@ Build requirements
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`.
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:
* debhelper (>= 5)
diff --git a/doc/howto-build/shiboken.rst b/doc/howto-build/shiboken.rst
index c4f059b..11af45e 100644
--- a/doc/howto-build/shiboken.rst
+++ b/doc/howto-build/shiboken.rst
@@ -24,13 +24,14 @@ Build requirements
+ CMake >= 2.6.0
+ Qt libraries and development headers >= 4.5.0
++ Python development headers >= 2.5
+ :ref:`api-extractor` + development headers
+ :ref:`generator-runner` + development headers
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`.
Debian packaging