arm-trusted-firmware/docs
Antonio Nino Diaz 09d40e0e08 Sanitise includes across codebase
Enforce full include path for includes. Deprecate old paths.

The following folders inside include/lib have been left unchanged:

- include/lib/cpus/${ARCH}
- include/lib/el3_runtime/${ARCH}

The reason for this change is that having a global namespace for
includes isn't a good idea. It defeats one of the advantages of having
folders and it introduces problems that are sometimes subtle (because
you may not know the header you are actually including if there are two
of them).

For example, this patch had to be created because two headers were
called the same way: e0ea0928d5 ("Fix gpio includes of mt8173 platform
to avoid collision."). More recently, this patch has had similar
problems: 46f9b2c3a2 ("drivers: add tzc380 support").

This problem was introduced in commit 4ecca33988 ("Move include and
source files to logical locations"). At that time, there weren't too
many headers so it wasn't a real issue. However, time has shown that
this creates problems.

Platforms that want to preserve the way they include headers may add the
removed paths to PLAT_INCLUDES, but this is discouraged.

Change-Id: I39dc53ed98f9e297a5966e723d1936d6ccf2fc8f
Signed-off-by: Antonio Nino Diaz <antonio.ninodiaz@arm.com>
2019-01-04 10:43:17 +00:00
..
diagrams Add Secure Partition Manager (SPM) design document 2017-12-15 11:47:22 +00:00
draw.io docs: Add RAS framework documentation 2018-11-26 14:51:41 +00:00
marvell docs: marvell: Fix typo in file build.txt 2018-12-25 14:42:08 +08:00
plantuml SDEI: Make dispatches synchronous 2018-06-21 16:15:23 +01:00
plat plat: imx: Add i.MX8MQ basic support 2018-12-05 08:58:51 +08:00
spd Update Arm TF references to TF-A 2018-03-15 17:00:34 +00:00
arm-sip-service.rst Update Arm TF references to TF-A 2018-03-15 17:00:34 +00:00
auth-framework.rst Update Arm TF references to TF-A 2018-03-15 17:00:34 +00:00
change-log.rst Fix typos in changelog 2018-10-10 12:11:32 +01:00
cpu-specific-build-macros.rst Fix broken links in documentation 2018-09-04 11:28:02 +01:00
exception-handling.rst Sanitise includes across codebase 2019-01-04 10:43:17 +00:00
firmware-design.rst docs: Add Exception Handling Framework documentation 2018-11-26 11:22:32 +00:00
firmware-update.rst Update Arm TF references to TF-A 2018-03-15 17:00:34 +00:00
interrupt-framework-design.rst docs: Add Exception Handling Framework documentation 2018-11-26 11:22:32 +00:00
platform-compatibility-policy.rst docs: Fixup filename and links to compatibility policy 2018-10-02 14:03:37 +01:00
platform-interrupt-controller-API.rst Update Arm TF references to TF-A 2018-03-15 17:00:34 +00:00
porting-guide.rst plat/common/crash_console_helpers.S: Fix MULTI_CONSOLE_API support 2018-12-06 16:10:32 -08:00
psci-lib-integration-guide.rst libc: Move tf_printf and tf_snprintf to libc 2018-08-22 10:26:05 +01:00
psci-pd-tree.rst Fix typo in documentation page title 2018-08-15 14:54:40 +01:00
ras.rst docs: Add RAS framework documentation 2018-11-26 14:51:41 +00:00
reset-design.rst Update Arm TF references to TF-A 2018-03-15 17:00:34 +00:00
rt-svc-writers-guide.rst Rename 'smcc' to 'smccc' 2018-03-21 10:49:27 +00:00
sdei.rst SDEI: Make dispatches synchronous 2018-06-21 16:15:23 +01:00
secure-partition-manager-design.rst SPM: EHF: Build EHF module along with Secure Partition Manager 2018-11-14 11:18:22 +05:30
trusted-board-boot.rst Update Arm TF references to TF-A 2018-03-15 17:00:34 +00:00
user-guide.rst docs: User-guide corrections for RESET_TO_BL31 2018-12-17 15:25:49 +00:00
xlat-tables-lib-v2-design.rst xlat v2: Update documentation 2018-07-03 14:56:31 +01:00