Skip to content

Commit f2e31c3

Browse files
committed
Fix typos in doc.
1 parent 3e3716b commit f2e31c3

File tree

2 files changed

+24
-22
lines changed

2 files changed

+24
-22
lines changed

README

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ is managing. For example, if you cloned CLM with:
3535

3636
$ git clone [email protected]/ncar/clm clm-dev
3737

38-
Then the root of the source tree is /path/to/cesm-dev. If you obtained
38+
Then the root of the source tree is /path/to/clm-dev. If you obtained
3939
CLM via an svn checkout of CESM and you need to checkout the CLM
4040
externals, then the root of the source tree for CLM is:
4141

@@ -52,15 +52,16 @@ The root of the source tree will be referred to as ${SRC_ROOT} below.
5252
$ ./checkout_cesm/checkout_externals.py
5353

5454
* To update all required components to the current values in the
55-
model description file, re-run $(prog)s:
55+
model description file, re-run checkout_externals.py:
5656

5757
$ cd ${SRC_ROOT}
5858
$ ./checkout_cesm/checkout_externals.py
5959

6060
If there are *any* modifications to *any* working copy according
61-
to the git or svn 'status' command, $(prog)s will not update any
62-
repositories in the model. Modifications include: modified files,
63-
added files, removed files, missing files or untracked files,
61+
to the git or svn 'status' command, checkout_externals.py
62+
will not update any repositories in the model. Modifications
63+
include: modified files, added files, removed files, missing
64+
files or untracked files,
6465

6566
* Checkout all required components from a user specified model
6667
description file:
@@ -114,15 +115,15 @@ The root of the source tree will be referred to as ${SRC_ROOT} below.
114115

115116
* required (boolean) : whether the component is a required checkout
116117

117-
* path (string) : component path *relative* to where checkout_externals.py
118-
is called.
118+
* local_path (string) : component path *relative* to where
119+
checkout_externals.py is called.
119120

120121
* protoctol (string) : version control protocol that is used to
121122
manage the component. Valid values are 'git', 'svn',
122123
'externals_only'.
123124

124125
Note: 'externals_only' will only process the externals model
125-
description file without trying to manage a repositor for the
126+
description file without trying to manage a repository for the
126127
component. This is used for retreiving externals for standalone
127128
components like cam and clm.
128129

@@ -137,7 +138,7 @@ The root of the source tree will be referred to as ${SRC_ROOT} below.
137138

138139
* externals (string) : relative path to the external model
139140
description file that should also be used. It is *relative* to the
140-
component path. For example, the CESM model description will load
141-
clm. CLM has additional externals that must be downloaded to be
142-
complete. Those additional externals are managed from the clm
141+
component local_path. For example, the CESM model description will
142+
load clm. CLM has additional externals that must be downloaded to
143+
be complete. Those additional externals are managed from the clm
143144
source root by the file pointed to by 'externals'.

checkout_externals.py

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ def commandline_arguments():
102102
103103
$ git clone [email protected]/ncar/clm clm-dev
104104
105-
Then the root of the source tree is /path/to/cesm-dev. If you obtained
105+
Then the root of the source tree is /path/to/clm-dev. If you obtained
106106
CLM via an svn checkout of CESM and you need to checkout the CLM
107107
externals, then the root of the source tree for CLM is:
108108
@@ -120,15 +120,16 @@ def commandline_arguments():
120120
$ ./checkout_cesm/%(prog)s
121121
122122
* To update all required components to the current values in the
123-
model description file, re-run $(prog)s:
123+
model description file, re-run %(prog)s:
124124
125125
$ cd ${SRC_ROOT}
126126
$ ./checkout_cesm/%(prog)s
127127
128128
If there are *any* modifications to *any* working copy according
129-
to the git or svn 'status' command, $(prog)s will not update any
130-
repositories in the model. Modifications include: modified files,
131-
added files, removed files, missing files or untracked files,
129+
to the git or svn 'status' command, %(prog)s
130+
will not update any repositories in the model. Modifications
131+
include: modified files, added files, removed files, missing
132+
files or untracked files,
132133
133134
* Checkout all required components from a user specified model
134135
description file:
@@ -182,15 +183,15 @@ def commandline_arguments():
182183
183184
* required (boolean) : whether the component is a required checkout
184185
185-
* path (string) : component path *relative* to where %(prog)s
186-
is called.
186+
* local_path (string) : component path *relative* to where
187+
%(prog)s is called.
187188
188189
* protoctol (string) : version control protocol that is used to
189190
manage the component. Valid values are 'git', 'svn',
190191
'externals_only'.
191192
192193
Note: 'externals_only' will only process the externals model
193-
description file without trying to manage a repositor for the
194+
description file without trying to manage a repository for the
194195
component. This is used for retreiving externals for standalone
195196
components like cam and clm.
196197
@@ -205,9 +206,9 @@ def commandline_arguments():
205206
206207
* externals (string) : relative path to the external model
207208
description file that should also be used. It is *relative* to the
208-
component path. For example, the CESM model description will load
209-
clm. CLM has additional externals that must be downloaded to be
210-
complete. Those additional externals are managed from the clm
209+
component local_path. For example, the CESM model description will
210+
load clm. CLM has additional externals that must be downloaded to
211+
be complete. Those additional externals are managed from the clm
211212
source root by the file pointed to by 'externals'.
212213
213214
'''

0 commit comments

Comments
 (0)