Re: [PATCH] docs/misra/rules.rst: add more rules

[Jan Beulich <jbeulich@xxxxxxxx>]

On 08.12.2023 01:08, Stefano Stabellini wrote:
> On Thu, 7 Dec 2023, Jan Beulich wrote:
>> On 07.12.2023 03:42, Stefano Stabellini wrote:
>>> On Wed, 6 Dec 2023, Jan Beulich wrote:
>>>> On 06.12.2023 04:02, Stefano Stabellini wrote:
>>>>> --- a/docs/misra/rules.rst
>>>>> +++ b/docs/misra/rules.rst
>>>>> @@ -462,11 +462,23 @@ maintainers if you want to suggest a change.
>>>>>  
>>>>>         while(0) and while(1) and alike are allowed.
>>>>>  
>>>>> +   * - `Rule 16.3 
>>>>> <https://gitlab.com/MISRA/MISRA-C/MISRA-C-2012/Example-Suite/-/blob/master/R_16_03.c>`_
>>>>> +     - Required
>>>>> +     - An unconditional break statement shall terminate every
>>>>> +       switch-clause
>>>>> +     - In addition to break, also other flow control statements such as
>>>>> +       continue, return, goto are allowed.
>>>>> +
>>>>>     * - `Rule 16.7 
>>>>> <https://gitlab.com/MISRA/MISRA-C/MISRA-C-2012/Example-Suite/-/blob/master/R_16_07.c>`_
>>>>>       - Required
>>>>>       - A switch-expression shall not have essentially Boolean type
>>>>>       -
>>>>>  
>>>>> +   * - `Rule 17.1 
>>>>> <https://gitlab.com/MISRA/MISRA-C/MISRA-C-2012/Example-Suite/-/blob/master/R_17_01.c>`_
>>>>> +     - Required
>>>>> +     - The features of <stdarg.h> shall not be used
>>>>> +     -
>>>>
>>>> Did we really accept this without any constraint (warranting mentioning
>>>> here)?
>>>
>>> We agreed that in certain situations stdarg.h is OK to use and in those
>>> cases we would add a deviation. Would you like me to add something to
>>> that effect here? I could do that but it would sound a bit vague.  Also
>>> if we want to specify a project-wide deviation it would be better
>>> documented in docs/misra/deviations.rst. I would leave Rule 17.1 without
>>> a note.
>>
>> I can see your point, and I don't have a good suggestion on possible text.
>> Still I wouldn't feel well ack-ing this in its present shape.
> 
> What about:
> 
>      - It is understood that in some limited circumstances <stdarg.h> is
>        appropriate to use, such as the implementation of printk. Those
>        cases will be dealt with using deviations as usual, see
>        docs/misra/deviations.rst and
>        docs/misra/documenting-violations.rst.

Looks okay. Would also look okay if it was just the first sentence.

Jan