docs/misra: add Terms & Definitions section to rules.rst

Add a section for terms and definitions used by MISRA but expressed
in terms of the C specification.

Add a definition of "switch clause" to the newly-introduced section.

Link the first use of the term "switch clause" in the document to its
definition.

Suggested-by: Jan Beulich <jbeulich@suse.com>
Signed-off-by: Federico Serafini <federico.serafini@bugseng.com>
Reviewed-by: Stefano Stabellini <sstabellini@kernel.org>
This commit is contained in:
Federico Serafini authored and Jan Beulich committed 2024-05-06 09:24:37 +02:00
1 parent 6654248f22
commit 50a4f7c177
1 file changed
+12 -2
+12 -2
View File
@@ -489,8 +489,7 @@ maintainers if you want to suggest a change.
* - `Rule 16.3 <https://gitlab.com/MISRA/MISRA-C/MISRA-C-2012/Example-Suite/-/blob/master/R_16_03.c>`_
- Required
- An unconditional break statement shall terminate every
switch-clause
- An unconditional break statement shall terminate every switch-clause_
- In addition to break, also other unconditional flow control statements
such as continue, return, goto are allowed.
@@ -712,3 +711,14 @@ maintainers if you want to suggest a change.
- The value of a pointer to a FILE shall not be used after the associated
stream has been closed
-
Terms & Definitions
-------------------
.. _switch-clause:
A *switch clause* can be defined as:
"the non-empty list of statements which follows a non-empty list of
case/default labels".
A formal definition is available within the amplification of MISRA C:2012
Rule 16.1.
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.