Make sure you select the correct modules for your distribution and copy them to TDE_SRC/1_git/edeps/<MODULE NAME>.
Do not download the .deb packages, since those will be rebuilt when building TDE.
7) - copy build scripts from "TDE_SRC/1_git/tde-packaging/debian/_buildscripts/local/scripts" to
"TDE_SRC/buildscripts"
7) Setup the build scripts locally:
- copy build scripts from "TDE_SRC/1_git/tde-packaging/debian/_buildscripts/local/scripts" to "TDE_SRC/buildscripts"
- cd "TDE_SRC/buildscripts"
- ./update_git_repository.sh
-> the very first time this will create the TDE_SRC/buildscripts/build_config.sh file.
Edit the file to match your preferences and make sure to set TDE_DIR to your TDE_SRC folder.
- cp _build_config_template.sh build_config.sh
- edit "build_config.sh" to set your preferences and check that the various folder names match the structure on your disk.
------------------------------
B) Notes about scripts
------------------------
------------------------------
1) * Notes *
Modules are built using the build_module.sh script. After the build is completed, the installation .deb files are located in TDE_SRC/2_build/debs/<MODULE NAME>/ and the source code in TDE_SRC/2_build/debs/<MODULE NAME>/src/
Modules are built using the build_module.sh script. After the build is completed, the installation .deb files are located in TDE_SRC/2_build/debs/<MODULE NAME>/ and the source code and build reports in TDE_SRC/2_build/debs/<MODULE NAME>/src/
The source can be either the git repo or a local copy in TDE_SRC/2_build/build/<MODULE NAME>.
A module can be built in a clean chroot environment using pbuilder (default option) or locally using dpkg-buildpackage (useful for debugging/developing).
The source code can be either the git repo or a local copy in TDE_SRC/2_build/build/<MODULE NAME>.
A module can be built in a clean chroot environment using pbuilder (default option) or locally using dpkg-buildpackage (useful for quick debugging/developing).
When using pbuilder, a hook can be used to invoke a shell when the build fails (see also "known issues").
Build logs are automatically stored to files, but can also be displayed during the build process.
The location of a module build log is TDE_SRC/2_build/debs/<MODULE NAME>/src/__build__.log
The default location of a module build log is TDE_SRC/2_build/debs/<MODULE NAME>/src/__build__.log
When building sets of modules or the whole TDE, a global build summary is automatically stored to TDE_SRC/0_logs/build_result.log to quickly check what built and what failed. It is recommended to delete that file before starting a new TDE build (if not, build results will be appended at the end of the file).
2) * Scripts description *
- update_git_repository.sh:
Scripts used to update the local clone of the git repositories.
Usage:
update_git_repository.sh
- build_module.sh: build a single module
Usage:
build_module.sh [options] module_name
Options:
-g (Git) : build from git repo sources. If missing, build from the local copy in build folder.
-l (Local) : build the module locally. If missing, build in a clean chroot environment
-sl (Show Log) : output the building logs to terminal
-sl (Show Log) : output the building logs to terminal while the build is ongoing
-lr (Log Result) : log (append) build result (OK, FAILED) to TDE_SRC/0_logs/build_result.log file
-sh (Shell Hook) : use a shell hook for failing builds, only valid if building using pbuilder (clean chroot environment)
-po (Prepare Only): only prepare the source folder but do not build the module. Useful to prepare the source code before
doing local changes/development. The module can then be built from the modified local folder
-d (Debug) : enable debug symbols if possible (debian/rules file must contain "RelWithDebInfo" for this to work)
-ip (Internal Pbuilder): build using internal pbuilder mode
-ip (Internal Pbuilder): build using internal pbuilder mode (experimental)
- _build_config_template.sh
Template file for building configuration. Will be copied into TDE_SRC/build_config.sh upon first execution
Template file for building configuration. Will be copied into TDE_SRC/build_config.sh upon first execution, if not already
done when the environment was set up.
- _build_common.sh
Utility script containing common code. No need for invoking it directly.
Utility script containing common code. No need for invoking this directly.
- _build_set_common.sh
Utility script used to build sets of modules. No need for invoking it directly.
Utility script used to build sets of modules. No need for invoking this directly.
- <dd>_<set_name>.sh
A number of scripts used to build sets of modules. Each script builds an individual set.
09_others_01.sh - 10_others_02.sh : other modules that either fail to build/install or that are somehow less used
91_build_base.sh : whole TDE base system
92_build_applications.sh : all TDE applications in 04_application_01.sh - 08_application_05.sh
93_build_base.sh : all modules in 09_others_01.sh - 10_others_02.sh
93_build_others.sh : all modules in 09_others_01.sh - 10_others_02.sh
- build_TDE.sh
Script used to build the whole TDE at once. Calls the dd_setname.sh set scripts in order.
@ -124,34 +126,33 @@ Script used to build the whole TDE at once. Calls the dd_setname.sh set scripts
Options:
-s N: if specified, skip first N sets from the list of sets
== SKIP TEMPORARILY: not yet provided ==
- create_repo.sh
Creates a local repository from the .deb files currently stored in TDE_SRC/2_build/debs. This repo can be used as installation repository, just add the following lines to /etc/apt/sources.list
# --- LOCAL TDE REPOSITORY ---
deb [arch=##your arch here (ex. amd64)## trusted=yes] file:TDE_SRC(full path, ex:/home/tde_src)/3_repo/dists/testing/main/binary-##your arch here (ex. amd64)## ./
== SKIP END ==
deb [arch=<YOUR ARCH> trusted=yes] file:TDE_SRC/3_repo <YOUR DISTRO> main
For example:
deb [arch=amd64 trusted=yes] file:/home/tde_src/3_repo/ buster main
- update_git_repository.sh:
Scripts used to update the local clone of the git repositories.
Usage:
update_git_repository.sh
3) * Building hooks *
Hooks are available to execute ad-hoc code before and after the build process. For example this is very useful to automatically apply patches.
Currently there are two type of hooks:
- pre_build : applied just before switching the module to quilt format and build
- post_build: applied just after the build (dpkg-buildpackage or pbuilder) has terminated
To use a hook, just create an executable pre_build.sh and/or post_build.sh script in the TDE_SRC/1_git/hooks/<MODULE NAME> folder. The scripts are executed in the build_module.sh environment, so have access to all the variable defined in that file. See the files in the "hook examples" folder for real usage samples.
There are two type of hooks:
- pre_build : applied before switching the module to quilt format and build
- post_build: applied after the build (dpkg-buildpackage or pbuilder) has terminated
To use a hook, create an executable script (pre_build.sh and/or post_build.sh) in the TDE_SRC/1_git/hooks/<MODULE NAME> folder. The scripts are executed in the build_module.sh environment, so have access to all the variables defined in that file. See the files in the "hook examples" folder for real usage samples.
------------------------------
C) How to use the scripts
---------------------------
------------------------------
1) Follow the steps in section "A) Environment preparation" (only required the first time)
2) cd "TDE_SRC/buildscripts"
3) ./update_git_repository.sh -> update git repository, wait until "Update completed" is printed out.
Check log in TDE_SRC/0_logs/ if you wish
4) Run "pbuilder update" at the beginning of the day to update the base package to the latest version. This will speed up
the process when building several modules in sequence.
5) build modules as per your needs.
Examples of real usage:
@ -169,7 +170,7 @@ Examples of real usage:
4.2) build a single set
(optional) delete the TDE_SRC/0_logs/build_result.log file
./01_base_01.sh : build this set.
./03_base_03.sh -s 3 : build this set but skip the first 3 modules (tdeartwork, tdegames, tdetoys)
./03_base_03.sh -s 3 : build this set but skip the first 3 modules of the set.
