arm-trusted-firmware/docs
Sandrine Bailleux 6c2c8528ac docs: import MISRA compliance spreadsheet
TF-A aims to comply with MISRA C:2012 Guidelines. We maintain a list of
all rules and directives and whether the project aims to comply with
them or not. A rationale is given for each deviation.

This list used to be provided as an '.ods' spreadsheet file hosted on
developer.trustedfirmware.org. This raises the following issues:

 - The list is not version-controlled under the same scheme as TF-A
   source code. This could lead to synchronization issues between the
   two.

 - The file needs to be open in a separate program, which is not as
   straightforward as reading it from TF-A documentation itself.

 - developer.trustedfirmware.org is deprecated, thus the file cannot be
   safely kept there for any longer.

To address these issues, convert the '.ods' file into a CSV (Comma
Separated Values) file, which we import into TF-A source tree itself.
Make use of Sphinx's ability to process and render CSV files as tables
to display that information directly into the Coding Guidelines
document.

Also make the following minor changes along the way:

 - Remove dead link to MISRA C:2012 Guidelines page. Replace it with a
   link to a Wikipedia page to give a bit of context to the reader.

 - We no longer use Coverity for MISRA compliance checks. Instead, we
   use ECLAIR nowadays. Reflect this in the document.

Signed-off-by: Sandrine Bailleux <sandrine.bailleux@arm.com>
Change-Id: I422fdd8246f4f9c2498c1be18115408a873b86ac
2024-01-29 11:43:51 +01:00
..
_static/css docs(threat model): add TF-A threat model 2021-04-30 17:59:22 +02:00
about Merge "docs: add a section for experimental build options" into integration 2023-11-20 11:22:07 +01:00
components refactor(mte): deprecate CTX_INCLUDE_MTE_REGS 2024-01-23 11:58:55 -06:00
design Merge "refactor(mte): deprecate CTX_INCLUDE_MTE_REGS" into integration 2024-01-24 11:05:32 +01:00
design_documents refactor(fvp): remove RSS usage 2023-11-14 09:52:11 +02:00
getting_started docs(cpufeat): clarify description of FEATURE_DETECTION macro 2024-01-24 20:51:09 +00:00
perf docs(juno): update PSCI instrumentation data 2023-11-14 14:38:16 +00:00
plat feat(xilinx): add handler for power down req sgi irq 2024-01-09 04:15:27 -08:00
process docs: import MISRA compliance spreadsheet 2024-01-29 11:43:51 +01:00
resources docs(threat-model): supply chain threat model TF-A 2024-01-19 14:50:24 -06:00
security_advisories Merge "docs(security): security advisory for CVE-2023-49100" into integration 2024-01-22 10:41:55 +01:00
threat_model docs(threat-model): supply chain threat model TF-A 2024-01-19 14:50:24 -06:00
tools feat(memmap): add topological memory view 2023-05-12 14:38:22 +01:00
change-log.md docs(changelog): changelog for v2.10 release 2023-11-22 11:52:02 +00:00
conf.py docs(changelog): changelog for v2.10 release 2023-11-22 11:52:02 +00:00
global_substitutions.txt docs(errata_abi): document the errata abi changes 2023-05-05 13:24:59 -05:00
glossary.rst docs(threat-model): provide PSR specification reference 2024-01-13 08:04:03 +00:00
index.rst docs: update PSCI reference 2023-06-15 09:46:43 +01:00
license.rst refactor(dt-bindings): align irq bindings with kernel 2021-06-14 10:05:48 +02:00
Makefile feat(docs): allow verbose build 2023-03-21 11:47:16 +01:00
porting-guide.rst chore(auth)!: remove CryptoCell-712/713 support 2023-11-08 10:42:33 +02:00