[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[xen master] docs/misra: rules: Remove incorrect deviation guidance



commit 160975b89866d42912c2a83141c7fa0f6bf8d8ba
Author:     Michal Orzel <michal.orzel@xxxxxxx>
AuthorDate: Wed Jun 28 10:37:01 2023 +0200
Commit:     Stefano Stabellini <stefano.stabellini@xxxxxxx>
CommitDate: Thu Jun 29 12:07:30 2023 -0700

    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.
    
    Signed-off-by: Michal Orzel <michal.orzel@xxxxxxx>
    Reviewed-by: Luca Fancellu <luca.fancellu@xxxxxxx>
    Reviewed-by: Stefano Stabellini <sstabellini@xxxxxxxxxx>
---
 docs/misra/rules.rst | 9 ++-------
 1 file changed, 2 insertions(+), 7 deletions(-)

diff --git a/docs/misra/rules.rst b/docs/misra/rules.rst
index 9caf43968c..622f35410c 100644
--- a/docs/misra/rules.rst
+++ b/docs/misra/rules.rst
@@ -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.
 
--
generated by git-patchbot for /home/xen/git/xen.git#master



 


Rackspace

Lists.xenproject.org is hosted with RackSpace, monitoring our
servers 24x7x365 and backed by RackSpace's Fanatical Support®.