[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [XEN PATCH v2 0/3] docs/misra: add documentation skeleton to address MISRA C:2012 Dir 4.1
- To: Nicola Vetrini <nicola.vetrini@xxxxxxxxxxx>
- From: Henry Wang <Henry.Wang@xxxxxxx>
- Date: Wed, 27 Sep 2023 09:57:36 +0000
- Accept-language: zh-CN, en-US
- Arc-authentication-results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=arm.com; dmarc=pass action=none header.from=arm.com; dkim=pass header.d=arm.com; arc=none
- Arc-message-signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=lHC7WZBYfbPZkcxCyvkYvjbnV1eVTuoXV0VksTsp78E=; b=mVhAKesaYoZIptyE7IMtdZA2LpWt6aryE7VZpqUnSbePIvPGtWwgURdGeff+i9sZ9pUllBW0ThtT9WYtxtLmNynm0rwGeUbtrTldQIwaDorlru2X55HwiWc3gWEe0Hce8tsyuZTtbtHgqHRlJjvjtXpasdJGV4DaiJwNJxaY4pTlwun2IBIr2MV24inv/WYNjrmXHlseFhyQITO+HLZfKTfDTa5ZkIYu6YWw7ytzXfB/eQGwf+aVfLo2CUD9ldIv4LguRaRlo9XtItd/YhuIgtHAQdb6Jm7pyVJF/N4CwcUOoxE5gDH0Qya6dIsA3RisWz7BHBAvSiX6tAGAHEvC7w==
- Arc-seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=crTHIcIMUnzRVd/8G0TGwK6Gdho9TjrMHgPS+Ckw8hE6LvxdTU7qUjPXLvW4BPQGg0qidyEiX+7gSOJ7X7e+/+c/joEDmv2mj7WAGFagUp0fwj6ooJV3bHOgBSv/ulR6EZrcmqhyXUXtPzSVgiUlmdr1pdDbtG8FIlTW7Q40ttBDjJwQjl3/GY7KV0MhvLmo7QXZEM190he6uK0DqazqGBI/zECHGA88Q4O8Dd8W7MmilZAeZWwlV/e2kSvgwgnwmuCnamdGM4CKuxYvnBx96xpKASqcFZ5QU4mHOypVhK3UeV3dReOAGp0jHkf6tJe8aL8kVM/Opm7PfFAz6KzGGQ==
- Authentication-results-original: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=arm.com;
- Cc: Xen-devel <xen-devel@xxxxxxxxxxxxxxxxxxxx>, Stefano Stabellini <sstabellini@xxxxxxxxxx>, Michal Orzel <michal.orzel@xxxxxxx>, "xenia.ragiadakou@xxxxxxx" <xenia.ragiadakou@xxxxxxx>, Ayan Kumar Halder <ayan.kumar.halder@xxxxxxx>, "consulting@xxxxxxxxxxx" <consulting@xxxxxxxxxxx>, Jan Beulich <jbeulich@xxxxxxxx>, Andrew Cooper <andrew.cooper3@xxxxxxxxxx>, "roger.pau@xxxxxxxxxx" <roger.pau@xxxxxxxxxx>, George Dunlap <george.dunlap@xxxxxxxxxx>, Julien Grall <julien@xxxxxxx>, Wei Liu <wl@xxxxxxx>, Anthony PERARD <anthony.perard@xxxxxxxxxx>, Simone Ballarin <simone.ballarin@xxxxxxxxxxx>, Doug Goldstein <cardoe@xxxxxxxxxx>
- Delivery-date: Wed, 27 Sep 2023 09:57:55 +0000
- List-id: Xen developer discussion <xen-devel.lists.xenproject.org>
- Nodisclaimer: true
- Original-authentication-results: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=arm.com;
- Thread-index: AQHZ8Shy2mMpVlpND0C+/CYXjLA/CrAub7eA
- Thread-topic: [XEN PATCH v2 0/3] docs/misra: add documentation skeleton to address MISRA C:2012 Dir 4.1
Hi Nicola,
> On Sep 27, 2023, at 17:52, Nicola Vetrini <nicola.vetrini@xxxxxxxxxxx> wrote:
>
> 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.
>
> CC-ing also Henry Wang, as these are just documentation and CI changes
Indeed, so technically it is safe to include this series to 4.18, if this
series can
be properly reviewed, I am ok to add my release-ack tag for each patch:
Release-acked-by: Henry Wang <Henry.Wang@xxxxxxx>
Kind regards,
Henry
>
> 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 | 6 +-
> automation/eclair_analysis/prepare.sh | 4 +-
> docs/Makefile | 7 +-
> docs/misra/C-runtime-failures.rst | 200 ++++++++++++++++++++++++++
> docs/misra/Makefile | 22 +++
> docs/misra/rules.rst | 8 +-
> 6 files changed, 240 insertions(+), 7 deletions(-)
> create mode 100644 docs/misra/C-runtime-failures.rst
> create mode 100644 docs/misra/Makefile
>
> --
> 2.34.1
|
