Skip to content

Commit ae3514f

Browse files
authored
Merge pull request #73 from sourceryinstitute/doc-compiler-support
doc(README): separate compilers based on support
2 parents b5f5317 + 62e5e63 commit ae3514f

File tree

1 file changed

+30
-18
lines changed

1 file changed

+30
-18
lines changed

README.md

Lines changed: 30 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -58,25 +58,37 @@ This repository also adds
5858

5959
Supported Compilers
6060
-------------------
61-
Correct execution of the Smart Pointers library depends critically on comprehensive
61+
Correct execution of the Smart-Pointers library depends critically on comprehensive
6262
compiler support for type finalization. The unit test suite verifies the relevant
6363
compiler standard-conformance, including a test for each scenario in which the
64-
the Fortran 2023 standard requires that an object be finalized. The table below
65-
summarizes the observed compiler behaviors:
66-
67-
| _Compiler_ | _Test failures_ | _Version tested_ |
68-
| :--- | :---: | :--- |
69-
| AMD `flang` | N.A. (see Note) | 13.0.0 (AOCC_3.2.0-Build\#128 2021\_11\_12) |
70-
| Cray `ftn` | 4 | 17.0.0 |
71-
| GCC `gfortran` :trophy: | 0 | 13.1.0 |
72-
| IBM `xlf2008_r` | 1 | 17.1.0 on AIX |
73-
| Intel `ifort` | 1 | 2021.7.0 Build 20220726_000000 |
74-
| Intel `ifx` | 1 | 2024.0.0 Build 20231017 |
75-
| LLVM `flang` :trophy: | 0 | 19.0.0 `git` commit 325f5123 |
76-
| NAG `nagfor` :trophy: | 0 | 7.1 Build 7113 |
77-
| NVIDIA `nvfortran` | 2 | 22.7-0 |
78-
79-
Note: AMD `flang` fails to build Smart-Pointers due to an internal compiler error (ICE).
64+
the Fortran 2023 standard requires that an object be finalized. The following compilers
65+
pass all Smart-Pointers tests:
66+
67+
| _Compiler_ | _Test failures_ | _Version tested_ |
68+
| :--- | :--- | :--- |
69+
| GCC `gfortran` :trophy: | 0 | 13.1.0 |
70+
| LLVM `flang` :trophy: | 0 | 19.0.0 `git` commit 325f5123 |
71+
| NAG `nagfor` :trophy: | 0 | 7.1 Build 7113 |
72+
73+
Partially Supported Compilers
74+
-----------------------------
75+
The following compilers pass _most_ smart pointers tests:
76+
77+
| _Compiler_ | _Test failures_ | _Version tested_ |
78+
| :--- | :---: | :--- |
79+
| Cray `ftn` | 4 | 17.0.0 |
80+
| IBM `xlf2008_r` | 1 | 17.1.0 on AIX |
81+
| Intel `ifort` | 1 | 2021.7.0 Build 20220726_000000 |
82+
| Intel `ifx` | 1 | 2024.0.0 Build 20231017 |
83+
| NVIDIA `nvfortran` | 2 | 22.7-0 |
84+
85+
Unsupported Compiler
86+
--------------------
87+
The following compiler fails to build Smart-Pointers due to an internal compiler error (ICE):
88+
89+
| _Compiler_ | _Test failures_ | _Version tested_ |
90+
| :--- | :---: | :--- |
91+
| AMD `flang` | N.A. (see Note) | 13.0.0 (AOCC_3.2.0-Build\#128 2021\_11\_12) |
8092

8193
See the [test suite README.md](./test/README.md) for more details on each compiler's test
8294
results.
@@ -157,7 +169,7 @@ fpm test --compiler flang --flag -cpp
157169

158170
Documentation
159171
-------------
160-
See Smart Pointer's GitHub Pages [site] for HTML documentation generated with [`ford`].
172+
See the Smart-Pointers GitHub Pages [site] for HTML documentation generated with [`ford`].
161173
See the [doc/] subdirectory for a [PlantUML] script that generates the Unified Modeling Language (UML)
162174
class diagram below of the three derived types in Smart-Pointers.
163175

0 commit comments

Comments
 (0)