From patchwork Mon Aug 28 13:19:58 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Simone Ballarin X-Patchwork-Id: 13368039 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from lists.xenproject.org (lists.xenproject.org [192.237.175.120]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 6D57CC83F12 for ; Mon, 28 Aug 2023 14:45:27 +0000 (UTC) Received: from list by lists.xenproject.org with outflank-mailman.591532.924030 (Exim 4.92) (envelope-from ) id 1qadUM-00011n-3u; Mon, 28 Aug 2023 14:45:10 +0000 X-Outflank-Mailman: Message body and most headers restored to incoming version Received: by outflank-mailman (output) from mailman id 591532.924030; Mon, 28 Aug 2023 14:45:10 +0000 Received: from localhost ([127.0.0.1] helo=lists.xenproject.org) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1qadUM-00011g-1O; Mon, 28 Aug 2023 14:45:10 +0000 Received: by outflank-mailman (input) for mailman id 591532; Mon, 28 Aug 2023 13:36:30 +0000 Received: from se1-gles-flk1-in.inumbo.com ([94.247.172.50] helo=se1-gles-flk1.inumbo.com) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1qacPu-0004gK-UA for xen-devel@lists.xenproject.org; Mon, 28 Aug 2023 13:36:30 +0000 Received: from support.bugseng.com (mail.bugseng.com [162.55.131.47]) by se1-gles-flk1.inumbo.com (Halon) with ESMTPS id a7ca1d81-45a5-11ee-9b0c-b553b5be7939; Mon, 28 Aug 2023 15:20:28 +0200 (CEST) Received: from beta.station (net-93-66-137-131.cust.vodafonedsl.it [93.66.137.131]) by support.bugseng.com (Postfix) with ESMTPSA id 943794EE073A; Mon, 28 Aug 2023 15:20:27 +0200 (CEST) X-BeenThere: xen-devel@lists.xenproject.org List-Id: Xen developer discussion List-Unsubscribe: , List-Post: List-Help: List-Subscribe: , Errors-To: xen-devel-bounces@lists.xenproject.org Precedence: list Sender: "Xen-devel" X-Inumbo-ID: a7ca1d81-45a5-11ee-9b0c-b553b5be7939 From: Simone Ballarin To: xen-devel@lists.xenproject.org Cc: consulting@bugseng.com, sstabellini@kernel.org, Simone Ballarin , Doug Goldstein , Andrew Cooper , George Dunlap , Jan Beulich , Julien Grall , Wei Liu Subject: [XEN PATCH 01/13] misra: add deviation for headers that explicitly avoid guards Date: Mon, 28 Aug 2023 15:19:58 +0200 Message-Id: <9b8165105c28f8e684844f56814726498e34c46e.1693228255.git.simone.ballarin@bugseng.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: References: MIME-Version: 1.0 Some headers, under specific circumstances (documented in a comment at the beginning of the file), explicitly avoid inclusion guards: the caller is responsible for including them correctly. These files are not supposed to comply with Directive 4.10: "Precautions shall be taken in order to prevent the contents of a header file being included more than once" This patch adds a deviation for all headers that contain the following in a comment text: "In this case, no inclusion guards apply and the caller is responsible" Signed-off-by: Simone Ballarin Acked-by: Stefano Stabellini --- automation/eclair_analysis/ECLAIR/deviations.ecl | 4 ++++ docs/misra/rules.rst | 3 ++- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/automation/eclair_analysis/ECLAIR/deviations.ecl b/automation/eclair_analysis/ECLAIR/deviations.ecl index d8170106b4..5f068377fa 100644 --- a/automation/eclair_analysis/ECLAIR/deviations.ecl +++ b/automation/eclair_analysis/ECLAIR/deviations.ecl @@ -91,6 +91,10 @@ conform to the directive." -config=MC3R1.D4.10,reports+={safe, "first_area(text(^/\\* Generated file, do not edit! \\*/$, begin-3))"} -doc_end +-doc_begin="Some headers, under specific circumstances, explicitly avoid inclusion guards." +-config=MC3R1.D4.10,reports+={safe, "first_area(text(^ \\* In this case, no inclusion guards apply and the caller is responsible.*\\*/$, begin-1))"} +-doc_end + # # Series 5. # diff --git a/docs/misra/rules.rst b/docs/misra/rules.rst index db30632b93..4b1a7b02b6 100644 --- a/docs/misra/rules.rst +++ b/docs/misra/rules.rst @@ -60,7 +60,8 @@ maintainers if you want to suggest a change. - Precautions shall be taken in order to prevent the contents of a header file being included more than once - Files that are intended to be included more than once do not need to - conform to the directive + conform to the directive. Files that explicitly avoid inclusion guards + under specific circumstances do not need to conform the directive. * - `Dir 4.11 `_ - Required