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>
This commit is contained in:
Stefano Stabellini committed 2022-06-07 17:43:47 -07:00
1 parent cea9ae0622
commit 4b08435f58
3 files changed
+141

No files matched your search

+12
View File
@@ -53,6 +53,18 @@ kind of development environment.
hypervisor-guide/index
MISRA C coding guidelines
-------------------------
MISRA C rules and directive to be used as coding guidelines when writing
Xen hypervisor code.
.. toctree::
:maxdepth: 2
misra/rules
Miscellanea
-----------
Reference in new issue
Block a user
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.