[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH] docs/misra: rules: Remove incorrect deviation guidance
- To: <xen-devel@xxxxxxxxxxxxxxxxxxxx>
- From: Michal Orzel <michal.orzel@xxxxxxx>
- Date: Wed, 28 Jun 2023 10:37:01 +0200
- Arc-authentication-results: i=1; mx.microsoft.com 1; spf=pass (sender ip is 165.204.84.17) smtp.rcpttodomain=lists.xenproject.org smtp.mailfrom=amd.com; dmarc=pass (p=quarantine sp=quarantine pct=100) action=none header.from=amd.com; dkim=none (message not signed); arc=none
- Arc-message-signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=MAv1sXZBHR7pPNer3e1bTfvINX9ZNhIBLaSL2gGt88s=; b=mFeLtSCziXyPV4nYDal0oAPiVpBlNvpDD5i+asrIzzTFv9b0WhFDpI3jWmWqb59aFdBH0enXU0WgWm0OL283pubX1cJea0CPRLqieEeUFGPuMTqxJbnfjG87g7nQLhfUa8t8zU76SKIVyPYVxaXwWqydhMcK8zEh1p3EjibSBN0X0O0lmL3l+v+YGc/rtuyGC6NiXIny3zoWuTwWbdatZ29bWikE8GeUSjYXcJ7YJ1V7FtoVx0dnCbwDmUrGtZK0Iils9E2TCSc/lzFrhKsZX4pj+mkEoUXfxzQBB18mlDkrvwxcZ2WitbLIoHFbGSPZaTRvxT6ljQqKZoTN9aLl/A==
- Arc-seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=kZgt1ob4RSQ+hWP1uBK+YQUzf0exwGEafpcNBS0oNp60osuYzQo8hI2YRXDOTJVomG0TZqacc8j9uyexrdgGIro+lbaHg3gR2qvExDCTjcZ4JwqsvxgpzZGGNPsqP0fV1hGsApLUpz9LOkjyNAAA0PTRZVWGFU8imL39OPp1Yr/zz+D2vQ6RTKmGk0eMFq/ej9x/9wXkoPOkPJsndGNwO1J5TOnZj+w/ZCpSMXWJ1ZzcFXUwBZBxP8K0CaT9NIhGsI3+IRHHhwefigVPRpu31eZRUFq9s0YXe0agYB9z0BEnGX7uCgoX0cliF0Q8VEPghhLmuzAa4U5M5nj1isSp7Q==
- Cc: Michal Orzel <michal.orzel@xxxxxxx>, Andrew Cooper <andrew.cooper3@xxxxxxxxxx>, George Dunlap <george.dunlap@xxxxxxxxxx>, "Jan Beulich" <jbeulich@xxxxxxxx>, Julien Grall <julien@xxxxxxx>, "Stefano Stabellini" <sstabellini@xxxxxxxxxx>, Wei Liu <wl@xxxxxxx>
- Delivery-date: Wed, 28 Jun 2023 08:38:39 +0000
- List-id: Xen developer discussion <xen-devel.lists.xenproject.org>
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>
---
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 11b9c42b70e6..6244598665e2 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.
--
2.25.1
|
