From nobody Thu May 16 08:36:19 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of lists.xenproject.org designates 192.237.175.120 as permitted sender) client-ip=192.237.175.120; envelope-from=xen-devel-bounces@lists.xenproject.org; helo=lists.xenproject.org; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of lists.xenproject.org designates 192.237.175.120 as permitted sender) smtp.mailfrom=xen-devel-bounces@lists.xenproject.org; dmarc=pass(p=none dis=none) header.from=kernel.org ARC-Seal: i=1; a=rsa-sha256; t=1689977833; cv=none; d=zohomail.com; s=zohoarc; b=ebgwhTBVDzWTxJYpeEYRlI4yTgiJWZa/jMi4guuRurzxkRUSGVE5OB+mL6ZfVke/WGHdaGLfjsAtpRR4IDMBB2mDmpwPykMSFbv3xfkthC06tBLKCI6deasPMJy550ctLb3Dd19rQ/9eZq38yHOpPn4gqYXYuN6G1wCuKFaPRyA= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1689977833; h=Content-Transfer-Encoding:Cc:Date:From:List-Subscribe:List-Post:List-Id:List-Help:List-Unsubscribe:MIME-Version:Message-ID:Sender:Subject:To; bh=oDrfU33HmYFYJpKzsulPJuOdSq3P1Zi9zDGOPtPcyP8=; b=lUtQ4woLnzCvwK97z6yEpAJjdV8nyPciORz1esg2kzygxssdfeHpbaRGrX/eHM2nXAA/bh4Lw93LNSyiYLwUwz+NMpLKGc3Q+wChUh4sUkh7IOVWLpWHPUik0MVJoV7YOkkj3mmueqatitrFokCebbENZXJ+229X+juEBG8btew= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of lists.xenproject.org designates 192.237.175.120 as permitted sender) smtp.mailfrom=xen-devel-bounces@lists.xenproject.org; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from lists.xenproject.org (lists.xenproject.org [192.237.175.120]) by mx.zohomail.com with SMTPS id 1689977833049460.87942431318083; Fri, 21 Jul 2023 15:17:13 -0700 (PDT) Received: from list by lists.xenproject.org with outflank-mailman.567716.887125 (Exim 4.92) (envelope-from ) id 1qMyQX-0006P6-Rc; Fri, 21 Jul 2023 22:16:45 +0000 Received: by outflank-mailman (output) from mailman id 567716.887125; Fri, 21 Jul 2023 22:16:45 +0000 Received: from localhost ([127.0.0.1] helo=lists.xenproject.org) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1qMyQX-0006Oz-Oy; Fri, 21 Jul 2023 22:16:45 +0000 Received: by outflank-mailman (input) for mailman id 567716; Fri, 21 Jul 2023 22:16:44 +0000 Received: from se1-gles-sth1-in.inumbo.com ([159.253.27.254] helo=se1-gles-sth1.inumbo.com) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1qMyQW-0006Ot-4W for xen-devel@lists.xenproject.org; Fri, 21 Jul 2023 22:16:44 +0000 Received: from dfw.source.kernel.org (dfw.source.kernel.org [139.178.84.217]) by se1-gles-sth1.inumbo.com (Halon) with ESMTPS id 44fdcbc5-2814-11ee-b23a-6b7b168915f2; Sat, 22 Jul 2023 00:16:42 +0200 (CEST) Received: from smtp.kernel.org (relay.kernel.org [52.25.139.140]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by dfw.source.kernel.org (Postfix) with ESMTPS id 5871561D2F; Fri, 21 Jul 2023 22:16:41 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id 97F52C433C8; Fri, 21 Jul 2023 22:16:39 +0000 (UTC) X-Outflank-Mailman: Message body and most headers restored to incoming version 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: 44fdcbc5-2814-11ee-b23a-6b7b168915f2 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1689977800; bh=UU/KNHtJWPOE4DwMSvwfMbjpQ3D4sVoEwSzL4QdF4O0=; h=From:To:Cc:Subject:Date:From; b=QJ8Z5plGK9/iRi+qC+XLcZzsNYggCRA3XAY3RKZYgKk4xzMntN3VTDVl4wv7j5CYq vA2OO2R1tPaUeRr99IQiKJv1hH5CwnryWqOkmyOPlsk0JUzTrACDLlvsm3u19RJ+HN UaobQwj6jZMEnbCV0QdKacWCdJ1GBdiwEp2u8MQrTJTr8x1v6SvmN7YyrZKrwDuAk+ Q7ynOXOzFUwleQHct52lPPY4CT888bbdcsY6wxo2JcD9rsnBbX4I2ZFl7nYDzm6sVx YKsp4uyr8+2Ee2EQvnBAYUFAn0tnyHYbhtmThDzh+Gm/R7e0328uo9l6wWcb1XafAC vm59BRcYmbfug== From: Stefano Stabellini To: xen-devel@lists.xenproject.org Cc: jbeulich@suse.com, andrew.cooper3@citrix.com, roger.pau@citrix.com, julien@xen.org, sstabellini@kernel.org, george.dunlap@citrix.com, bertrand.marquis@arm.com, Stefano Stabellini Subject: [PATCH v2] docs/misra: add Rule 1.1 and 5.6 Date: Fri, 21 Jul 2023 15:16:36 -0700 Message-Id: <20230721221636.3693746-1-sstabellini@kernel.org> X-Mailer: git-send-email 2.25.1 MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @kernel.org) X-ZM-MESSAGEID: 1689977835117100001 Content-Type: text/plain; charset="utf-8" From: Stefano Stabellini Rule 1.1 is uncontroversial and we are already following it. Rule 5.6 has been deemed a good rule to have by the MISRA C group. However, we do have a significant amount of violations that will take time to resolve and might require partial deviations in the form of in-code comments or MISRA C scanners special configurations (ECLAIR). For new code, we want this rule to generally apply hence the addition to docs/misra/rules.rst. Signed-off-by: Stefano Stabellini Acked-by: Jan Beulich --- Changes in v2: - add a note about compiler extensions to Rule 1.1 - add "generally" in the commit message --- docs/misra/rules.rst | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/misra/rules.rst b/docs/misra/rules.rst index 29a777938a..8f0e4d3f25 100644 --- a/docs/misra/rules.rst +++ b/docs/misra/rules.rst @@ -82,6 +82,14 @@ maintainers if you want to suggest a change. - Summary - Notes =20 + * - `Rule 1.1 `_ + - Required + - The program shall contain no violations of the standard C syntax + and constraints, and shall not exceed the implementation's + translation limits + - We make use of several compiler extensions as documented by + `C-language-toolchain.rst `_ + * - `Rule 1.3 `_ - Required - There shall be no occurrence of undefined or critical unspecified @@ -156,6 +164,11 @@ maintainers if you want to suggest a change. headers (xen/include/public/) are allowed to retain longer identifiers for backward compatibility. =20 + * - `Rule 5.6 `_ + - Required + - A typedef name shall be a unique identifier + - + * - `Rule 6.1 `_ - Required - Bit-fields shall only be declared with an appropriate type --=20 2.25.1