summaryrefslogtreecommitdiffstats
path: root/project/cmake/addons/README
diff options
context:
space:
mode:
Diffstat (limited to 'project/cmake/addons/README')
-rw-r--r--project/cmake/addons/README28
1 files changed, 23 insertions, 5 deletions
diff --git a/project/cmake/addons/README b/project/cmake/addons/README
index b901bb7..a0f2c32 100644
--- a/project/cmake/addons/README
+++ b/project/cmake/addons/README
@@ -1,7 +1,8 @@
1KODI ADDONS 1KODI ADDONS
2=========== 2===========
3This directory contains the cmake-based buildsystem for addons. It looks into 3This directory contains the cmake-based buildsystem for addons. It looks into
4the "addons" sub-directory and parses all *.txt files recursively. Each addon 4the directory pointed to by the ADDONS_DEFINITION_DIR option (which defaults to
5the "addons" sub-directory) and parses all *.txt files recursively. Each addon
5must have its own <addon-id>.txt file in a separate sub-directory which must 6must have its own <addon-id>.txt file in a separate sub-directory which must
6follow one of the defined format: 7follow one of the defined format:
7 <addon-id> <git-url> <git-revision> 8 <addon-id> <git-url> <git-revision>
@@ -22,13 +23,26 @@ are:
22 * platforms.txt: List of platforms to build an addon for (or "all"). It is 23 * platforms.txt: List of platforms to build an addon for (or "all"). It is
23 also supported to specify negated platforms with a leading exclamation mark 24 also supported to specify negated platforms with a leading exclamation mark
24 (i), e.g. "!windows". 25 (i), e.g. "!windows".
25 Available platforms are: linux, windows, darwin, ios, android, rbpi 26 Available platforms are: linux, windows, osx, ios, android, rbpi, freebsd
27
28ATTENTION: If no addon definitions could be found the buildsystem assumes that
29 the bootstrapping of the addon definition repositories hasn't been
30 performed yet and automatically executes the addon bootstrapping
31 buildsystem located in the "bootstrap" sub-directory with the default
32 settings (i.e. all addons from all pre-defined addon definition
33 repositories are bootstrapped into the directory pointed to by the
34 ADDONS_DEFINITION_DIR option).
26 35
27The buildsystem uses the following variables (which can be passed into it when 36The buildsystem uses the following variables (which can be passed into it when
28executing cmake with the -D<variable-name>=<value> option) to e.g. access 37executing cmake with the -D<variable-name>=<value> option) to e.g. access
29specific paths: 38specific paths:
30 * ADDONS_TO_BUILD is a quoted, space delimited list of <addon-id>s that 39 * ADDONS_TO_BUILD has two variations, which are tested in order:
31 you want to build (default is "all"). 40 - a quoted, space delimited list of <addon-id>s that
41 you want to build (default is "all").
42 - a regular expression that every <addon-id> is matched against
43 e.g.: ADDONS_TO_BUILD=pvr.* to build all pvr addons
44 * ADDONS_DEFINITION_DIR points to the directory containing the definitions
45 for the addons to be built.
32 * ADDON_SRC_PREFIX can be used to override the addon repository location. 46 * ADDON_SRC_PREFIX can be used to override the addon repository location.
33 It must point to the locally available parent directory of the addon(s) to build 47 It must point to the locally available parent directory of the addon(s) to build
34 <addon-id> will be appended to this path automatically 48 <addon-id> will be appended to this path automatically
@@ -45,11 +59,15 @@ specific paths:
45 absolute representation of ../../.. starting from this directory). 59 absolute representation of ../../.. starting from this directory).
46 * BUILD_DIR points to the directory where the addons and their dependencies 60 * BUILD_DIR points to the directory where the addons and their dependencies
47 will be downloaded and built. 61 will be downloaded and built.
48 * PACKAGE_ZIP=1 will mean the add-ons will be 'packaged' into a common folder, 62 * PACKAGE_ZIP=ON means that the add-ons will be 'packaged' into a common folder,
49 rather than being placed in <CMAKE_INSTALL_PREFIX>/lib/kodi/addons and 63 rather than being placed in <CMAKE_INSTALL_PREFIX>/lib/kodi/addons and
50 <CMAKE_INSTALL_PREFIX>/share/kodi/addons. 64 <CMAKE_INSTALL_PREFIX>/share/kodi/addons.
65 * PACKAGE_DIR points to the directory where the ZIP archived addons will be
66 stored after they have been packaged (defaults to <BUILD_DIR>/zips)
51 * ARCH_DEFINES specifies the platform-specific C/C++ preprocessor defines 67 * ARCH_DEFINES specifies the platform-specific C/C++ preprocessor defines
52 (defaults to empty). 68 (defaults to empty).
69 * ADDON_TARBALL_CACHING specifies whether downloaded addon source tarballs
70 should be cached or not (defaults to ON).
53 71
54The buildsystem makes some assumptions about the environment which must be met 72The buildsystem makes some assumptions about the environment which must be met
55by whoever uses it: 73by whoever uses it: