| Message ID | c2ca76c67bfeaf1fab106af4bda6d6107e722208.1699975581.git.nicola.vetrini@bugseng.com (mailing list archive) |
|---|---|
| State | Superseded |
| Headers | show |
| Series | use the documentation for MISRA C:2012 Dir 4.1 | expand |
On Tue, 14 Nov 2023, Nicola Vetrini wrote: > Additional guidance on the formatting of the document for ECLAIR > is supplied. > > Signed-off-by: Nicola Vetrini <nicola.vetrini@bugseng.com> Reviewed-by: Stefano Stabellini <sstabellini@kernel.org>
Hi Nicola, On 14/11/2023 15:36, Nicola Vetrini wrote: > Additional guidance on the formatting of the document for ECLAIR > is supplied. > > Signed-off-by: Nicola Vetrini <nicola.vetrini@bugseng.com> Acked-by: Julien Grall <jgrall@amazon.com> Cheers,
diff --git a/docs/misra/C-runtime-failures.rst b/docs/misra/C-runtime-failures.rst index 1052b2afca13..cac51d6b2596 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: <category> <description>`` + +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 ________________________________________________
Additional guidance on the formatting of the document for ECLAIR is supplied. Signed-off-by: Nicola Vetrini <nicola.vetrini@bugseng.com> --- docs/misra/C-runtime-failures.rst | 8 ++++++++ 1 file changed, 8 insertions(+)