Skip to contentSkip to conversation

docs/misra: rules: Remove incorrect deviation guidance

PATCH In review Michal Orzel 3 participants 3 messages Jun 28, 2023

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 docs/misra: rules: Remove incorrect deviation guidance

It creates confusion since the new format of documenting violations can be found in: docs/misra/documenting-violations.rst.

---
 docs/misra/rules.rst | 9 ++-------
 1 file changed, 2 insertions(+), 7 deletions(-)
docs/misra/rules.rst +2 -7
index 11b9c42b70e6..6244598665e2 100644
@@ -17,13 +17,8 @@ hypervisor.
 It is possible that in specific circumstances it is best not to follow a
 rule because it is not possible or because the alternative leads to
 better code quality. Those cases are called "deviations". They are
-permissible as long as they are documented as an in-code comment using
-the following format::
-
-    /*
-     * MISRA_DEV: Rule ID
-     * Justification text.
-     */
+permissible as long as they are documented. For details, please refer to
+docs/misra/documenting-violations.rst
 
 Other documentation mechanisms are work-in-progress.
 
Signature · 1 line
2.25.1
Reviewed-by on v1 1/1
#1 lore raw
Quoted 9 lines · Michal Orzel

It creates confusion since the new format of documenting violations can be found in: docs/misra/documenting-violations.rst.

---

Wow we missed that! Thanks!

Quoted 23 lines

docs/misra/rules.rst | 9 ++-------

1 file changed, 2 insertions(+), 7 deletions(-)
docs/misra/rules.rst +0 -0
index 11b9c42b70e6..6244598665e2 100644
@@ -17,13 +17,8 @@ hypervisor.

It is possible that in specific circumstances it is best not to follow a rule because it is not possible or because the alternative leads to better code quality. Those cases are called "deviations". They are

docs/misra/rules.rst +2 -7
-permissible as long as they are documented as an in-code comment using
-the following format::
-
-    /*
-     * MISRA_DEV: Rule ID
-     * Justification text.
-     */
+permissible as long as they are documented. For details, please refer to
+docs/misra/documenting-violations.rst

Other documentation mechanisms are work-in-progress.