Skip to content

Commit 04a4e51

Browse files
authored
Merge pull request #303 from bonachea/doc-polish
docs: misc copy-editing
2 parents 4068062 + d3ac943 commit 04a4e51

3 files changed

Lines changed: 18 additions & 12 deletions

File tree

README.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,25 +24,26 @@ program that execute asynchronously in shared or distributed memory, except
2424
where a program uses specific synchronization mechanisms. Fortran's
2525
coarray feature provides distributed data structures that offer a subscripted,
2626
multidimensional array notation defining a partitioned global address space
27-
(PGAS). One image can use the cosubscript notation to perform one-sided access
27+
(PGAS). One image can use a coindexed notation to perform one-sided access
2828
of coarray data associated with another image.
2929

30-
Fortran 2018 greatly expanded this feature set to include such concepts as
30+
Fortran 2018 greatly expanded this feature set to include concepts such as
3131
teams (groupings) of images, events (counting semaphores), collective
3232
subroutines and failed-image detection (fault tolerance). Fortran 2023 provided
3333
additional, minor multi-image extensions, including notified remote data access.
3434

3535
Several popular Fortran compilers, including [LLVM Flang](https://flang.llvm.org/docs/FortranStandardsSupport.html)
36-
and LFortran, currently
36+
and [LFortran](https://github.com/lfortran/lfortran), currently
3737
lack complete support for multi-image parallel execution. These features are a mandatory
3838
part of Fortran, and thus are an important part of reaching full compliance with
39-
the 2008, 2018, or 2023 versions of the Fortran standard. Thanks to PRIF and Caffeine,
40-
the forthcoming LLVM Flang 22 release is expected to support a meaningful subset of
41-
multi-image Fortran features. For more details, see
42-
[LLVM-HPC2025 paper](#Additional-Publications) below.
39+
the 2008, 2018, or 2023 revisions of the Fortran standard.
40+
The latest LLVM Flang 22 release adds experimental support for a
41+
[meaningful subset](https://flang.llvm.org/docs/FortranStandardsSupport.html#fortran-2018)
42+
of multi-image Fortran features using PRIF and Caffeine.
43+
For more details, see [LLVM-HPC2025 paper](#Additional-Publications) below.
4344

4445
Caffeine provides a portable, high-performance and open-source parallel
45-
runtime library that such compilers can target in code generation as part of
46+
runtime library that compilers can target in code generation as part of
4647
their solution to support Fortran's multi-image parallel features.
4748

4849
Prerequisites & Dependencies
@@ -132,10 +133,16 @@ using Fortran's multi-image features to print a message from each image.
132133

133134
Run tests
134135
---------
136+
137+
After installation, one can optionally issue the following command to run
138+
Caffeine's correctness unit tests to exercise the PRIF subroutines:
139+
135140
```
136141
./run-fpm.sh test
137142
```
138143

144+
Note that some unit tests are conditionally skipped based on platform and configuration details.
145+
139146
Recognized Environment Variables
140147
--------------------------------
141148

docs/README-release.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Release Procedure for Caffeine
3535
2. When testing on Perlmutter, use the following steps:
3636
1. Build source and tests on the login node using the desired compiler
3737
2. Get a dedicated node: `salloc -t 10 -N 2 -n 8 -q interactive -A PROJECT_ID -C cpu`
38-
3. Launch the parallel job to run the tests: `env SUBJOB_PREFIX=skip GASNET_SUPERNODE_MAXSIZE=2 CAF_IMAGES=8 build/run-fpm.sh test --verbose`
38+
3. Launch the parallel job to run the tests: `env SUBJOB_PREFIX=skip GASNET_SPAWN_VERBOSE=1 GASNET_SUPERNODE_MAXSIZE=2 CAF_IMAGES=8 build/run-fpm.sh test --verbose`
3939
8. Create annotated tag (only after release candidate has been checked by team members)
4040
For example `git tag -a #.#.# -m "release version #.#.#"`, then `git push origin #.#.#`
4141
9. Publish the release

docs/implementation-status.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,11 @@ more details about the implementation of the various PRIF features, please see t
88
following sections:
99

1010
- [Named Constants](#Named-Constants)
11-
- [`stat` and `errmsg` support](#stat-and-errmsg-support)
1211
- [Program Startup and Shutdown](#Program-Startup-and-Shutdown)
1312
- [Image Queries](#Image-Queries)
1413
- [Storage Management](#Storage-Management)
1514
- [Coarray Queries](#Coarray-Queries)
16-
- [Continguous Coarray Access](#Continguous-Coarray-Access)
15+
- [Contiguous Coarray Access](#Contiguous-Coarray-Access)
1716
- [Strided Coarray Access](#Strided-Coarray-Access)
1817
- [SYNC Statements](#SYNC-Statements)
1918
- [Locks and Unlocks](#Locks-and-Unlocks)
@@ -23,7 +22,7 @@ following sections:
2322
- [Collectives](#Collectives)
2423
- [Atomic Memory Operations](#Atomic-Memory-Operations)
2524

26-
The priorites for feature implementation and addressing known defects is communicated by
25+
The priorites for feature implementation and addressing known defects are communicated by
2726
the labels in the Caffeine [issue tracker](https://github.com/BerkeleyLab/caffeine/issues).
2827

2928
## Named Constants

0 commit comments

Comments
 (0)