The headline of Directive 4.1 states: "Run-time failures shall be minimized".
Thus, it requires the project to supply documentation that pertains the measures
and techinques used to prevent run-time failures from happening. For ease of
reading, the documentation is in RST format, but since ECLAIR needs a source file
to check that the needed subsections and their format is the one expected, the
Makefiles for the docs/ are amended to generate such a file.
The format and categories of the subsections in the .rst file can be
customized based on feedback from the community: the one provided is just a
basic skeleton that should be tailored to the project.
This series is based on the following RFC:
https://lore.kernel.org/xen-devel/cover.1692636338.git.nicola.vetrini@bugseng.com/
Nicola Vetrini (3):
docs/misra: add documentation skeleton for MISRA C:2012 Dir 4.1
docs: make the docs for MISRA C:2012 Dir 4.1 visible to ECLAIR
automation/eclair: build docs/misra to address MISRA C:2012 Dir 4.1
automation/eclair_analysis/build.sh | 11 +-
automation/eclair_analysis/prepare.sh | 5 +-
docs/Makefile | 7 +-
docs/misra/C-runtime-failures.rst | 239 ++++++++++++++++++++++++++
docs/misra/Makefile | 17 ++
docs/misra/rules.rst | 7 +-
6 files changed, 279 insertions(+), 7 deletions(-)
create mode 100644 docs/misra/C-runtime-failures.rst
create mode 100644 docs/misra/Makefile
--
2.34.1