Skip to content

Commit 3fd1aef

Browse files
authored
CMake README documentation typo fixes (#2189)
TYPE: text only KEYWORDS: cmake, documentation SOURCE: internal DESCRIPTION OF CHANGES: Problem: Typos in cmake documentation Solution: Fix of some typos and grammatical errors in the cmake README documentation
1 parent f11e381 commit 3fd1aef

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

doc/README.cmake_build

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ How to compile and run?
2424
be selectable via the interactive dialogs.
2525

2626
Compared to previous version of `configure` this will look much more sparse
27-
and the numbering will be changed to reflect what is availble. For this
27+
and the numbering will be changed to reflect what is available. For this
2828
reason it will be best to talk about configuration with their description
2929
or some other unique identifier from now on with this build methodology.
3030

@@ -48,10 +48,10 @@ How to compile and run?
4848
place a configuration)
4949

5050

51-
- If sucessful, this will create either `real` or `ideal` and `wrf` executables
51+
- If successful, this will create either `real` or `ideal` and `wrf` executables
5252
in the install location's bin/ directory (for default location this will be
5353
install/bin/) and the appropriate executables will be also copied into
54-
the respective test directoires under the same install directory as
54+
the respective test directories under the same install directory as
5555
<install location>/test/<case_name>. Likewise, for specific test cases that
5656
have additional or modified inputs, those input files are copied from the
5757
respective source location test/<test case>
@@ -67,7 +67,7 @@ How to compile and run?
6767

6868
./ideal
6969

70-
to produce wrfinput_d01 file for wrf model. Then type
70+
to produce wrfinput_d01 file for WRF. Then type
7171

7272
./wrf
7373

@@ -113,7 +113,7 @@ Advanced Configuration
113113

114114
The '-x' option allows the interactive dialogs to be suppressed, and
115115
configuration will immediately proceed with whatever options have been set or
116-
passed in. This is meant to be used with the '--' delimeter option
116+
passed in. This is meant to be used with the '--' delimiter option
117117

118118
The '-d' option allows us to specify an alternative build/configuration
119119
directory. As CMake best operates with out-of-source builds, our configuration
@@ -135,7 +135,7 @@ Advanced Configuration
135135
configuration is no longer desired. This also allows multiple installs of
136136
different compilations to coexist from within the same source repo
137137

138-
The '--' option is meant to be a delimeter marking all subsequent input to be
138+
The '--' option is meant to be a delimiter marking all subsequent input to be
139139
fed directly to the CMake command execution. In other words, after this marker
140140
anything that you place afterwards is as if you are directly passing in
141141
command line options to `cmake`. This allows you to more effectively use the
@@ -217,7 +217,7 @@ Advanced Configuration
217217
./cleanCMake.sh -b -d _buildCustomDirectory
218218

219219
One might think we would use the install directory when specifying the '-b'
220-
option, but recall that the install location is embeded into the build
220+
option, but recall that the install location is embedded into the build
221221
configuration and thus removing the installs that cmake did without entirely
222222
removing the install directory requires going to the build directory. This
223223
can be extremely versatile when installing into common locations where other

0 commit comments

Comments
 (0)