diff options
Diffstat (limited to 'cmake/addons/README.md')
| -rw-r--r-- | cmake/addons/README.md | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/cmake/addons/README.md b/cmake/addons/README.md index 17e6460..ed1894e 100644 --- a/cmake/addons/README.md +++ b/cmake/addons/README.md | |||
| @@ -18,16 +18,18 @@ where | |||
| 18 | 18 | ||
| 19 | List of platforms to build an add-on for (or *all*). Negating platforms is supported using a leading exclamation mark, e.g. *!windows*. | 19 | List of platforms to build an add-on for (or *all*). Negating platforms is supported using a leading exclamation mark, e.g. *!windows*. |
| 20 | 20 | ||
| 21 | Available platforms are: linux, windows, osx, ios, android, rbpi and freebsd. | 21 | Available platforms are: linux, windows, osx, ios, android and freebsd. |
| 22 | 22 | ||
| 23 | #### Attention | 23 | #### Attention |
| 24 | If no add-on definitions could be found, the buildsystem assumes that the bootstrapping of the add-on definition repositories hasn't been performed yet and automatically executes the add-on bootstrapping buildsystem located in the *bootstrap* sub-directory with the default settings (i.e. *all* add-ons from all pre-defined add-on definition repositories are bootstrapped into the directory pointed to by the *ADDONS_DEFINITION_DIR* option). | 24 | If no add-on definitions could be found, the buildsystem assumes that the bootstrapping of the add-on definition repositories hasn't been performed yet and automatically executes the add-on bootstrapping buildsystem located in the *bootstrap* sub-directory with the default settings (i.e. *all* add-ons from all pre-defined add-on definition repositories are bootstrapped into the directory pointed to by the *ADDONS_DEFINITION_DIR* option). |
| 25 | 25 | ||
| 26 | ## Buildsystem variables | 26 | ## Buildsystem variables |
| 27 | The buildsystem uses the following addon-related variables (which can be passed into it when executing cmake with the -D`<variable-name>=<value>` format) to manipulate the build process: | 27 | The buildsystem uses the following addon-related variables (which can be passed into it when executing cmake with the -D`<variable-name>=<value>` format) to manipulate the build process: |
| 28 | - `ADDONS_TO_BUILD` has two variations, which are tested in order: | 28 | - `ADDONS_TO_BUILD` has four rules for matching a provided space delimited list: |
| 29 | - a quoted, space delimited list of `<addon-id>s` that you want to build (default is *all*) | 29 | - to build all addons, just use `all` (default is *all*) |
| 30 | - a regular expression that every `<addon-id>` is matched against (e.g. `ADDONS_TO_BUILD="pvr.*"`) to build all pvr add-ons | 30 | - an exact match of an `<addon-id>` that you want to build (e.g. `ADDONS_TO_BUILD="game.libretro"`) |
| 31 | - a regular expression `<addon-id>` is matched against (e.g. `ADDONS_TO_BUILD="pvr.*"`) to build all pvr add-ons | ||
| 32 | - a regular expression exclusion can be made using `-<addon-id regex>` (e.g. `ADDONS_TO_BUILD="pvr.* -pvr.dvb"`) to exclude pvr.dvblink and pvr.dvbviewer, but build all other pvr add-ons | ||
| 31 | - `ADDONS_DEFINITION_DIR` points to the directory containing the definitions for the addons to be built | 33 | - `ADDONS_DEFINITION_DIR` points to the directory containing the definitions for the addons to be built |
| 32 | - `ADDON_SRC_PREFIX` can be used to override the add-on repository location. It must point to the locally available parent directory of the add-on(s) to build. `<addon-id>` will be appended to this path automatically | 34 | - `ADDON_SRC_PREFIX` can be used to override the add-on repository location. It must point to the locally available parent directory of the add-on(s) to build. `<addon-id>` will be appended to this path automatically |
| 33 | - `CMAKE_INSTALL_PREFIX` points to the directory where the built add-ons and their additional files (addon.xml, resources, ...) will be installed to (defaults to `<ADDON_DEPENDS_PATH>`) | 35 | - `CMAKE_INSTALL_PREFIX` points to the directory where the built add-ons and their additional files (addon.xml, resources, ...) will be installed to (defaults to `<ADDON_DEPENDS_PATH>`) |
| @@ -44,4 +46,4 @@ Buildsystem will print a warning if you use any of the below-listed variables. F | |||
| 44 | 46 | ||
| 45 | ## Building | 47 | ## Building |
| 46 | The buildsystem makes some assumptions about the environment which must be met by whoever uses it: | 48 | The buildsystem makes some assumptions about the environment which must be met by whoever uses it: |
| 47 | - Any dependencies of the add-ons must already be built and their include and library files must be present in the path pointed to by `<CMAKE_PREFIX_PATH>` (in *include* and *lib* sub-directories) \ No newline at end of file | 49 | - Any dependencies of the add-ons must already be built and their include and library files must be present in the path pointed to by `<CMAKE_PREFIX_PATH>` (in *include* and *lib* sub-directories) |
