rspec/rules/S811/cfamily/rule.adoc

== Why is this an issue?

This rule is a strict implementation of a MISRA (Motor Industry Software Reliability Association) rule. MISRA defines best practices for developing safety-critical software. You can learn more about this rule in the MISRA documents referenced below.


If you are not concerned with MISRA compliance or with safety-critical software, you might consider using rule S867 instead ; it targets the same kind of issue for general-purpose software.


== Resources

* MISRA {cpp} 2008, 5-0-13


ifdef::env-github,rspecator-view[]

'''
== Implementation Specification
(visible only on this page)

=== Message

Use a condition which yields a "bool".


'''
== Comments And Links
(visible only on this page)

=== is related to: S867

=== relates to: S912

=== on 16 Oct 2014, 13:19:03 Ann Campbell wrote:
\[~samuel.mercier] please:

* fill in the appropriate reference field(s).
* provide a See section.
* use double curly braces around code in the description, e.g. NULL.
* use the standard section titles
* use our standard: "Noncompliant", rather than "Non-compliant".

=== on 17 Oct 2014, 15:38:44 Ann Campbell wrote:
FYI [~samuel.mercier] I've moved all the "compliant by exception" code into a code block in the Exceptions section.

=== on 22 Jan 2019, 11:41:12 Loïc Joly wrote:
See comment bellow RSPEC-883

endif::env-github,rspecator-view[]
migrate rule descriptions to new education format 2023-05-03 11:06:20 +02:00			`== Why is this an issue?`

Restructure one-lang rspecs 2021-04-28 16:49:39 +02:00			`This rule is a strict implementation of a MISRA (Motor Industry Software Reliability Association) rule. MISRA defines best practices for developing safety-critical software. You can learn more about this rule in the MISRA documents referenced below.`


			`If you are not concerned with MISRA compliance or with safety-critical software, you might consider using rule S867 instead ; it targets the same kind of issue for general-purpose software.`

Fix the missing default metadata fields 2021-04-28 18:08:03 +02:00
migrate rule descriptions to new education format 2023-05-03 11:06:20 +02:00			`== Resources`
Restructure one-lang rspecs 2021-04-28 16:49:39 +02:00
			`* MISRA {cpp} 2008, 5-0-13`
Fix the missing default metadata fields 2021-04-28 18:08:03 +02:00
Export comments and rspec-to-rspec links from jira 2021-06-02 20:44:38 +02:00
Fix the comment display: rule-id, timestamp, GH visibility, link direction 2021-06-03 09:05:38 +02:00			`ifdef::env-github,rspecator-view[]`
RULEAPI-666: Migrate the "List of parameters", "Highlighting" and "Message" fields from jira RSPEC (#346) 2021-09-20 15:38:42 +02:00
			`'''`
			`== Implementation Specification`
			`(visible only on this page)`

Inline adoc when include has no additional value (#1940) Inline adoc files when they are included exactly once. Also fix language tags because this inlining gives us better information on what language the code is written in. 2023-05-25 14:18:12 +02:00			`=== Message`

			`Use a condition which yields a "bool".`

RULEAPI-666: Migrate the "List of parameters", "Highlighting" and "Message" fields from jira RSPEC (#346) 2021-09-20 15:38:42 +02:00
RULEAPI-576: add a horizontal rule between rule description and comments 2021-06-08 15:52:13 +02:00			`'''`
Export comments and rspec-to-rspec links from jira 2021-06-02 20:44:38 +02:00			`== Comments And Links`
			`(visible only on this page)`

Inline adoc when include has no additional value (#1940) Inline adoc files when they are included exactly once. Also fix language tags because this inlining gives us better information on what language the code is written in. 2023-05-25 14:18:12 +02:00			`=== is related to: S867`

			`=== relates to: S912`

			`=== on 16 Oct 2014, 13:19:03 Ann Campbell wrote:`
			`\[~samuel.mercier] please:`

			`* fill in the appropriate reference field(s).`
			`* provide a See section.`
			`* use double curly braces around code in the description, e.g. NULL.`
			`* use the standard section titles`
			`* use our standard: "Noncompliant", rather than "Non-compliant".`

			`=== on 17 Oct 2014, 15:38:44 Ann Campbell wrote:`
			`FYI [~samuel.mercier] I've moved all the "compliant by exception" code into a code block in the Exceptions section.`

			`=== on 22 Jan 2019, 11:41:12 Loïc Joly wrote:`
			`See comment bellow RSPEC-883`

Fix the comment display: rule-id, timestamp, GH visibility, link direction 2021-06-03 09:05:38 +02:00			`endif::env-github,rspecator-view[]`