rspec/rules/S1731/cobol/rule.adoc
Fred Tingaud 16f6c0aecf
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

46 lines
794 B
Plaintext

== Why is this an issue?
When the ``++FILE STATUS++`` is not specified on a file, any read operations on the file should handle the "AT END" or "INVALID KEY" conditions.
=== Noncompliant code example
[source,cobol]
----
SELECT MY_FILE
ASSIGN TO 'foobar.txt'
ORGANIZATION IS SEQUENTIAL.
...
READ MY_FILE
NOT AT END PERFORM COMPUTE_LINE
END-READ.
----
=== Compliant solution
[source,cobol]
----
SELECT MY_FILE
ASSIGN TO 'foobar.txt'
ORGANIZATION IS SEQUENTIAL.
...
READ MY_FILE
NOT AT END PERFORM COMPUTE_LINE
AT END MOVE 'Y' TO EOF-FLAG
END-READ.
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
=== Message
Specify the "AT END" or "INVALID KEY" clauses of the READ statement.
endif::env-github,rspecator-view[]