blob: 499b8433af7f8ea758196881610c95e0dba2073d (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
|
.. _cmake-primer:
************
CMake primer
************
This chapter is a basic introduction to CMake, the build system used by PySide
and the binding generator runner.
The practical steps will focus on how to use cmake on a Unix-like (GNU/Linux)
environment.
Configuring
===========
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.
CMake variables
---------------
CMake can have its default behavior modified by providing some
* ``CMAKE_INSTALL_PREFIX=<some path here>`` sets the install prefix to
the specified path.
* ``CMAKE_MODULE_PATH=<some path here>`` sets the extra directories
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.
You can define a variable using the ``-D<VARIABLE>`` switch like the example
below.
* ``-DCMAKE_BUILD_TYPE=Release|Debug`` sets the building behavior. Default
value is *Release*.
Invoking CMake
--------------
After writing the CMakeLists.txt and deciding which flags will be used,
you can invoke CMake using::
cmake <CMake flags> <path to toplevel CMakeLists.txt file>
For example, if you use the ``build/`` folder to build the project and
want it to be installed into ``/opt/sandbox/``, use the following lines::
cd build/
cmake -DCMAKE_INSTALL_PREFIX=/opt/sandbox ..
CMake will process the project file and write the output files in the
current directory
Building
========
After the configuration process, the Makefiles are written and you can build
the project using :program:`make`.
Installing
==========
As in the building process, ``make install`` will install the files into
the target directory.
|
