From patchwork Tue Nov 14 15:36:48 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Nicola Vetrini X-Patchwork-Id: 13455551 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 30D3FC4332F for ; Tue, 14 Nov 2023 15:37:12 +0000 (UTC) Received: from list by lists.xenproject.org with outflank-mailman.632830.987306 (Exim 4.92) (envelope-from ) id 1r2vTJ-0004cb-CI; Tue, 14 Nov 2023 15:37:01 +0000 X-Outflank-Mailman: Message body and most headers restored to incoming version Received: by outflank-mailman (output) from mailman id 632830.987306; Tue, 14 Nov 2023 15:37:01 +0000 Received: from localhost ([127.0.0.1] helo=lists.xenproject.org) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1r2vTJ-0004cR-8K; Tue, 14 Nov 2023 15:37:01 +0000 Received: by outflank-mailman (input) for mailman id 632830; Tue, 14 Nov 2023 15:37:00 +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 1r2vTH-0004Ze-VR for xen-devel@lists.xenproject.org; Tue, 14 Nov 2023 15:36:59 +0000 Received: from support.bugseng.com (mail.bugseng.com [162.55.131.47]) by se1-gles-flk1.inumbo.com (Halon) with ESMTPS id a55fa335-8303-11ee-9b0e-b553b5be7939; Tue, 14 Nov 2023 16:36:58 +0100 (CET) Received: from nico.bugseng.com (unknown [147.123.100.131]) by support.bugseng.com (Postfix) with ESMTPSA id 13EC64EE0747; Tue, 14 Nov 2023 16:36:55 +0100 (CET) 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: a55fa335-8303-11ee-9b0e-b553b5be7939 From: Nicola Vetrini To: nicola.vetrini@bugseng.com, 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, jbeulich@suse.com, andrew.cooper3@citrix.com, roger.pau@citrix.com, bertrand.marquis@arm.com, julien@xen.org, George Dunlap , Wei Liu Subject: [XEN PATCH v4 2/2] docs/misra: add guidance on the format of Dir 4.1 docs for ECLAIR Date: Tue, 14 Nov 2023 16:36:48 +0100 Message-Id: X-Mailer: git-send-email 2.34.1 In-Reply-To: References: MIME-Version: 1.0 Additional guidance on the formatting of the document for ECLAIR is supplied. Signed-off-by: Nicola Vetrini Reviewed-by: Stefano Stabellini Acked-by: Julien Grall --- docs/misra/C-runtime-failures.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/misra/C-runtime-failures.rst b/docs/misra/C-runtime-failures.rst index 1052b2afca13..cac51d6b2596 100644 --- a/docs/misra/C-runtime-failures.rst +++ b/docs/misra/C-runtime-failures.rst @@ -12,6 +12,14 @@ built-in checks that are present in the language. The presence of such documentation is requested by MISRA C:2012 Directive 4.1, whose headline states: "Run-time failures shall be minimized". +The ECLAIR checker for MISRA C:2012 Directive 4.1 requires the documentation +to be supplied using the following format: + +``Documentation for MISRA C:2012 Dir 4.1: `` + +The matched categories are the ones listed below (e.g., ``overflow`` and +``unexpected wrapping``). The content of the description is not checked and can +span multiple lines. Documentation for MISRA C:2012 Dir 4.1: overflow ________________________________________________