From: Nicola Vetrini <nicola.vetrini@bugseng.com>
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, jbeulich@suse.com,
andrew.cooper3@citrix.com, roger.pau@citrix.com,
Nicola Vetrini <nicola.vetrini@bugseng.com>,
George Dunlap <george.dunlap@citrix.com>,
Julien Grall <julien@xen.org>, Wei Liu <wl@xen.org>,
Anthony PERARD <anthony.perard@citrix.com>,
Simone Ballarin <simone.ballarin@bugseng.com>,
Doug Goldstein <cardoe@cardoe.com>,
Henry Wang <Henry.Wang@arm.com>
Subject: [XEN PATCH v2 0/3] docs/misra: add documentation skeleton to address MISRA C:2012 Dir 4.1
Date: Wed, 27 Sep 2023 11:52:29 +0200 [thread overview]
Message-ID: <cover.1695801813.git.nicola.vetrini@bugseng.com> (raw)
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
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
next reply other threads:[~2023-09-27 9:53 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-09-27 9:52 Nicola Vetrini [this message]
2023-09-27 9:52 ` [XEN PATCH v2 1/3] docs/misra: add documentation skeleton for MISRA C:2012 Dir 4.1 Nicola Vetrini
2023-09-28 0:55 ` Stefano Stabellini
2023-09-28 16:13 ` Nicola Vetrini
2023-09-28 22:32 ` Stefano Stabellini
2023-09-27 9:52 ` [XEN PATCH v2 2/3] docs: make the docs for MISRA C:2012 Dir 4.1 visible to ECLAIR Nicola Vetrini
2023-09-27 15:58 ` Anthony PERARD
2023-09-28 0:49 ` Stefano Stabellini
2023-09-28 0:53 ` Henry Wang
2023-09-27 9:52 ` [XEN PATCH v2 3/3] automation/eclair: build docs/misra to address MISRA C:2012 Dir 4.1 Nicola Vetrini
2023-09-27 13:29 ` Nicola Vetrini
2023-09-28 6:52 ` Nicola Vetrini
2023-09-27 9:57 ` [XEN PATCH v2 0/3] docs/misra: add documentation skeleton " Henry Wang
2023-09-29 15:36 ` Nicola Vetrini
2023-09-29 16:49 ` Luca Fancellu
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=cover.1695801813.git.nicola.vetrini@bugseng.com \
--to=nicola.vetrini@bugseng.com \
--cc=Henry.Wang@arm.com \
--cc=andrew.cooper3@citrix.com \
--cc=anthony.perard@citrix.com \
--cc=ayan.kumar.halder@amd.com \
--cc=cardoe@cardoe.com \
--cc=consulting@bugseng.com \
--cc=george.dunlap@citrix.com \
--cc=jbeulich@suse.com \
--cc=julien@xen.org \
--cc=michal.orzel@amd.com \
--cc=roger.pau@citrix.com \
--cc=simone.ballarin@bugseng.com \
--cc=sstabellini@kernel.org \
--cc=wl@xen.org \
--cc=xen-devel@lists.xenproject.org \
--cc=xenia.ragiadakou@amd.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.