Skip to content

Commit 90e1409

Browse files
urbanjosturbanjost
committed
Updated documentation
Just a few documentation tweaks. Since the documentation has to change for this PR anyway, cleaned up a few dusty corners primarily for the "run" subcommand that needed updated to reflect building now being the default for a run subcommand, for clarity, and to reflect the auto-build abilitites not available.
1 parent 1b372be commit 90e1409

File tree

1 file changed

+18
-17
lines changed

1 file changed

+18
-17
lines changed

‎fpm/src/fpm_command_line.f90

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -498,16 +498,15 @@ subroutine set_help()
498498
' "fpm --help" or "fpm SUBCOMMAND --help" for detailed descriptions. ', &
499499
' ']
500500
help_list_dash = [character(len=80) :: &
501-
!123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890
502501
' ', &
503502
' build [--compiler COMPILER_NAME] [--release] [--list] ', &
504503
' help [NAME(s)] ', &
505504
' new NAME [[--lib|--src] [--app] [--test] [--example]]| ', &
506505
' [--full|--bare][--backfill] ', &
507506
' update [NAME(s)] [--fetch-only] [--clean] [--verbose] ', &
508507
' list [--list] ', &
509-
' run [[--target] NAME(s)|--all] [--release] [--runner "CMD"] [--list] [--example]', &
510-
' [--compiler COMPILER_NAME] [-- ARGS] ', &
508+
' run [[--target] NAME(s)|--all] [--example] [--release] [--runner "CMD"] ', &
509+
' [--compiler COMPILER_NAME] [--list] [-- ARGS] ', &
511510
' test [[--target] NAME(s)] [--release] [--runner "CMD"] [--list] ', &
512511
' [--compiler COMPILER_NAME] [-- ARGS] ', &
513512
' install [--release] [--no-rebuild] [--prefix PATH] [options] ', &
@@ -589,7 +588,7 @@ subroutine set_help()
589588
' ', &
590589
'DESCRIPTION ', &
591590
' fpm(1) is a package manager that helps you create Fortran projects ', &
592-
' from source. ', &
591+
' from source -- it automatically determines dependencies! ', &
593592
' ', &
594593
' Most significantly fpm(1) lets you draw upon other fpm(1) packages ', &
595594
' in distributed git(1) repositories as if the packages were a basic ', &
@@ -697,11 +696,11 @@ subroutine set_help()
697696
' fpm run --help|--version ', &
698697
' ', &
699698
'DESCRIPTION ', &
700-
' Run applications you have built in your fpm(1) project. ', &
701-
' By default applications in /app or specified as "executable" in your ', &
702-
' "fpm.toml" manifest are used. Alternatively demonstration programs ', &
703-
' in example/ or specified in the "example" section in "fpm.toml" ', &
704-
' can be executed. ', &
699+
' Run the applications in your fpm(1) package. By default applications ', &
700+
' in /app or specified as "executable" in your "fpm.toml" manifest are ', &
701+
' used. Alternatively demonstration programs in example/ or specified in', &
702+
' the "example" section in "fpm.toml" can be executed. The applications ', &
703+
' are automatically rebuilt before being run if they are out of date. ', &
705704
' ', &
706705
'OPTIONS ', &
707706
' --target NAME(s) list of specific application names to execute. ', &
@@ -713,33 +712,35 @@ subroutine set_help()
713712
' any single character and "*" represents any string. ', &
714713
' Therefore a quoted asterisk ''*'' runs all programs. ', &
715714
' --all An alias for "--target ''*''". All targets are selected. ', &
716-
' --example run example programs instead of applications ', &
715+
' --example Run example programs instead of applications. ', &
717716
' --release selects the optimized build instead of the debug build. ', &
718717
' --compiler COMPILER_NAME Specify a compiler name. The default is ', &
719718
' "gfortran" unless set by the environment ', &
720719
' variable FPM_COMPILER. ', &
721720
' --runner CMD A command to prefix the program execution paths with. ', &
722721
' see "fpm help runner" for further details. ', &
723-
' --list list candidates instead of building or running them. ', &
722+
' --list list pathname of candidates instead of running them. Note ', &
723+
' out-of-date candidates will still be rebuilt before being ', &
724+
' listed. ', &
724725
' -- ARGS optional arguments to pass to the program(s). The same ', &
725726
' arguments are passed to all program names specified. ', &
726727
' ', &
727728
'EXAMPLES ', &
728729
' fpm(1) - run project applications: ', &
729730
' ', &
730731
' # run all default programs in /app or as specified in "fpm.toml" ', &
731-
' fpm run ''*'' ', &
732+
' fpm run --all ', &
732733
' ', &
733-
' # run default program using the compiler command "f90". If more ', &
734-
' # than one app exists a list displays and names must be specified. ', &
734+
' # run default program built or to be built with the compiler command ', &
735+
' # "f90". If more than one app exists a list displays and target names', &
736+
' # are required. ', &
735737
' fpm run --compiler f90 ', &
736738
' ', &
737-
' # run example demonstration programs instead of the application ', &
738-
' # programs ( defaults can be overridden in "fpm.toml"). ', &
739+
' # run example programs instead of the application programs. ', &
739740
' fpm run --example ''*'' ', &
740741
' ', &
741742
' # run a specific program and pass arguments to the command ', &
742-
' fpm run mytest -- -x 10 -y 20 --title "my title line" ', &
743+
' fpm run myprog -- -x 10 -y 20 --title "my title line" ', &
743744
' ', &
744745
' # run production version of two applications ', &
745746
' fpm run --target prg1,prg2 --release ', &

0 commit comments

Comments
 (0)