51369b610e
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.
54 lines
1.2 KiB
Plaintext
54 lines
1.2 KiB
Plaintext
== Why is this an issue?
|
|
|
|
include::../jvm-description.adoc[]
|
|
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,kotlin]
|
|
----
|
|
fun doSomething(file: File, lock: Lock) {
|
|
file.delete() // Noncompliant
|
|
// ...
|
|
lock.tryLock() // Noncompliant
|
|
}
|
|
----
|
|
|
|
=== Compliant solution
|
|
|
|
[source,kotlin]
|
|
----
|
|
fun doSomething(file: File, lock: Lock) {
|
|
if (!file.delete()) {
|
|
// file delete failed; take appropriate action
|
|
}
|
|
if (!lock.tryLock()) {
|
|
// lock failed; take appropriate action
|
|
}
|
|
}
|
|
----
|
|
|
|
== Resources
|
|
|
|
Although these resources talk about Java, the underlying information concerning the JVM is just as relevant for Kotlin.
|
|
|
|
* https://wiki.sei.cmu.edu/confluence/x/xzdGBQ[CERT, EXP00-J.] - Do not ignore values returned by methods
|
|
* https://wiki.sei.cmu.edu/confluence/x/TTZGBQ[CERT, FIO02-J.] - Detect and handle file-related errors
|
|
* https://cwe.mitre.org/data/definitions/754[MITRE, CWE-754] - Improper Check for Unusual Exceptional Conditions
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
include::../message.adoc[]
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
include::../comments-and-links.adoc[]
|
|
|
|
endif::env-github,rspecator-view[]
|