[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: SAF-x-safe rename
- To: Stefano Stabellini <sstabellini@xxxxxxxxxx>
- From: Luca Fancellu <Luca.Fancellu@xxxxxxx>
- Date: Thu, 5 Oct 2023 07:43:51 +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=MDyAJYxtKytiblXKoG464QgdaCKUcx0b2MM6mQniOAE=; b=JKNQZo09EcvavQWWKfNlAQBO2qxhjBOYpDdm2zmwjlCgWFSwF8HI4oI1Cllus3rFk1aV+/q3sGcEFBW6vArzMyTBCBXuadOTEphhzheq8/4w5f0evBJ6tqS1wj6auYsIitKQiE1J61iH4yYrCyOdBih5VUIyg0A3hM9dGlGwYajbOESjoOGCzaarpAe/LSYx8KG+i6VHfq2TNEbzEutUHR6X2NEyVOW5anlJtUXBfI9o6W84kBbPANGPSKl2ZPABdtDrb77QWXrIb5NZ781L0/1sCi7EMNj2oU9gwEgoGzeQXvgs5sWW69BIyFC+mW5JajmMmPkQ4beUJmPcl1/UAQ==
- Arc-seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=Iw+aGVnr6imFOMbRA+27bKVsW+EC0VMudSDxvvJf98xv4tb/DMlQQn/bOWU/ot1o9OLaLOfxEaLWcfiMyyREVgweigKQ9fOqYO8fXt5ck4P+4+wh6AlNxXE83TeU5Mj6wLbWmRjvHW1YvQfuzFsYIQYhOLk4UYGha/lwfsETi+nbNQdKpVzOXWmXkNDXm5lOHZFjamV+QI5J/m1zUesLHarNM+Ma6BbIhuDzuLNOIjmJogNLBN8Qoq7HLu821v6hSw0hYdiagYpoJjC0NRgCYHa5G52SBFz++bC0KxduLb7CoEHam7Z3YtDsOJ205yYdj32SmexPHVrjmgL40jewGQ==
- Authentication-results-original: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=arm.com;
- Cc: Jan Beulich <jbeulich@xxxxxxxx>, Roger Pau Monné <roger.pau@xxxxxxxxxx>, "andrew.cooper3@xxxxxxxxxx" <andrew.cooper3@xxxxxxxxxx>, Bertrand Marquis <Bertrand.Marquis@xxxxxxx>, "julien@xxxxxxx" <julien@xxxxxxx>, "george.dunlap@xxxxxxxxxx" <george.dunlap@xxxxxxxxxx>, "xen-devel@xxxxxxxxxxxxxxxxxxxx" <xen-devel@xxxxxxxxxxxxxxxxxxxx>
- Delivery-date: Thu, 05 Oct 2023 07:44:52 +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: AQHZ9x0f2i/5rB9iCkSEJyJjGzwZKrA60RYA
- Thread-topic: SAF-x-safe rename
> On 5 Oct 2023, at 00:46, Stefano Stabellini <sstabellini@xxxxxxxxxx> wrote:
>
> Hi MISRA C working group (Jan, Roger, Andrew, Julien, Bertrand, George)
>
> in a recent thread Andrew pointed out that the SAF-2-safe tag is
> confusing and requested a rename:
> https://marc.info/?l=xen-devel&m=169634970821202
>
> As documented by docs/misra/documenting-violations.rst:
>
> - SAF-X-safe: This tag means that the next line of code contains a finding,
> but
> the non compliance to the checker is analysed and demonstrated to be safe.
> - SAF-X-false-positive-<tool>: This tag means that the next line of code
> contains a finding, but the finding is a bug of the tool.
>
>
> Today we have already 28 instances of SAF tags in the Xen codebase.
>
>
> Andrew suggested "ANALYSIS" instead of SAF so I would imagine:
> - ANALYSIS-X-safe
> - ANALYSIS-X-false-positive-<tool>
>
> If we really want a rename I suggest to rename SAF to SAFE:
> - SAFE-X-safe
> - SAFE-X-false-positive-<tool>
>
> Or maybe MISRA:
> - MISRA-X-safe
> - MISRA-X-false-positive-<tool>
>
> But I actually prefer to keep the tag as it is today.
We chose a generic name instead of MISRA because the tag can potentially
suppress findings
of any checker, including MISRA checker.
If SAF-* is confusing, what about FUSA-* ?
Anyway I’m thinking that every name we could come up will be confusing at
first, improving the
documentation would mitigate it (by improving I mean to improve the fruition of
it, for example a
Read the docs documentation has the search bar, a quick copy paste of SAF-
would make the
documenting-violations page visible.)
>
>
> If you have any naming suggestions please let me know by Oct 11. After
> that, I plan to run a Doodle poll to check the preference of the group.
>
> Cheers,
>
> Stefano
>
|