From: Stefano Stabellini <stefano.stabellini@amd.com>
Also add a comment at the top of the file to say rules.rst could be
changed.
Signed-off-by: Stefano Stabellini <stefano.stabellini@amd.com>
---
Changes in v2:
- add link for 1.4
- expand 1.4 comment to say it could be revisited
- add comment at the top
---
docs/misra/rules.rst | 15 +++++++++++++++
1 file changed, 15 insertions(+)
diff --git a/docs/misra/rules.rst b/docs/misra/rules.rst
index a88c284e7d..11b9c42b70 100644
--- a/docs/misra/rules.rst
+++ b/docs/misra/rules.rst
@@ -32,6 +32,9 @@ violations are meant to be documented as deviations, while some others
should be fixed. Both compliance and documenting deviations on the
existing codebase are work-in-progress.
+The list below might need to be updated over time. Reach out to THE REST
+maintainers if you want to suggest a change.
+
.. list-table::
:header-rows: 1
@@ -90,6 +93,18 @@ existing codebase are work-in-progress.
behaviour
-
+ * - `Rule 1.4 <https://gitlab.com/MISRA/MISRA-C/MISRA-C-2012/Example-Suite/>`_
+ - Required
+ - Emergent language features shall not be used
+ - Emergent language features, such as C11 features, should not be
+ confused with similar compiler extensions, which we use. When the
+ time comes to adopt C11, this rule will be revisited.
+
+ * - `Rule 2.1 <https://gitlab.com/MISRA/MISRA-C/MISRA-C-2012/Example-Suite/-/blob/master/R_02_01_1.c>`_
+ - Required
+ - A project shall not contain unreachable code
+ -
+
* - `Rule 2.6 <https://gitlab.com/MISRA/MISRA-C/MISRA-C-2012/Example-Suite/-/blob/master/R_02_06.c>`_
- Advisory
- A function should not contain unused label declarations
--
2.25.1
> On 15 Jun 2023, at 22:27, Stefano Stabellini <sstabellini@kernel.org> wrote: > > From: Stefano Stabellini <stefano.stabellini@amd.com> > > Also add a comment at the top of the file to say rules.rst could be > changed. > > Signed-off-by: Stefano Stabellini <stefano.stabellini@amd.com> Hi Stefano, Reviewed-by: Luca Fancellu <luca.fancellu@arm.com> While I was testing the patch with our script that translates the docs to cppcheck Inputs, I noticed we might have a small issue there, seems that Directives and Rules clashes, and from a quick look to cppcheck addon, seems that only the rules are needed. I’ll have a look on that soon. > > --- > Changes in v2: > - add link for 1.4 > - expand 1.4 comment to say it could be revisited > - add comment at the top > --- > docs/misra/rules.rst | 15 +++++++++++++++ > 1 file changed, 15 insertions(+) > > diff --git a/docs/misra/rules.rst b/docs/misra/rules.rst > index a88c284e7d..11b9c42b70 100644 > --- a/docs/misra/rules.rst > +++ b/docs/misra/rules.rst > @@ -32,6 +32,9 @@ violations are meant to be documented as deviations, while some others > should be fixed. Both compliance and documenting deviations on the > existing codebase are work-in-progress. > > +The list below might need to be updated over time. Reach out to THE REST > +maintainers if you want to suggest a change. > + > .. list-table:: > :header-rows: 1 > > @@ -90,6 +93,18 @@ existing codebase are work-in-progress. > behaviour > - > > + * - `Rule 1.4 <https://gitlab.com/MISRA/MISRA-C/MISRA-C-2012/Example-Suite/>`_ > + - Required > + - Emergent language features shall not be used > + - Emergent language features, such as C11 features, should not be > + confused with similar compiler extensions, which we use. When the > + time comes to adopt C11, this rule will be revisited. > + > + * - `Rule 2.1 <https://gitlab.com/MISRA/MISRA-C/MISRA-C-2012/Example-Suite/-/blob/master/R_02_01_1.c>`_ > + - Required > + - A project shall not contain unreachable code > + - > + > * - `Rule 2.6 <https://gitlab.com/MISRA/MISRA-C/MISRA-C-2012/Example-Suite/-/blob/master/R_02_06.c>`_ > - Advisory > - A function should not contain unused label declarations > -- > 2.25.1 > >
On Fri, 16 Jun 2023, Luca Fancellu wrote: > > On 15 Jun 2023, at 22:27, Stefano Stabellini <sstabellini@kernel.org> wrote: > > > > From: Stefano Stabellini <stefano.stabellini@amd.com> > > > > Also add a comment at the top of the file to say rules.rst could be > > changed. > > > > Signed-off-by: Stefano Stabellini <stefano.stabellini@amd.com> > > Hi Stefano, > > Reviewed-by: Luca Fancellu <luca.fancellu@arm.com> > > > While I was testing the patch with our script that translates the docs to cppcheck > Inputs, I noticed we might have a small issue there, seems that Directives and Rules > clashes, and from a quick look to cppcheck addon, seems that only the rules are needed. > > I’ll have a look on that soon. Noted, thanks! > > > > --- > > Changes in v2: > > - add link for 1.4 > > - expand 1.4 comment to say it could be revisited > > - add comment at the top > > --- > > docs/misra/rules.rst | 15 +++++++++++++++ > > 1 file changed, 15 insertions(+) > > > > diff --git a/docs/misra/rules.rst b/docs/misra/rules.rst > > index a88c284e7d..11b9c42b70 100644 > > --- a/docs/misra/rules.rst > > +++ b/docs/misra/rules.rst > > @@ -32,6 +32,9 @@ violations are meant to be documented as deviations, while some others > > should be fixed. Both compliance and documenting deviations on the > > existing codebase are work-in-progress. > > > > +The list below might need to be updated over time. Reach out to THE REST > > +maintainers if you want to suggest a change. > > + > > .. list-table:: > > :header-rows: 1 > > > > @@ -90,6 +93,18 @@ existing codebase are work-in-progress. > > behaviour > > - > > > > + * - `Rule 1.4 <https://gitlab.com/MISRA/MISRA-C/MISRA-C-2012/Example-Suite/>`_ > > + - Required > > + - Emergent language features shall not be used > > + - Emergent language features, such as C11 features, should not be > > + confused with similar compiler extensions, which we use. When the > > + time comes to adopt C11, this rule will be revisited. > > + > > + * - `Rule 2.1 <https://gitlab.com/MISRA/MISRA-C/MISRA-C-2012/Example-Suite/-/blob/master/R_02_01_1.c>`_ > > + - Required > > + - A project shall not contain unreachable code > > + - > > + > > * - `Rule 2.6 <https://gitlab.com/MISRA/MISRA-C/MISRA-C-2012/Example-Suite/-/blob/master/R_02_06.c>`_ > > - Advisory > > - A function should not contain unused label declarations > > -- > > 2.25.1 > > > > > >
Hi Stefano, > On 15 Jun 2023, at 23:27, Stefano Stabellini <sstabellini@kernel.org> wrote: > > From: Stefano Stabellini <stefano.stabellini@amd.com> > > Also add a comment at the top of the file to say rules.rst could be > changed. > > Signed-off-by: Stefano Stabellini <stefano.stabellini@amd.com> Reviewed-by: Bertrand Marquis <bertrand.marquis@arm.com> Cheers Bertrand > > --- > Changes in v2: > - add link for 1.4 > - expand 1.4 comment to say it could be revisited > - add comment at the top > --- > docs/misra/rules.rst | 15 +++++++++++++++ > 1 file changed, 15 insertions(+) > > diff --git a/docs/misra/rules.rst b/docs/misra/rules.rst > index a88c284e7d..11b9c42b70 100644 > --- a/docs/misra/rules.rst > +++ b/docs/misra/rules.rst > @@ -32,6 +32,9 @@ violations are meant to be documented as deviations, while some others > should be fixed. Both compliance and documenting deviations on the > existing codebase are work-in-progress. > > +The list below might need to be updated over time. Reach out to THE REST > +maintainers if you want to suggest a change. > + > .. list-table:: > :header-rows: 1 > > @@ -90,6 +93,18 @@ existing codebase are work-in-progress. > behaviour > - > > + * - `Rule 1.4 <https://gitlab.com/MISRA/MISRA-C/MISRA-C-2012/Example-Suite/>`_ > + - Required > + - Emergent language features shall not be used > + - Emergent language features, such as C11 features, should not be > + confused with similar compiler extensions, which we use. When the > + time comes to adopt C11, this rule will be revisited. > + > + * - `Rule 2.1 <https://gitlab.com/MISRA/MISRA-C/MISRA-C-2012/Example-Suite/-/blob/master/R_02_01_1.c>`_ > + - Required > + - A project shall not contain unreachable code > + - > + > * - `Rule 2.6 <https://gitlab.com/MISRA/MISRA-C/MISRA-C-2012/Example-Suite/-/blob/master/R_02_06.c>`_ > - Advisory > - A function should not contain unused label declarations > -- > 2.25.1 >
© 2016 - 2024 Red Hat, Inc.