source: branches/kmk/README.DEV @ 317

Last change on this file since 317 was 317, checked in by dmik, 12 years ago

branches/kmk: env.cmd: Added an easy way to activate the debug build and some more documentation.

File size: 3.1 KB
Line 
1This file contains instructions on building Lucide.
2
3
4
5REQUIREMENTS
6
7In order to build Lucide, you will need the following tools:
8
9  - kBuild version 0.1.5 (r2206) or later. Get it with the following command:
10
11      svn co http://svn.netlabs.org/repos/kbuild/trunk/kBuild -r 2206
12
13  - GCC compiler version 3.3.5 or 4.4.2 for OS/2 and the patched OpenWatcom
14    linker. The GCC compiler must be set up to use the OpenWatcom linker for
15    linking.
16
17    If you do not have a working GCC environment with the above requirements, it
18    is recommended to download a ready-to-use GCC 4.2.2 distribution from here:
19
20      ftp://ftp.netlabs.org/pub/qt4/tools/gcc-4_4_2-complete-20091205.zip
21
22    Follow the installation instructions contained in the README file inside
23    this ZIP archive to set up the GCC environment.
24
25  - SOM SDK 2.x. The one that is part of the OS/2 Tooklit version 4.5 is known
26    to work and recommended. Note that installing the Toolkit is not required
27    (though it will also work) -- you may simply extract the "som" subdirectory
28    (with all its contents) out of the Toolkit and place it to some directory.
29    You don't need to put any statements in CONFIG.SYS in this case.
30
31
32
33SETTING UP THE ENVIRONMENT
34
35Copy "LocalEnv.cmd.tpl" to "LocalEnv.cmd" and adjust the copy to match your
36environment. Each option in "LocalEnv.cmd.tpl" has a comment describing what it
37does.
38
39You may also want to adjust the configuration of the Lucide build according to
40your needs. To do so, copy "LocalConfig.kmk.tpl" to "LocalConfig.kmk" and adjust
41the copy to match your requirements. Each option in "LocalConfig.kmk.tpl" has a
42comment descriping what it does.
43
44Now, start "env.cmd" to setup the environment and type "kmk" in the root
45directory of the Lucide source tree to start kBuild and build the release
46version of Lucide and all plugins.
47
48If you are a developer, you may prefer to use the "se.cmd" script instead of
49starting "env.cmd" in each new shell. This script will allow you to run "kmk"
50in the correct environment from any directory inside the Lucide source tree by
51simply typing "se kmk" in that directory. This is especially handy if you use
52e.g. File Commander as your development IDE. The "se.cmd" script may be taken
53at:
54
55  ftp://ftp.netlabs.org/pub/qt4/tools/se10.zip
56
57
58
59USEFUL KBUILD VARIABLES
60
61These are the frequently used variables that change the Lucide build or
62behavior. You may set them in the OS/2 environment or put to your
63"LocalConfig.kmk" or pass to "kmk" as command line arguments in the form of
64"VARIABLE=VALUE".
65
66  * BUILD_TYPE
67
68    Build type. May be set to "release" (default) or "debug".
69
70    Note that you may also pass "debug" or "release" as the first argument to
71    the "env.cmd" script to set the build type to "debug".
72
73    Hint: If you use "se.cmd", you may pass arguments to "env.cmd" and start
74    "kmk" in one step, like that: "se @(debug) kmk".
75
76  * KBUILD_VERBOSE
77
78    Level of kBuild verbosity, 1 to 3 (default is nothing which means almost
79    quiet). The highest level will make kBuild print every command it executes
80    which is useful when something does not work like you want.
81
Note: See TracBrowser for help on using the repository browser.