diff options
| author | Stefano Stabellini <stefano.stabellini@xilinx.com> | 2022-05-31 18:44:01 -0700 |
|---|---|---|
| committer | Stefano Stabellini <stefano.stabellini@xilinx.com> | 2022-06-07 17:43:47 -0700 |
| commit | 4b08435f586e3f605fdc13f7cb38484f37ad42e9 (patch) | |
| tree | a318642518eb61d10004d89bfc72efc34d25d167 /CODING_STYLE | |
| parent | cea9ae06229577cd5b77019ce122f9cdd1568106 (diff) | |
| download | xen-4b08435f586e3f605fdc13f7cb38484f37ad42e9.tar.gz | |
docs/misra: introduce rules.rst
Introduce a list of MISRA C rules that apply to the Xen hypervisor. The
list is in RST format.
Specify that rules deviations need to be documented. Introduce a
documentation tag for in-code comments to mark them as deviations. Also
mention that other documentation mechanisms are work-in-progress.
Add a mention of the new list to CODING_STYLE.
Signed-off-by: Stefano Stabellini <stefano.stabellini@xilinx.com>
Signed-off-by: Bertrand Marquis <bertrand.marquis@arm.com>
Acked-by: Julien Grall <jgrall@amazon.com>
Diffstat (limited to 'CODING_STYLE')
| -rw-r--r-- | CODING_STYLE | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/CODING_STYLE b/CODING_STYLE index 9f50d9cec4..3386ee1d90 100644 --- a/CODING_STYLE +++ b/CODING_STYLE @@ -14,6 +14,12 @@ explicitly (e.g. tools/libxl/CODING_STYLE) but often implicitly (Linux coding style is fairly common). In general you should copy the style of the surrounding code. If you are unsure please ask. +MISRA C +------- + +The Xen Hypervisor follows some MISRA C coding rules. See +docs/misra/rules.rst for details. + Indentation ----------- |