Skip to content

Commit 36ea50d

Browse files
committed
remove short argument names and a few errata in documents
1 parent 2604d60 commit 36ea50d

File tree

5 files changed

+15
-15
lines changed

5 files changed

+15
-15
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ decisions. This is the workflow that we follow:
7777
one person disagrees.
7878
At this stage, the scope of the fix/feature, its behavior, and API if
7979
applicable should be defined.
80-
Only when you have community concensus on these items you should proceed to
80+
Only when you have community consensus on these items you should proceed to
8181
writing code and opening a PR.
8282
**When actively working on code towards a PR, please assign yourself to the
8383
issue on GitHub.**

PACKAGING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ Based on the output of `fpm build`, *fpm* first ran `gfortran` to emit the
177177
binary object (`math_constants.o`) and module (`math_constants.mod`) files.
178178
Then it ran `ar` to create a static library archive `math_constants.a`.
179179
`build/debug/library` is thus both your include and library path, should you
180-
want to compile and link an exteranl program with this library.
180+
want to compile and link an external program with this library.
181181

182182
For modules in the top-level (`src`) directory, *fpm* requires that:
183183

@@ -585,7 +585,7 @@ And now, `fpm run` will output the following:
585585
```
586586

587587
Additionally, any users of your library will now automatically depend on your
588-
dependencies too. So if you don’t need that depedency for the library, like in
588+
dependencies too. So if you don’t need that dependency for the library, like in
589589
the above example, then you can specify it for the specific executable like
590590
below. Then fpm will still fetch and compile it when building your executable,
591591
but users of your library won’t have to.
@@ -677,7 +677,7 @@ the build script:
677677
* `FC` – The Fortran compiler to be used.
678678
* `FFLAGS` – The flags that should be passed to the Fortran compiler.
679679
* `BUILD_DIR` – Where the compiled files should be placed.
680-
* `INCLUDE_DIRS` – The folders where any dependencies can be found, space seperated.
680+
* `INCLUDE_DIRS` – The folders where any dependencies can be found, space separated.
681681
It is then the responsibility of the build script to generate the appropriate
682682
include flags.
683683

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ with the following contents and initialized as a git repository.
6363

6464
* `fpm.toml` – with your project’s name and some default standard meta-data
6565
* `README.md` – with your project’s name
66-
* `.gitgnore`
66+
* `.gitignore`
6767
* `src/project_name.f90` – with a simple hello world subroutine
6868
* `app/main.f90` (if `--with-executable` flag used) – a program that calls the subroutine
6969
* `test/main.f90` (if `--with-test` flag used) – an empty test program

fpm/src/fpm_command_line.f90

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ subroutine get_command_line_settings(cmd_settings)
9999
select case(trim(cmdarg))
100100

101101
case('run')
102-
call set_args('--list:l F --release:r F --runner:c " " --',help_run,version_text)
102+
call set_args('--list F --release F --runner " " --',help_run,version_text)
103103

104104
if( size(unnamed) .gt. 1 )then
105105
names=unnamed(2:)
@@ -112,14 +112,14 @@ subroutine get_command_line_settings(cmd_settings)
112112
& release=lget('release'), args=remaining ,runner=sget('runner') )
113113

114114
case('build')
115-
call set_args( '--release:r F --list:l F --',help_build,version_text )
115+
call set_args( '--release F --list F --',help_build,version_text )
116116

117117
allocate( fpm_build_settings :: cmd_settings )
118118
cmd_settings=fpm_build_settings( release=lget('release'), &
119119
& list=lget('list') )
120120

121121
case('new')
122-
call set_args(' --src:s F --lib:l F --app:a F --test:t F --backfill:b F', &
122+
call set_args(' --src F --lib F --app F --test F --backfill F', &
123123
& help_new, version_text)
124124
select case(size(unnamed))
125125
case(1)
@@ -205,17 +205,17 @@ subroutine get_command_line_settings(cmd_settings)
205205
call printhelp(help_text)
206206

207207
case('install')
208-
call set_args('--release:r F ', help_install, version_text)
208+
call set_args('--release F ', help_install, version_text)
209209

210210
allocate(fpm_install_settings :: cmd_settings)
211211
case('list')
212-
call set_args(' --list:l F', help_list, version_text)
212+
call set_args(' --list F', help_list, version_text)
213213
call printhelp(help_list_nodash)
214214
if(lget('list'))then
215215
call printhelp(help_list_dash)
216216
endif
217217
case('test')
218-
call set_args('--list:l F --release:r F --runner:c " " --',help_test,version_text)
218+
call set_args('--list F --release F --runner " " --',help_test,version_text)
219219

220220
if( size(unnamed) .gt. 1 )then
221221
names=unnamed(2:)
@@ -230,7 +230,7 @@ subroutine get_command_line_settings(cmd_settings)
230230

231231
case default
232232

233-
call set_args(' --list:l F', help_fpm, version_text)
233+
call set_args(' --list F', help_fpm, version_text)
234234
! Note: will not get here if --version or --usage or --help
235235
! is present on commandline
236236
help_text=help_usage

manifest-reference.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ copyright = "Copyright 2020 Jane Doe"
131131

132132
## Project description
133133

134-
The decription provides a short summary on the project.
134+
The description provides a short summary on the project.
135135
It should be plain text and not using any markup formatting.
136136

137137
*Example:*
@@ -184,7 +184,7 @@ Library targets are exported and useable for other projects.
184184

185185
Defines the exported library target of the project.
186186
A library is generated if the source directory is found in a project.
187-
The default source directory is ``src`` but can be modifed in the *library* section using the *source-dir* entry.
187+
The default source directory is ``src`` but can be modified in the *library* section using the *source-dir* entry.
188188
Paths for the source directory are given relative to the project root and use ``/`` as path separator on all platforms.
189189

190190
*Example:*
@@ -199,7 +199,7 @@ source-dir = "lib"
199199
> Supported in Bootstrap fpm only
200200
201201
Projects with custom build scripts can specify those in the *build-script* entry.
202-
The custom build script will be executeted when the library build step is reached.
202+
The custom build script will be executed when the library build step is reached.
203203

204204
*Example:*
205205

0 commit comments

Comments
 (0)