rspec/rules/S2637/cfamily/rule.adoc
Fred Tingaud 51369b610e
Make sure that includes are always surrounded by empty lines (#2270)
When an include is not surrounded by empty lines, its content is inlined
on the same line as the adjacent content. That can lead to broken tags
and other display issues.
This PR fixes all such includes and introduces a validation step that
forbids introducing the same problem again.
2023-06-22 10:38:01 +02:00

28 lines
913 B
Plaintext

== Why is this an issue?
Functions return values and parameters values marked ``++nonnull++`` are assumed to have non-null values and are not typically null-checked before use. Therefore setting one of these values to ``++null++``, could cause null pointer dereferences at runtime.
=== Noncompliant code example
[source,cpp]
----
__attribute__((returns_nonnull))
int* nonnull(__attribute__((nonnull)) int* parameter) {
parameter = 0; // Noncompliant - "parameter" is marked "nonnull" but is set to null.
nonnull(0); // Noncompliant - Parameter "parameter" to this call is marked "nonnull" but null is passed.
return 0; // Noncompliant - This function's return value is marked "nonnull" but null is returned.
}
----
include::../see.adoc[]
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
include::../message.adoc[]
endif::env-github,rspecator-view[]