From patchwork Fri Sep 1 09:06:37 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Nicola Vetrini X-Patchwork-Id: 13372271 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 C1ED2CA0FE6 for ; Fri, 1 Sep 2023 09:07:17 +0000 (UTC) Received: from list by lists.xenproject.org with outflank-mailman.594511.927852 (Exim 4.92) (envelope-from ) id 1qc07E-00036A-Kx; Fri, 01 Sep 2023 09:06:56 +0000 X-Outflank-Mailman: Message body and most headers restored to incoming version Received: by outflank-mailman (output) from mailman id 594511.927852; Fri, 01 Sep 2023 09:06:56 +0000 Received: from localhost ([127.0.0.1] helo=lists.xenproject.org) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1qc07E-000363-GS; Fri, 01 Sep 2023 09:06:56 +0000 Received: by outflank-mailman (input) for mailman id 594511; Fri, 01 Sep 2023 09:06:55 +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 1qc07D-00035h-1a for xen-devel@lists.xenproject.org; Fri, 01 Sep 2023 09:06:55 +0000 Received: from support.bugseng.com (mail.bugseng.com [162.55.131.47]) by se1-gles-flk1.inumbo.com (Halon) with ESMTPS id e423a147-48a6-11ee-9b0d-b553b5be7939; Fri, 01 Sep 2023 11:06:52 +0200 (CEST) Received: from nico.bugseng.com (unknown [147.123.100.131]) by support.bugseng.com (Postfix) with ESMTPSA id 463C04EE0737; Fri, 1 Sep 2023 11:06:51 +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: e423a147-48a6-11ee-9b0d-b553b5be7939 From: Nicola Vetrini To: xen-devel@lists.xenproject.org Cc: sstabellini@kernel.org, michal.orzel@amd.com, xenia.ragiadakou@amd.com, ayan.kumar.halder@amd.com, consulting@bugseng.com, Nicola Vetrini , Andrew Cooper , George Dunlap , Jan Beulich , Julien Grall , Wei Liu , Anthony PERARD , Simone Ballarin , Doug Goldstein Subject: [XEN PATCH 0/3] docs/misra: add documentation skeleton to address MISRA C:2012 Dir 4.1 Date: Fri, 1 Sep 2023 11:06:37 +0200 Message-Id: X-Mailer: git-send-email 2.34.1 MIME-Version: 1.0 The headline of Directive 4.1 states: "Run-time failures shall be minimized". Thus, it requires the project to supply documentation that pertains the measures and techinques used to prevent run-time failures from happening. For ease of reading, the documentation is in RST format, but since ECLAIR needs a source file to check that the needed subsections and their format is the one expected, the Makefiles for the docs/ are amended to generate such a file. The format and categories of the subsections in the .rst file can be customized based on feedback from the community: the one provided is just a basic skeleton that should be tailored to the project. This series is based on the following RFC: https://lore.kernel.org/xen-devel/cover.1692636338.git.nicola.vetrini@bugseng.com/ Nicola Vetrini (3): docs/misra: add documentation skeleton for MISRA C:2012 Dir 4.1 docs: make the docs for MISRA C:2012 Dir 4.1 visible to ECLAIR automation/eclair: build docs/misra to address MISRA C:2012 Dir 4.1 automation/eclair_analysis/build.sh | 11 +- automation/eclair_analysis/prepare.sh | 5 +- docs/Makefile | 7 +- docs/misra/C-runtime-failures.rst | 239 ++++++++++++++++++++++++++ docs/misra/Makefile | 17 ++ docs/misra/rules.rst | 7 +- 6 files changed, 279 insertions(+), 7 deletions(-) create mode 100644 docs/misra/C-runtime-failures.rst create mode 100644 docs/misra/Makefile --- 2.34.1