docs/misra/rules.rst: Fix entry for 20.12 rule

[PATCH] docs/misra/rules.rst: Fix entry for 20.12 rule

Posted by Michal Orzel 1 year, 11 months ago

Commit 4cac80e22600 broke the CI cppcheck jobs by adding an entry for
a rule 20.12 with "Severity" and "Summary" fields placed in reverse order.
This leads to an error as reported by convert_misra_doc.py:
No summary for rule 20.12

Fixes: 4cac80e22600 ("docs/misra/rules.rst: add rule 16.6 and 20.12")
Signed-off-by: Michal Orzel <michal.orzel@amd.com>
---
Failed pipeline:
https://gitlab.com/xen-project/xen/-/pipelines/1196428827
---
 docs/misra/rules.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/misra/rules.rst b/docs/misra/rules.rst
index c1853669669d..efea063ab941 100644
--- a/docs/misra/rules.rst
+++ b/docs/misra/rules.rst
@@ -561,10 +561,10 @@ maintainers if you want to suggest a change.
      -
 
    * - `Rule 20.12 <https://gitlab.com/MISRA/MISRA-C/MISRA-C-2012/Example-Suite/-/blob/master/R_20_12.c>`_
+     - Required
      - A macro parameter used as an operand to the # or ## operators,
        which is itself subject to further macro replacement, shall only
        be used as an operand to these operators
-     - Required
      - Variadic macros are allowed to violate the rule.
 
    * - `Rule 20.13 <https://gitlab.com/MISRA/MISRA-C/MISRA-C-2012/Example-Suite/-/blob/master/R_20_13.c>`_
-- 
2.25.1

Re: [PATCH] docs/misra/rules.rst: Fix entry for 20.12 rule

Posted by Luca Fancellu 1 year, 11 months ago


> On 1 Mar 2024, at 08:49, Michal Orzel <michal.orzel@amd.com> wrote:
> 
> Commit 4cac80e22600 broke the CI cppcheck jobs by adding an entry for
> a rule 20.12 with "Severity" and "Summary" fields placed in reverse order.
> This leads to an error as reported by convert_misra_doc.py:
> No summary for rule 20.12
> 
> Fixes: 4cac80e22600 ("docs/misra/rules.rst: add rule 16.6 and 20.12")
> Signed-off-by: Michal Orzel <michal.orzel@amd.com>
> ---
> Failed pipeline:
> https://gitlab.com/xen-project/xen/-/pipelines/1196428827
> ---

Reviewed-by: Luca Fancellu <luca.fancellu@arm.com>

Re: [PATCH] docs/misra/rules.rst: Fix entry for 20.12 rule

Posted by Andrew Cooper 1 year, 11 months ago

On 01/03/2024 8:52 am, Luca Fancellu wrote:
>> On 1 Mar 2024, at 08:49, Michal Orzel <michal.orzel@amd.com> wrote:
>>
>> Commit 4cac80e22600 broke the CI cppcheck jobs by adding an entry for
>> a rule 20.12 with "Severity" and "Summary" fields placed in reverse order.
>> This leads to an error as reported by convert_misra_doc.py:
>> No summary for rule 20.12
>>
>> Fixes: 4cac80e22600 ("docs/misra/rules.rst: add rule 16.6 and 20.12")
>> Signed-off-by: Michal Orzel <michal.orzel@amd.com>
>> ---
>> Failed pipeline:
>> https://gitlab.com/xen-project/xen/-/pipelines/1196428827
>> ---
> Reviewed-by: Luca Fancellu <luca.fancellu@arm.com>

Thanks for the fast turnaround.  Lets hope the next run on staging fairs
better.

~Andrew