diff options
| author | Antonio Nino Diaz <antonio.ninodiaz@arm.com> | 2019-02-01 12:22:22 +0000 |
|---|---|---|
| committer | Antonio Nino Diaz <antonio.ninodiaz@arm.com> | 2019-02-01 12:24:57 +0000 |
| commit | 5e447816c78f4b4b5ef0b42683b820c2e88f810f (patch) | |
| tree | c0c95742c47f689c49877d41080bf375ba621b13 /docs | |
| parent | 702b600ff37c49456b8cc0c89202ca3cdb9542b9 (diff) | |
| download | platform_external_arm-trusted-firmware-5e447816c78f4b4b5ef0b42683b820c2e88f810f.tar.gz platform_external_arm-trusted-firmware-5e447816c78f4b4b5ef0b42683b820c2e88f810f.tar.bz2 platform_external_arm-trusted-firmware-5e447816c78f4b4b5ef0b42683b820c2e88f810f.zip | |
Remove unneeded include paths in PLAT_INCLUDES
Also, update platform_def.h guidelines about includes in the porting
guide.
Change-Id: I1ae338c9dd3242b309f6d53687ba2cb755d488c3
Signed-off-by: Antonio Nino Diaz <antonio.ninodiaz@arm.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/porting-guide.rst | 11 |
1 files changed, 2 insertions, 9 deletions
diff --git a/docs/porting-guide.rst b/docs/porting-guide.rst index 7fc529708..30a863d5f 100644 --- a/docs/porting-guide.rst +++ b/docs/porting-guide.rst @@ -103,20 +103,13 @@ File : platform\_def.h [mandatory] ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Each platform must ensure that a header file of this name is in the system -include path with the following constants defined. This may require updating the -list of ``PLAT_INCLUDES`` in the ``platform.mk`` file. In the Arm development -platforms, this file is found in ``plat/arm/board/<plat_name>/include/``. +include path with the following constants defined. This will require updating +the list of ``PLAT_INCLUDES`` in the ``platform.mk`` file. Platform ports may optionally use the file `include/plat/common/common\_def.h`_, which provides typical values for some of the constants below. These values are likely to be suitable for all platform ports. -Platform ports that want to be aligned with standard Arm platforms (for example -FVP and Juno) may also use `include/plat/arm/common/arm\_def.h`_, which provides -standard values for some of the constants below. However, this requires the -platform port to define additional platform porting constants in -``platform_def.h``. These additional constants are not documented here. - - **#define : PLATFORM\_LINKER\_FORMAT** Defines the linker format used by the platform, for example |