From: Andrew Cooper <andrew.cooper3@citrix.com>
To: Stefano Stabellini <sstabellini@kernel.org>,
xen-devel@lists.xenproject.org
Cc: "Roger Pau Monné" <roger.pau@citrix.com>,
"Jan Beulich" <jbeulich@suse.com>,
"Julien Grall" <julien@xen.org>,
"Bertrand Marquis" <bertrand.marquis@arm.com>,
"Michal Orzel" <michal.orzel@amd.com>
Subject: Re: [PATCH v3] docs/misra: add R21.6 R21.9 R21.10 R21.14 R21.15 R21.16
Date: Fri, 10 May 2024 23:45:20 +0100 [thread overview]
Message-ID: <be534982-5b4f-4f90-8484-faf09e44a618@citrix.com> (raw)
In-Reply-To: <cf0cd2ef-58df-476f-89c5-c843a85f71f7@citrix.com>
On 10/05/2024 10:48 pm, Andrew Cooper wrote:
> On 26/04/2024 10:36 pm, Stefano Stabellini wrote:
>> Signed-off-by: Stefano Stabellini <stefano.stabellini@amd.com>
>> ---
>>
>> Changes in v3:
>> - add explanation in footnote
>> - remove comment from 21.14, 21.15, 21.16
>>
>> docs/misra/rules.rst | 42 ++++++++++++++++++++++++++++++++++++++++++
>> 1 file changed, 42 insertions(+)
>>
>> diff --git a/docs/misra/rules.rst b/docs/misra/rules.rst
>> index b7b447e152..5ba7394f05 100644
>> --- a/docs/misra/rules.rst
>> +++ b/docs/misra/rules.rst
>> @@ -652,12 +652,48 @@ maintainers if you want to suggest a change.
>> declared
>> - See comment for Rule 21.1
>>
>> + * - `Rule 21.6 <https://gitlab.com/MISRA/MISRA-C/MISRA-C-2012/Example-Suite/-/blob/master/R_21_06.c>`_
>> + - Required
>> + - The Standard Library input/output routines shall not be used
>> + - Xen doesn't provide, use, or link against a Standard Library [1]_
>> +
>> + * - `Rule 21.9 <https://gitlab.com/MISRA/MISRA-C/MISRA-C-2012/Example-Suite/-/blob/master/R_21_09.c>`_
>> + - Required
>> + - The library functions bsearch and qsort of <stdlib.h> shall not be used
>> + - Xen doesn't provide, use, or link against a Standard Library [1]_
>> +
>> + * - `Rule 21.10 <https://gitlab.com/MISRA/MISRA-C/MISRA-C-2012/Example-Suite/-/blob/master/R_21_10.c>`_
>> + - Required
>> + - The Standard Library time and date routines shall not be used
>> + - Xen doesn't provide, use, or link against a Standard Library [1]_
>> +
>> * - `Rule 21.13 <https://gitlab.com/MISRA/MISRA-C/MISRA-C-2012/Example-Suite/-/blob/master/R_21_13.c>`_
>> - Mandatory
>> - Any value passed to a function in <ctype.h> shall be representable as an
>> unsigned char or be the value EOF
>> -
>>
>> + * - `Rule 21.14 <https://gitlab.com/MISRA/MISRA-C/MISRA-C-2012/Example-Suite/-/blob/master/R_21_14.c>`_
>> + - Required
>> + - The Standard Library function memcmp shall not be used to compare
>> + null terminated strings
>> + -
>> +
>> + * - `Rule 21.15 <https://gitlab.com/MISRA/MISRA-C/MISRA-C-2012/Example-Suite/-/blob/master/R_21_15.c>`_
>> + - Required
>> + - The pointer arguments to the Standard Library functions memcpy,
>> + memmove and memcmp shall be pointers to qualified or unqualified
>> + versions of compatible types
>> + -
>> +
>> + * - `Rule 21.16 <https://gitlab.com/MISRA/MISRA-C/MISRA-C-2012/Example-Suite/-/blob/master/R_21_16.c>`_
>> + - Required
>> + - The pointer arguments to the Standard Library function memcmp
>> + shall point to either a pointer type, an essentially signed type,
>> + an essentially unsigned type, an essentially Boolean type or an
>> + essentially enum type
>> + - void* arguments are allowed
>> +
>> * - `Rule 21.17 <https://gitlab.com/MISRA/MISRA-C/MISRA-C-2012/Example-Suite/-/blob/master/R_21_17.c>`_
>> - Mandatory
>> - Use of the string handling functions from <string.h> shall not result in
>> @@ -712,3 +748,9 @@ maintainers if you want to suggest a change.
>> - The value of a pointer to a FILE shall not be used after the associated
>> stream has been closed
>> -
>> +
>> +
>> +.. [1] Xen implements itself a few functions with names that match the
>> + corresponding function names of the Standard Library for developers'
>> + convenience. These functions are part of the Xen code and subject to
>> + analysis.
> I discovered the hard way (c/s 1357f1fa588f1) that numbered footnotes
> are an issue when the document gets more complicated.
>
> I'd suggest using #xen-stdlib as a named footnote instead of [1].
>
> Can fix on commit.
And a ".. rubric:: Footnotes" is wanted too. Fixed on commit, after
conferring with Stefano.
~Andrew
next prev parent reply other threads:[~2024-05-10 22:45 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-04-26 21:36 [PATCH v3] docs/misra: add R21.6 R21.9 R21.10 R21.14 R21.15 R21.16 Stefano Stabellini
2024-05-10 21:48 ` Andrew Cooper
2024-05-10 22:45 ` Andrew Cooper [this message]
2024-05-22 6:26 ` Bertrand Marquis
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=be534982-5b4f-4f90-8484-faf09e44a618@citrix.com \
--to=andrew.cooper3@citrix.com \
--cc=bertrand.marquis@arm.com \
--cc=jbeulich@suse.com \
--cc=julien@xen.org \
--cc=michal.orzel@amd.com \
--cc=roger.pau@citrix.com \
--cc=sstabellini@kernel.org \
--cc=xen-devel@lists.xenproject.org \
/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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).