Skip to content

Commit 0722eba

Browse files
committed
doc(README): fix fpm command table
1 parent abea9c5 commit 0722eba

1 file changed

Lines changed: 31 additions & 37 deletions

File tree

README.md

Lines changed: 31 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ components:
6868

6969
Custom Test Diagnostics
7070
-----------------------
71-
For cases in which the defeind operations do not support a desired correctness
71+
For cases in which the defined operations do not support a desired correctness
7272
condition, Julienne provides string-handling utilities for use in crafting
7373
custom diagnostic messages. The string utilities center around a `string_t`
7474
derived type, which offers `elemental` constructor functions, i.e., functions
@@ -151,7 +151,7 @@ Getting Started
151151
---------------
152152
### Writing Unit Tests
153153
Please see [demo/README.md](./demo/README.md) for a detailed demonstration of
154-
test setup.
154+
test setup.
155155

156156
### Writing Assertions
157157
To write a Julienne assertion, insert a function-like preprocessor macro
@@ -196,42 +196,36 @@ Building and Testing
196196
--------------------
197197

198198
With the Fortran Package Manager (`fpm`) installed and in your `PATH`, the
199-
commands in the table below build and run the Julienne test suite. With `fpm`
200-
versions higher than 0.12.0, `flang-new` can be replaced with `flang`.
201-
202-
Compiler/Runtime | Supported Versions | `bash` commands for building/testing (replace `2`s below with the number of images)
203-
------------------|---------------------|------------------------------------------------------------------------------------------
204-
LLVM/[Caffeine] | 22 | parallel: please contact fortran@lbl.gov
205-
| 20-22 | serial: `fpm test --compiler flang-new --flag -O3`
206-
| 19 | serial: `fpm test --compiler flang-new --flag "-O3 -mmlir -allow-assumed-rank"`
207-
------------------|---------------------|------------------------------------------------------------------------------------------
208-
NAG | 7.2 (Build 7235-) | `export NAGFORTRAN_NUM_IMAGES=2`
209-
| | `fpm test --compiler nagfor --flag "-fpp -O3 -coarray"`
210-
------------------|---------------------|------------------------------------------------------------------------------------------
211-
Intel | 2025.2.{0-1} | `export FOR_COARRAY_NUM_IMAGES=2`
212-
| | `fpm test --compiler ifx --flag "-fpp -O3 -coarray" --profile release`
213-
------------------|---------------------|------------------------------------------------------------------------------------------
214-
GCC/[OpenCoarrays]| 14-15 | serial: `fpm test --compiler gfortran --profile release`
215-
| | parallel: `fpm test --compiler caf --runnner "cafrun -n 2" --profile release`
216-
| 13 | serial: `fpm test --compiler gfortran --profile release --flag -ffree-line-length-none`
217-
| | parallel: `fpm test --compiler caf --runnner "cafrun -n 2" --profile release --flag -ffree-line-length-none`
218-
219-
The test output reports a test skipped if there is a known issue that blocks the
220-
tested feature with the compiler version employed or on a given platform. By
221-
default, the test suite skips the tests for Julienn's command-line parsing
222-
utility, `command_line_t`, due to an issue with GitHub continuous-integration
223-
testing. To test `command_line_t`, add `-- --flag --test command_line_t --type`
224-
to any of the above `fpm` commands
225-
226-
### Useful proprocessor macros:
227-
To set any of the following macros add `--flag -D<macro-name>` to an `fpm` command:
228-
229-
- `ASYNCHRONOUS_DIAGNOSTICS`: removes synchronizations that partially order test-failure diagnostics output for clarity
199+
commands in the table below will build and run the Julienne test suite. With
200+
`fpm` versions higher than 0.12.0, `flang-new` can be replaced with `flang`.
201+
202+
Compiler/Runtime |Tested Versions|Run Type|`bash` build/test commands (`num_images()==2`)
203+
------------------|---------------|--------|----------------------------------------------
204+
LLVM/[Caffeine] |22 |parallel|please contact fortran@lbl.gov
205+
LLVM/[Caffeine] |20-22 |serial |`fpm test --compiler flang-new --flag -O3`
206+
LLVM/[Caffeine] |19 |serial |`fpm test --compiler flang-new --flag "-O3 -mmlir -allow-assumed-rank"`
207+
NAG |7.2, Build 7235|parallel|`NAGFORTRAN_NUM_IMAGES=2 fpm test --compiler nagfor --flag "-fpp -O3 -coarray"`
208+
Intel |2025.2.{0-1} |parallel|`FOR_COARRAY_NUM_IMAGES=2 fpm test --compiler ifx --flag "-fpp -O3 -coarray" --profile release`
209+
GCC/[OpenCoarrays]|14-15 |serial |`fpm test --compiler gfortran --profile release`
210+
GCC/[OpenCoarrays]|14-15 |parallel|`fpm test --compiler caf --runnner "cafrun -n 2" --profile release`
211+
GCC/[OpenCoarrays]|13 |serial |`fpm test --compiler gfortran --profile release --flag -ffree-line-length-none`
212+
GCC/[OpenCoarrays]|13 |parallel|`fpm test --compiler caf --runnner "cafrun -n 2" --profile release --flag -ffree-line-length-none`
213+
214+
The test output reports a test as skipped if there is a known issue that blocks
215+
the tested feature with the chosen compiler version or platform. Due to a
216+
GitHub continuous-integration (CI) issue, the default behavior is to skip the
217+
tests for Julienne's command-line parsing utility: `command_line_t`. To test
218+
`command_line_t`, add `-- --flag --test command_line_t --type` at the end of an
219+
`fpm` command.
220+
221+
### Useful preprocessor macros:
222+
To define the following macros or to override the values defined in Julienne's
223+
`include` directory, add `--flag -D<macro-name>=<value>` to an `fpm` command:
224+
225+
- `ASYNCHRONOUS_DIAGNOSTICS`: removes synchronizations that partially order
226+
test-failure diagnostics output for clarity
230227
- `ASSERTIONS`: enables checks for Julienne's own runtime assertions
231-
- `RUN_FALSE_ASSERTIONS`: runs tests of false assertions if ASSERTIONS is also defined
232-
233-
Julienne defines additional macros in the `include` directory.
234-
Users may also explicitly undefine or define any of Julienne's macros with `-D`.
228+
- `RUN_FALSE_ASSERTIONS`: runs false-assertion tests if ASSERTIONS is non-zero
235229

236230
Documentation
237231
-------------

0 commit comments

Comments
 (0)