Skip to content

RFC docs/misra: add documentation to address MISRA C:2012 Dir 4.1

Nicola Vetrini xen-devel 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 RFC Latest3 patches 5 repliesIn review

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/3docs/misra: add documentation for MISRA C:2012 Dir 4.1docs/misra/C-runtime-failures.rst docs/misra/rules.rst+245 -10 replies
2/3docs: make the docs for MISRA C:2012 Dir 4.1 visible to ECLAIRdocs/Makefile docs/misra/Makefile+42 -14 replies
3/3automation/eclair: build docs/misra to address MISRA C:2012 Dir 4.1automation/eclair_analysis/build.sh automation/eclair_analysis/prepare.sh+9 -21 reply

Reviews trailers per patch

1 of 3 patches has a Reviewed-by or Acked-by.

PatchStefano Stabellini
1/3
2/3
3/3A-b

Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes.

Read the v1 thread

Cover letter [RFC PATCH 0/3] docs/misra: add documentation to address MISRA C:2012 Dir 4.1

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.

Moreover, 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.

Nicola Vetrini (3):
docs/misra: add documentation 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   |  10 +-
 automation/eclair_analysis/prepare.sh |   1 +
 docs/Makefile                         |   7 +-
 docs/misra/C-runtime-failures.rst     | 239 ++++++++++++++++++++++++++
 docs/misra/Makefile                   |  36 ++++
 docs/misra/rules.rst                  |   7 +-
 6 files changed, 296 insertions(+), 4 deletions(-)
 create mode 100644 docs/misra/C-runtime-failures.rst
 create mode 100644 docs/misra/Makefile

--
2.34.1