From mboxrd@z Thu Jan 1 00:00:00 1970 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 B22F3CD4F42 for ; Fri, 22 Sep 2023 09:38:00 +0000 (UTC) Received: from list by lists.xenproject.org with outflank-mailman.606805.944842 (Exim 4.92) (envelope-from ) id 1qjcbX-0005U1-4k; Fri, 22 Sep 2023 09:37:43 +0000 X-Outflank-Mailman: Message body and most headers restored to incoming version Received: by outflank-mailman (output) from mailman id 606805.944842; Fri, 22 Sep 2023 09:37:43 +0000 Received: from localhost ([127.0.0.1] helo=lists.xenproject.org) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1qjcbX-0005Tu-22; Fri, 22 Sep 2023 09:37:43 +0000 Received: by outflank-mailman (input) for mailman id 606805; Fri, 22 Sep 2023 09:37:42 +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 1qjcbW-0005To-Hd for xen-devel@lists.xenproject.org; Fri, 22 Sep 2023 09:37:42 +0000 Received: from support.bugseng.com (mail.bugseng.com [162.55.131.47]) by se1-gles-sth1.inumbo.com (Halon) with ESMTPS id acd5af32-592b-11ee-878a-cb3800f73035; Fri, 22 Sep 2023 11:37:41 +0200 (CEST) Received: from support.bugseng.com (support.bugseng.com [162.55.131.47]) by support.bugseng.com (Postfix) with ESMTPA id CEBD94EE0739; Fri, 22 Sep 2023 11:37:40 +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: acd5af32-592b-11ee-878a-cb3800f73035 MIME-Version: 1.0 Date: Fri, 22 Sep 2023 11:37:40 +0200 From: Nicola Vetrini To: Stefano Stabellini Cc: xen-devel@lists.xenproject.org, michal.orzel@amd.com, xenia.ragiadakou@amd.com, ayan.kumar.halder@amd.com, consulting@bugseng.com, Andrew Cooper , George Dunlap , Jan Beulich , Julien Grall , Wei Liu Subject: Re: [XEN PATCH 1/3] docs/misra: add documentation skeleton for MISRA C:2012 Dir 4.1 In-Reply-To: References: User-Agent: Roundcube Webmail/1.4.3 Message-ID: X-Sender: nicola.vetrini@bugseng.com Organization: BUGSENG s.r.l. Content-Type: text/plain; charset=US-ASCII; format=flowed Content-Transfer-Encoding: 7bit >> +Documentation for MISRA C:2012 Dir 4.1: invariant violation >> +___________________________________________________________ >> + >> +To be written. > > What's an invariant violation? > > It's the violation of a project invariant (e.g., an assert or BUILD_BUG). Something along the lines of this could fit in the documentation: "The extensive checks in the code ensure that any violation of a compile-time invariant will be detected in prior to release builds, and failure of run-time invariant is also extensively tested." -- Nicola Vetrini, BSc Software Engineer, BUGSENG srl (https://bugseng.com)