Re: [PATCH 1/2] docs/misra: introduce rules.rst

[Julien Grall <julien@xxxxxxx>]

Hi,

On 30/05/2022 14:35, Bertrand Marquis wrote:
> > Obviously something *else* we might want is a more convenient way to keep that rationale for the 
> > future, when we start to officially document deviations.  Given that the scanner will point out all 
> > the places where deviations happen, I don’t think an unstructured comment with an informal 
> > summary of the justification would be a problem — it seems like it would be a lot easier, 
> > when we start to officially document deviations, to transform comments in the existing codebase, 
> > than to search through the mailing lists and/or git commit history to find the rationale (or try to 
> > work out unaided what the intent was).  But I don’t have strong opinions on the matter.
> Maybe agreeing on a simple tag to start that can later be improved (Luca 
> Fancellu on my side will start working on that with the FuSa SIG and Eclair 
> next month).
>
> So I would suggest:
>
> /**
>   * MISRA_DEV: Rule ID
>   * xxxxx justification
>   *
>   */
>
> Whenever we will have defined the final way, we will replace those entries with 
> the new system.
>
> Would that be an agreeable solution ?
I am fine with that. With one NIT thought, in Xen comments the first 
line of multi-line comment is "/*" rather than "/**".
Cheers,

--
Julien Grall