From f0dd0cd9598f22ee5509bb5d1466e4821834c4ba Mon Sep 17 00:00:00 2001 From: Nicola Vetrini Date: Fri, 17 Nov 2023 09:53:26 +0100 Subject: [PATCH] docs/misra: add guidance on the format of Dir 4.1 docs for ECLAIR Additional guidance on the formatting of the document for ECLAIR is supplied. Signed-off-by: Nicola Vetrini Reviewed-by: Stefano Stabellini Acked-by: Julien Grall --- docs/misra/C-runtime-failures.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/misra/C-runtime-failures.rst b/docs/misra/C-runtime-failures.rst index 1052b2afca..cac51d6b25 100644 --- a/docs/misra/C-runtime-failures.rst +++ b/docs/misra/C-runtime-failures.rst @@ -12,6 +12,14 @@ built-in checks that are present in the language. The presence of such documentation is requested by MISRA C:2012 Directive 4.1, whose headline states: "Run-time failures shall be minimized". +The ECLAIR checker for MISRA C:2012 Directive 4.1 requires the documentation +to be supplied using the following format: + +``Documentation for MISRA C:2012 Dir 4.1: `` + +The matched categories are the ones listed below (e.g., ``overflow`` and +``unexpected wrapping``). The content of the description is not checked and can +span multiple lines. Documentation for MISRA C:2012 Dir 4.1: overflow ________________________________________________