mirror of
https://github.com/xen-project/xen.git
synced 2026-10-28 02:01:24 +01:00
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 <nicola.vetrini@bugseng.com> Reviewed-by: Stefano Stabellini <sstabellini@kernel.org> Acked-by: Julien Grall <jgrall@amazon.com>
This commit is contained in:
1 parent
ddf664a557
commit
f0dd0cd959
1 file changed
+8
@@ -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
|
||||
________________________________________________
|
||||
|
||||