| Message ID | 20230628083701.5489-1-michal.orzel@amd.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | docs/misra: rules: Remove incorrect deviation guidance | expand |
> On 28 Jun 2023, at 09:37, Michal Orzel <michal.orzel@amd.com> wrote: > > It creates confusion since the new format of documenting violations can > be found in: docs/misra/documenting-violations.rst. > > Signed-off-by: Michal Orzel <michal.orzel@amd.com> > --- Wow we missed that! Thanks! Reviewed-by: Luca Fancellu <luca.fancellu@arm.com> > docs/misra/rules.rst | 9 ++------- > 1 file changed, 2 insertions(+), 7 deletions(-) > > diff --git a/docs/misra/rules.rst b/docs/misra/rules.rst > index 11b9c42b70e6..6244598665e2 100644 > --- a/docs/misra/rules.rst > +++ b/docs/misra/rules.rst > @@ -17,13 +17,8 @@ hypervisor. > It is possible that in specific circumstances it is best not to follow a > rule because it is not possible or because the alternative leads to > better code quality. Those cases are called "deviations". They are > -permissible as long as they are documented as an in-code comment using > -the following format:: > - > - /* > - * MISRA_DEV: Rule ID > - * Justification text. > - */ > +permissible as long as they are documented. For details, please refer to > +docs/misra/documenting-violations.rst > > Other documentation mechanisms are work-in-progress. >
On Wed, 28 Jun 2023, Luca Fancellu wrote: > > On 28 Jun 2023, at 09:37, Michal Orzel <michal.orzel@amd.com> wrote: > > > > It creates confusion since the new format of documenting violations can > > be found in: docs/misra/documenting-violations.rst. > > > > Signed-off-by: Michal Orzel <michal.orzel@amd.com> > > --- > > Wow we missed that! Thanks! > > Reviewed-by: Luca Fancellu <luca.fancellu@arm.com> Reviewed-by: Stefano Stabellini <sstabellini@kernel.org>
diff --git a/docs/misra/rules.rst b/docs/misra/rules.rst index 11b9c42b70e6..6244598665e2 100644 --- a/docs/misra/rules.rst +++ b/docs/misra/rules.rst @@ -17,13 +17,8 @@ hypervisor. It is possible that in specific circumstances it is best not to follow a rule because it is not possible or because the alternative leads to better code quality. Those cases are called "deviations". They are -permissible as long as they are documented as an in-code comment using -the following format:: - - /* - * MISRA_DEV: Rule ID - * Justification text. - */ +permissible as long as they are documented. For details, please refer to +docs/misra/documenting-violations.rst Other documentation mechanisms are work-in-progress.
It creates confusion since the new format of documenting violations can be found in: docs/misra/documenting-violations.rst. Signed-off-by: Michal Orzel <michal.orzel@amd.com> --- docs/misra/rules.rst | 9 ++------- 1 file changed, 2 insertions(+), 7 deletions(-)