Skip to content

Commit d1dc834

Browse files
committed
doc(test/README.md): minor improvements
1 parent d77c01d commit d1dc834

File tree

1 file changed

+18
-16
lines changed

1 file changed

+18
-16
lines changed

test/README.md

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,38 +2,40 @@ Compiler Support Status
22
=======================
33

44
This directory contains two categories of unit tests separated into two files:
5-
* `compiler_test.f90` checks whether a compiler performs finalizes objects in
6-
each scenario that the Fortran 2018 standard requires.
7-
* `usage_test.f90` exercises the reference-counter library.
8-
The compiler tests verify the compiler in isolation, making _no_ use of the
9-
reference-counter library.
105

11-
`nagfor` 7.1.0
6+
* `usage_test.f90` exercises the reference-counter library, whereas
7+
* `compiler_test.f90` tests the compiler without using reference-counter,
8+
9+
`compiler_test.f90` verifies that a compiler calls a type's final subroutine
10+
in each of the scenarios in which the Fortran standard requires finalization
11+
to occur.
12+
13+
`nagfor` 7.1.0
1214
--------------
13-
The Numerical Algorithms Group [(NAG]) Fortran compiler] passes all of the tests in the
14-
reference-counter test suite. :trophy:
15+
:trophy: The Numerical Algorithms Group [(NAG]) Fortran compiler] passes all
16+
reference-counter tests.
1517

1618
`gfortran` 12.2.0
1719
-----------------
18-
Because the first usage test below causes a segmentation fault,
19-
exposing `gfortran`'s test failures requires running each test individually
20-
as follows:
20+
Because the first usage test listed below causes a segmentation fault,
21+
obtaining the `gfortran` test results requires skipping that test by,
22+
for example, running running individual tests as follows:
2123
```
2224
fpm test -- -f "<description>"
2325
```
24-
where one must replace <description> above with one of the enumerated
25-
descriptions below (or a corresponding unambiguous substring).
26+
Replace <description> above with one of the enumerated test descriptions
27+
below or with a corresponding substring not contained in the first usage
28+
test description.
2629

27-
Failing checks in `compiler_test.f90`:
30+
### Failing checks in `compiler_test.f90`
2831
1. finalizes a non-allocatable object on the LHS of an intrinsic assignment
2932
2. finalizes an allocated allocatable LHS of an intrinsic assignment
3033
3. finalizes a function reference on the RHS of an intrinsic assignment
3134
4. finalizes a function reference on the RHS of an intrinsic assignment
3235
5. finalizes a specification expression function result
3336

34-
Failing checks in `usage_test.f90`:
37+
### Failing checks in `usage_test.f90`
3538
1. copy points to the same resource as the original
3639
2. has zero references after a shallow copy goes out of scope
3740

3841
[(NAG) Fortran compiler]: https://www.nag.com/content/nag-fortran-compiler
39-

0 commit comments

Comments
 (0)