docs/misra: rules: Remove incorrect deviation guidance
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
@@ -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
Quoted 9 lines · Michal Orzel
It creates confusion since the new format of documenting violations can be found in:
docs/misra/documenting-violations.rst.Signed-off-by Michal Orzel <[email protected]>---
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@@ -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.rstOther documentation mechanisms are work-in-progress.
Stefano Stabellini
Reviewed-byQuoted 11 lines · Luca Fancellu
Quoted 7 lines · Michal Orzel
It creates confusion since the new format of documenting violations can be found in:
docs/misra/documenting-violations.rst.Signed-off-by Michal Orzel <[email protected]>---
Wow we missed that! Thanks!
Reviewed-by Luca Fancellu <[email protected]>