From patchwork Fri Jul 21 00:23:22 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Stefano Stabellini X-Patchwork-Id: 13321199 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 864E2EB64DA for ; Fri, 21 Jul 2023 00:24:01 +0000 (UTC) Received: from list by lists.xenproject.org with outflank-mailman.566811.886165 (Exim 4.92) (envelope-from ) id 1qMdvf-0000TI-EA; Fri, 21 Jul 2023 00:23:31 +0000 X-Outflank-Mailman: Message body and most headers restored to incoming version Received: by outflank-mailman (output) from mailman id 566811.886165; Fri, 21 Jul 2023 00:23:31 +0000 Received: from localhost ([127.0.0.1] helo=lists.xenproject.org) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1qMdvf-0000TB-BK; Fri, 21 Jul 2023 00:23:31 +0000 Received: by outflank-mailman (input) for mailman id 566811; Fri, 21 Jul 2023 00:23:31 +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 1qMdvf-0000T5-0i for xen-devel@lists.xenproject.org; Fri, 21 Jul 2023 00:23:31 +0000 Received: from dfw.source.kernel.org (dfw.source.kernel.org [139.178.84.217]) by se1-gles-flk1.inumbo.com (Halon) with ESMTPS id cffe5a7b-275c-11ee-8611-37d641c3527e; Fri, 21 Jul 2023 02:23:28 +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 257A061CB8; Fri, 21 Jul 2023 00:23:27 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id 59A43C433C7; Fri, 21 Jul 2023 00:23:25 +0000 (UTC) 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: cffe5a7b-275c-11ee-8611-37d641c3527e DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1689899006; bh=e9pw3Wu++8sH3JJUIceGQdL1jV8FwV7ikMwnMDXbwIo=; h=From:To:Cc:Subject:Date:From; b=n9HrwVa9dgis9Bg/e/YgzidA3tpx6Za3vKsxNqBVHi5ubQJQaaOigcpICQF2gIRXf cZRz+o7udTeiTwIQp/HXLlS+hUpLG/6pd3U29lbsRXjKNX9bmhm8eEJvW+sDIaLnvG efgscAdphnDGa4svwJO0p4Htyw7uXMw3M4wGWKoky4BMZSgGAv8sCUjCuHy4HICjDh dYFEEdPqpt7xAfgR2rJnXTpmLKTe5hU+ZM+Owbsa9XSp+1vpM2l2w6ZpO+EmDwPl8o VcZiXxFSIJSVCCS8rPdIK3YSNJ7tyn3KJ3qnasjbo91CZBBJm11GHEKghFnIq5HVna iPUgAz+YSqEXw== 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] docs/misra: add Rule 1.1 and 5.6 Date: Thu, 20 Jul 2023 17:23:22 -0700 Message-Id: <20230721002322.3457802-1-sstabellini@kernel.org> X-Mailer: git-send-email 2.25.1 MIME-Version: 1.0 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 apply hence the addition to docs/misra/rules.rst. Signed-off-by: Stefano Stabellini --- docs/misra/rules.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/misra/rules.rst b/docs/misra/rules.rst index 29a777938a..9406ff0d8f 100644 --- a/docs/misra/rules.rst +++ b/docs/misra/rules.rst @@ -82,6 +82,13 @@ maintainers if you want to suggest a change. - Summary - Notes + * - `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 + - + * - `Rule 1.3 `_ - Required - There shall be no occurrence of undefined or critical unspecified @@ -156,6 +163,11 @@ maintainers if you want to suggest a change. headers (xen/include/public/) are allowed to retain longer identifiers for backward compatibility. + * - `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