Skip to content

Commit bccff34

Browse files
committed
Apply documentation patch from @arjenmarkus
Fixes #582
1 parent 709969f commit bccff34

File tree

2 files changed

+18
-13
lines changed

2 files changed

+18
-13
lines changed

INSTALL

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ Before you start
6666
* Your environment is setup to use the compilers you wish to build and use
6767
OpenCoarrays with. (LD_LIBRARY_PATH is set, if needed, etc.)
6868

69-
Also, you will need the OpenCoarrays source, which, you presumably already
69+
Also, you will need the OpenCoarrays source, which you presumably already
7070
have if you are reading this. The latest stable OpenCoarrays release can be
7171
obtained at:
7272

@@ -81,7 +81,7 @@ Before you start
8181
Configure, build and install OpenCoarrays
8282
-----------------------------------------
8383

84-
OpenCoarrays does *NOT* allow in source builds. Once you have obtained the
84+
OpenCoarrays does *NOT* allow in-source builds. Once you have obtained the
8585
source code, you must create a build directory. This may be a subdirectory of
8686
the top level source directory, or in a completely un-related location.
8787

@@ -113,7 +113,7 @@ Configure, build and install OpenCoarrays
113113
Configure options
114114
-----------------
115115

116-
The OpenCoarrays build system attempts to set the best possible defailt
116+
The OpenCoarrays build system attempts to set the best possible default
117117
settings for your Fortran compiler and MPI implementation through intro-
118118
spection. However, some bugs or use cases may warrant tweaking the config-
119119
uration. Each of the following options may be set using the `-D` flag to
@@ -125,7 +125,7 @@ Configure options
125125

126126
CMAKE_INSTALL_PREFIX
127127
Tell cmake where to install OpenCoarrays. Default=/usr/local
128-
Example: cmake .. -DCMAKE_INSTALL_PREFIX=/opt/OpenCoarrays/1.9.1
128+
Example: cmake .. -DCMAKE_INSTALL_PREFIX=/opt/OpenCoarrays/2.2.0
129129

130130
CMAKE_BUILD_TYPE
131131
Specify the build type. Default value: Release
@@ -140,7 +140,7 @@ Configure options
140140
CAF_ENABLE_FAILED_IMAGES
141141
Enable failed image support. Defaults to TRUE if experimental fault
142142
tolerance features are detected to be present in the MPI
143-
implementation. FALSE/unavailable if no MPI support is present
143+
implementation. FALSE/unavailable if the MPI installation does not support it
144144
Example: cmake .. -DCAF_ENABLE_FAILED_IMAGES=FALSE
145145

146146
CAF_EXPOSE_INIT_FINALIZE

INSTALL.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -85,9 +85,9 @@ source.
8585

8686
### macOS ###
8787

88-
* [Homebrew]:
89-
[![homebrew][Homebrew badge]][braumeister link]
90-
This is the recommend OpenCoarrays installation method on macOS.
88+
* [Homebrew]:
89+
[![homebrew][Homebrew badge]][braumeister link]
90+
This is the recommended OpenCoarrays installation method on macOS.
9191
Basic Homebrew installation steps:
9292

9393
```
@@ -106,7 +106,7 @@ source.
106106
brew bundle
107107
```
108108

109-
* [MacPorts]:
109+
* [MacPorts]:
110110
An unmaintained [OpenCoarrays Portfile] exists for the [MacPorts] package
111111
manager. Although the current OpenCoarrays contributors have no plans to
112112
update the portfile, new contributors are welcome to asssume the port
@@ -140,9 +140,13 @@ or pre-installed copies:
140140
distributions
141141

142142
[linuxbrew] does not require `sudo` privileges and will generally
143-
provide the most up-to-date OpenCoarrays release because linxubrew
143+
provide the most up-to-date OpenCoarrays release because linuxbrew
144144
pulls directly from macOS homebrew, which updates automatically.
145145

146+
Note that distributions are often split into two parts: a "binary" package with the
147+
runtime libraries and a "development" package for developing programs yourself.
148+
Be sure to install both packages.
149+
146150
<a name="easybuild"></a>
147151
With [EasyBuild], the following bash commands install OpenCoarrays:
148152

@@ -175,9 +179,9 @@ spack spec opencoarrays
175179
# to be installed to compile OpenMPI)
176180
spack install opencoarrays
177181

178-
# Or, To install with customisations (e.g., to install OpenCoarrays [version 1.9.0]
182+
# Or, To install with customisations (e.g., to install OpenCoarrays [version 2.2.0]
179183
# with MPICH [version default] and GCC [version 7.1.0]).
180-
spack install opencoarrays@1.9.0 ^mpich %[email protected]
184+
spack install opencoarrays@2.2.0 ^mpich %[email protected]
181185
```
182186

183187
In the previous example, it was assumed that GCC [version 7.1.0] is
@@ -275,6 +279,7 @@ of flags. Each flag also has a single-character version not shown here.
275279
```
276280

277281
4. Install only a specific prerequisite package (the default version):
282+
278283
```
279284
./install.sh --package mpich
280285
```
@@ -352,7 +357,7 @@ this document [here][Developer Build and Install].
352357
Unlike the Makefiles that CMake generates automatically for the chosen
353358
platform, static Makefiles require a great deal more maintenance and are
354359
less portable. Also, the static Makefiles provided in [src] lack several
355-
several important capabilities. In particular, they will not build the tests;
360+
important capabilities. In particular, they will not build the tests;
356361
they will not generate the `caf` compiler wrapper that ensures correct linking
357362
and `cafrun` program launcher that ensures support for advanced features such
358363
as Fortran 2015 failed images; they will not build the [opencoarrays] module

0 commit comments

Comments
 (0)