blob: e61ede6d2b3de10f5100ac3a8fa4d7766bd2342a [file] [log] [blame]
Chris Kay74665262021-03-09 18:57:01 +00001Variables
2=========
3
4.. default-domain:: cmake
5
6.. contents::
7
8This page documents variables that are provided by the build system, grouped by
9the component that manages them. For general information on variables in CMake,
10see the :ref:`Variables <CMake Language Variables>` section of the
11:manual:`cmake-language(7) <manual:cmake-language(7)>` manual.
12
13Intrinsic Variables
14-------------------
15
16Variables defined by CMake, but which have a value or meaning defined by the
17Trusted Firmware-A build system. For documentation on *all* intrinsic CMake
18variables, see the :manual:`cmake-variables(7) <manual:cmake-variables(7)>`
19manual.
20
21.. toctree::
22 :glob:
23 :maxdepth: 1
24
25Common Variables
26----------------
27
28Variables which are always defined.
29
30.. toctree::
31 :glob:
32 :maxdepth: 1
33
34 variable/common/*
35
36Bootloader Variables
37--------------------
38
39Variables defined by individual bootloader images. These variables may not be
40defined if the bootloader image is not compatible with the platform.
41
42Library Variables
43-----------------
44
45Variables defined by individual libraries and other non-core components. These
46variables may not be defined if the library or component is not being included
47in the build.
48
49Driver Variables
50----------------
51
52Variables defined by individual drivers. These variables may not be defined if
53the driver is not being included in the build.
54
55Platform Variables
56------------------
57
58Variables defined by individual platforms. These variables may not be defined if
59the platform is not being included in the build.
60
61--------------
62
63*Copyright (c) 2021, Arm Limited and Contributors. All rights reserved.*