Re: [PATCH v3] docs/misra: add R21.6 R21.9 R21.10 R21.14 R21.15 R21.16

[Andrew Cooper <andrew.cooper3@xxxxxxxxxx>]

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@xxxxxxx>
>> ---
>>
>> 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