[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH] docs/misra: rules: Remove incorrect deviation guidance
- To: Michal Orzel <michal.orzel@xxxxxxx>
- From: Luca Fancellu <Luca.Fancellu@xxxxxxx>
- Date: Wed, 28 Jun 2023 08:55:03 +0000
- Accept-language: en-GB, en-US
- Arc-authentication-results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=arm.com; dmarc=pass action=none header.from=arm.com; dkim=pass header.d=arm.com; 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=iQMPeHCQEzdChE4PGAl3hjPNfnVenvvJ2WYu4sj4Jkg=; b=cZ88MkIxLw1IrFgrK14CKSsuen+qRldfnfDylU4E+6qVpn5eAlflUTeExPB0uX1LfDNkMyauvk+4+ygnny/ZI0Wf4hkfbtxSh7a8QRAhF2u/69Sl8qYiyqK8YqaF9qMsqB0QiyWemVlDDtda3jkjrHIeaDqhK9xOItzcaOLG5A1Ojz2Bb7YSw/l4zdrUCvWIucsaSAkX5bqdX/zMENJ2L684+6wWYIkxnV6WRq5cyRrLgzVZl54l/ujiz1hfxY9y4c2aX8/+lufB2B/F5yv8xlrPbWXcpr+pOe6+V5H/IyRw8aW+H5XpVgYUP617RSlwpMMGuRivk1Y3AYPvVDQCiQ==
- Arc-seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=VFN+xN3BRDl4Zof4B8/8JvnxId3rl2A6S4a0aOwO0GNq2eaEIVZaIAcDn58nW5FTd04DpkAhVbg6qianZFOM1ZyEiilWw/ClhRhyEIHYNCBxl7E/+XqghwRIcErgekMbnZm9B77GL0VHLmJo9leCDc5X80aNSOrJMDkUonQf74xpqz6QPgz57PRdGdy34KYibAQNllA7UAv0G2g/0268hG7r5ZVGrna152eTLrjRvyRJ0Pgw9dR+OgD2W5nk5MO5ceL/aLJbN7vG9p7RIFK94p9FL7Bge1txmFtwxagWZTpUyaurz04ZqA8Q5NRey52iCc0Kj4LTSmQXUbNAY2lnUg==
- Authentication-results-original: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=arm.com;
- Cc: Xen-devel <xen-devel@xxxxxxxxxxxxxxxxxxxx>, 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:55:34 +0000
- List-id: Xen developer discussion <xen-devel.lists.xenproject.org>
- Nodisclaimer: true
- Original-authentication-results: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=arm.com;
- Thread-index: AQHZqZv9OVNjtLVRFU+PYttzx4+TS6+f6S8A
- Thread-topic: [PATCH] docs/misra: rules: Remove incorrect deviation guidance
> On 28 Jun 2023, at 09:37, Michal Orzel <michal.orzel@xxxxxxx> wrote:
>
> 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>
> ---
Wow we missed that! Thanks!
Reviewed-by: Luca Fancellu <luca.fancellu@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.
>
|
