cmake/addons/depends/README

   1 KODI ADDON DEPENDENCIES
   2 =======================
   3 This directory contains the cmake-based buildsystem for addon dependencies. It
   4 looks into the "common" and the "<platform>/cmake" sub-directories and parses
   5 all *.txt files recursively. Each dependency must have its own <dependency>.txt
   6 file (either in the main sub-directory or in a separate subdirectory of the main
   7 subdirectory) which must follow one of the defined formats:
   8   * an empty file means that no extra downloads are necessary
   9   * <dependency>
  10   * <dependency> <url>
  11   * <dependency> <git-url> <git-revision>
  12 where
  13   * <dependency> must be identical to the filename
  14   * <url> must be the URL to an archive that is downloaded and extracted.
  15   * <git-url> must be the URL of the git repository containing the
  16     dependency.
  17   * <git-revision> must be a valid git tag/branch/commit in the dependency's git
  18     repository which will be used for the build.
  19
  20 Reserved filenames (for additional information on how to build a dependency)
  21 are:
  22   * CMakeLists.txt: build instructions for the dependency
  23   * install.txt: instructions on how to install the dependency's built files
  24   * noinstall.txt: no installation step required (content is ignored)
  25   * flags.txt: additional build flags
  26   * flags-<CPU>.txt: additional arch specific platform build flags
  27   * deps.txt: whitespace separated list of dependencies of this dependency
  28
  29 The buildsystem uses the following depends-related variables (which can be passed
  30 into it when executing cmake with the -D<variable-name>=<value> option) to e.g.
  31 access specific paths:
  32   * DEPENDS_TO_BUILD is a quoted, space delimited list of <dependency>s that
  33     you want to build (default is "all").
  34   * ADDON_EXTRA_ARGS is a quoted, space delimited list of arguments passed to
  35     all <dependency>s built (eg -DADDON_EXTRA_ARGS="-Darg1=1 -Darg2=2").