[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH 1/2] docs/misra: introduce rules.rst
- To: Jan Beulich <jbeulich@xxxxxxxx>
- From: Bertrand Marquis <Bertrand.Marquis@xxxxxxx>
- Date: Thu, 26 May 2022 09:54:49 +0000
- Accept-language: en-GB, en-US
- Arc-authentication-results: i=2; mx.microsoft.com 1; spf=pass (sender ip is 63.35.35.123) smtp.rcpttodomain=lists.xenproject.org smtp.mailfrom=arm.com; dmarc=pass (p=none sp=none pct=100) action=none header.from=arm.com; dkim=pass (signature was verified) header.d=armh.onmicrosoft.com; arc=pass (0 oda=1 ltdi=1 spf=[1,1,smtp.mailfrom=arm.com] dkim=[1,1,header.d=arm.com] dmarc=[1,1,header.from=arm.com])
- 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=2; 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=vk+Xz2ZDOYww1LHn7f8Zc2Tquf5nZ/LkVCi1pMSo9QA=; b=B/ZODfXYO8WKyeQ8EgnMCoqIOYY3RSrheryrW3XzC35r/rQiiDU0ovntPF/GR30B6btliPShvDUmhkGBGCMz5S7XoeiiWzJUvXxZhYGuIbq9NbMIYFZcf1VSWE/XlA33YtPX5Y64AtTx8VfDBgGCuEYHNhpdenayLrq0iTRoZfPkfAydGASxJRveiYyRG1EimTwAhXOfu4LJbztaqVQhz7T5rXBLrnB6vTMuUW3KZHjyEstqsBy0P3Z7HEnNB7EJ8j/d9Bc9OskxUmUju0lZu+lVvRBj4VOArPV/jhPk/4WtpUMi0EkTJvUSSJUj11AR6nPwDXpha7amR6jkPdu4NQ==
- 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=vk+Xz2ZDOYww1LHn7f8Zc2Tquf5nZ/LkVCi1pMSo9QA=; b=MmF84hpXWL1M1qVy+0lGNhkJt35xF+acP+IU1wTMdBmaqN2cfbnlGcMV+EUCzAw/URyeSFmAb/EfEaM9/uMC8Fea740zEAWEhMR3r5z8uqoymbaTcPLK5GEa+0YPO+rWcbAb+T7bHOOuGSZw0azBHvlneyyZ2p/DkXYcNfPXGKP91jRmKwYRHJtR3qw2o0QWR/8rUFJAA+Xj6PgDWJWo0wiyijs4WtmRT7v0kGgmhppWCRJi7Kk4JzA3TnVn2lpWjYcGHcDudTAbqNkvdKWeYVahYWYLUR2LNElWR/6p9JvaUs4nxijYz3CxOj5b66AtOyQX/U1kEvQJmPeHahtuAg==
- Arc-seal: i=2; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=pass; b=UTnInzmY4CjohdmRkhTcoCmFBLUCnJe6sOji6cHEFXX4jVvnAH2tOz4JYMn/mRdQuXWxsaV/t7oN2g/pXXUI6Y2bI4g7r0sRUuhWhtx6xgL/AmLLpE836fSo2BRZQPxP+snO+LwC5MR4FBsrr8QDA/39TVxV2K2EpJi9vN1+GE0oy7A0VbE80MCwkhm9uEDnlIIBESKcNGpVtGpAHlvdAQpWyX1WqADv7i8Ih+fNxc0mcSdYKc9JEYa/2eHb8h/vYeG6scN36xea8wNPzuihsNcD7Gb685MNsQx4+ikfuQ7kp9oz2inLAnObzz+mNp7DqaY5kuQgNpPS9Xvoi23lXQ==
- Arc-seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=l3JTltLb9N0zSlCQ8UrlC6L1ljMJJ0lZ9RCdKv7idBRaUZO/ZfSkEPD6XMQ2dWFZXz6Sa2hvOAzksOZrd+5z6omzhcg2HMpLCK73Bxhca+mI3JFQsAt79v0NvCTsrLhGHASrOp9f3N39FetKC4O6j7VM+pxryzYywoV69KrBSRPAPsdHdx9N8B9gB06lG7h9ZUwfcyhZSynjjvoo7Ffec3wXxJZaTIqw+eSXmlJxBOhRe++eq2VoBrihrtblsJ8FZBXNJfnoq96lzwJyNCjJF26MWl/s3R7AbpOn42lH1iGXnRFzzFw4cbnIzrhVPfhiitypTx87bABCnB1ELafhLQ==
- Authentication-results-original: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=arm.com;
- Cc: Stefano Stabellini <sstabellini@xxxxxxxxxx>, "xen-devel@xxxxxxxxxxxxxxxxxxxx" <xen-devel@xxxxxxxxxxxxxxxxxxxx>, "andrew.cooper3@xxxxxxxxxx" <andrew.cooper3@xxxxxxxxxx>, "roger.pau@xxxxxxxxxx" <roger.pau@xxxxxxxxxx>, "George.Dunlap@xxxxxxxxxx" <George.Dunlap@xxxxxxxxxx>, Stefano Stabellini <stefano.stabellini@xxxxxxxxxx>, Julien Grall <julien@xxxxxxx>
- Delivery-date: Thu, 26 May 2022 09:55:10 +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: AQHYb89Ql1y5oYxB8EW1dQIiqL2u/a0vNXYAgAEjhQCAAJGbAIAAAxAA
- Thread-topic: [PATCH 1/2] docs/misra: introduce rules.rst
Hi Jan,
> On 26 May 2022, at 10:43, Jan Beulich <jbeulich@xxxxxxxx> wrote:
>
> On 26.05.2022 03:02, Stefano Stabellini wrote:
>> On Wed, 25 May 2022, Julien Grall wrote:
>>> On 25/05/2022 01:35, Stefano Stabellini wrote:
>>>> +- Rule: Dir 4.7
>>>> + - Severity: Required
>>>> + - Summary: If a function returns error information then that error
>>>> information shall be tested
>>>> + - Link:
>>>> https://gitlab.com/MISRA/MISRA-C/MISRA-C-2012/Example-Suite/-/blob/master/D_04_07.c
>>>
>>>
>>> ... this one. We are using (void) + a comment when the return is ignored on
>>> purpose. This is technically not-compliant with MISRA but the best we can do
>>> in some situation.
>>>
>>> With your proposed wording, we would technically have to remove them (or not
>>> introduce new one). So I think we need to document that we are allowing
>>> deviations so long they are commented.
>>
>> Absolutely yes. All of these rules can have deviations as long as they
>> make sense and they are commented. Note that we still have to work out
>> a good tagging system so that ECLAIR and cppcheck can recognize the
>> deviations automatically but for now saying that they need to be
>> commented is sufficient I think.
>>
>> So I'll add the following on top of the file:
>>
>> """
>> 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 with an in-code comment.
>> """
>
> Hmm, so you really mean in-code comments. I don't think this will scale
> well (see e.g. the DCE related intended deviation), and it also goes
> against the "no special casing for every static analysis tool" concern
> I did voice on the call.
On this subject the idea was more to define a “xen” way to document
deviations in the code and do it in a way so that we could easily substitute
the “flag” to adapt it for each analyser using tools or command line options.
Bertrand
>
> Jan
|
