diff mbox series

docs/misra: add Rule 1.1 and 5.6

Message ID 20230721002322.3457802-1-sstabellini@kernel.org (mailing list archive)
State Superseded
Headers show
Series docs/misra: add Rule 1.1 and 5.6 | expand

Commit Message

Stefano Stabellini July 21, 2023, 12:23 a.m. UTC 
From: Stefano Stabellini <stefano.stabellini@amd.com>

Rule 1.1 is uncontroversial and we are already following it.

Rule 5.6 has been deemed a good rule to have by the MISRA C group.
However, we do have a significant amount of violations that will take
time to resolve and might require partial deviations in the form of
in-code comments or MISRA C scanners special configurations (ECLAIR).
For new code, we want this rule to apply hence the addition to
docs/misra/rules.rst.

Signed-off-by: Stefano Stabellini <stefano.stabellini@amd.com>
---
 docs/misra/rules.rst | 12 ++++++++++++
 1 file changed, 12 insertions(+)

Comments

Jan Beulich July 21, 2023, 6:47 a.m. UTC | #1 
On 21.07.2023 02:23, Stefano Stabellini wrote:
> From: Stefano Stabellini <stefano.stabellini@amd.com>
> 
> Rule 1.1 is uncontroversial and we are already following it.

Except for our extensive use of compiler extensions. I thought we had
agreed to add a respective remark?

> Rule 5.6 has been deemed a good rule to have by the MISRA C group.
> However, we do have a significant amount of violations that will take
> time to resolve and might require partial deviations in the form of
> in-code comments or MISRA C scanners special configurations (ECLAIR).
> For new code, we want this rule to apply hence the addition to
> docs/misra/rules.rst.

May I ask to insert "generally" ahead of "apply". As mentioned I can
see it becoming necessary to add such in new code, then right away
with deviation and suitably justified.

Jan
diff mbox series

Patch

diff --git a/docs/misra/rules.rst b/docs/misra/rules.rst
index 29a777938a..9406ff0d8f 100644
--- a/docs/misra/rules.rst
+++ b/docs/misra/rules.rst
@@ -82,6 +82,13 @@  maintainers if you want to suggest a change.
      - Summary
      - Notes
 
+   * - `Rule 1.1 <https://gitlab.com/MISRA/MISRA-C/MISRA-C-2012/Example-Suite/-/blob/master/R_01_01.c>`_
+     - Required
+     - The program shall contain no violations of the standard C syntax
+       and constraints, and shall not exceed the implementation's
+       translation limits
+     -
+
    * - `Rule 1.3 <https://gitlab.com/MISRA/MISRA-C/MISRA-C-2012/Example-Suite/-/blob/master/R_01_03.c>`_
      - Required
      - There shall be no occurrence of undefined or critical unspecified
@@ -156,6 +163,11 @@  maintainers if you want to suggest a change.
        headers (xen/include/public/) are allowed to retain longer
        identifiers for backward compatibility.
 
+   * - `Rule 5.6 <https://gitlab.com/MISRA/MISRA-C/MISRA-C-2012/Example-Suite/-/blob/master/R_05_06.c>`_
+     - Required
+     - A typedef name shall be a unique identifier
+     -
+
    * - `Rule 6.1 <https://gitlab.com/MISRA/MISRA-C/MISRA-C-2012/Example-Suite/-/blob/master/R_06_01.c>`_
      - Required
      - Bit-fields shall only be declared with an appropriate type