Re: [PATCH v2] docs/misra: add exceptions to rules

[Stefano Stabellini <sstabellini@xxxxxxxxxx>]

On Tue, 22 Aug 2023, Jan Beulich wrote:
> On 22.08.2023 12:33, Julien Grall wrote:
> > Hi Jan,
> > 
> > On 22/08/2023 11:12, Jan Beulich wrote:
> >> On 22.08.2023 09:56, Julien Grall wrote:
> >>> On 22/08/2023 02:30, Stefano Stabellini wrote:
> >>>> --- a/docs/misra/rules.rst
> >>>> +++ b/docs/misra/rules.rst
> >>>> @@ -59,7 +59,8 @@ maintainers if you want to suggest a change.
> >>>>         - Required
> >>>>         - Precautions shall be taken in order to prevent the contents of 
> >>>> a
> >>>>           header file being included more than once
> >>>> -     -
> >>>
> >>> It is not clear to me why this line is removed. Was it added by mistake
> >>> in a previous commit?
> >>
> >> The patch is replacing an empty comment ...
> >>
> >>>> +     - Files that are intended to be included more than once do not 
> >>>> need to
> >>>> +       conform to the directive
> >>
> >> ... with a non-empty one.
> > 
> > I understand that... My question is more related to why we originally 
> > added one? If this was done on purpose, then why are we removing it?
> 
> I think the goal is for the file to be easily machine readable, and hence
> the same number of sub-items want to appear for every main item.

Yes, it is to respect the RST table format so that gets rendered as a
table in HTML/PDF/etc.