josh/rscons
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Expand CLI usage printout

Browse Source
This commit is contained in:
Josh Holtrop 2022-02-27 16:02:00 -05:00
parent 88a8f2395d
commit 6a10d68fac
2 changed files with 88 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
doc/user_guide.md
View File

@ -147,17 +147,49 @@ Rscons is typically invoked from the command-line as `./rscons`.
Usage: ./rscons [global options] [[task] [task options] ...] Usage: ./rscons [global options] [[task] [task options] ...]
Global options: Global options:
-A, --all Show all tasks (even without descriptions) in task list -A, --all
-b BUILD, --build=BUILD Set build directory (default: build) Show all tasks (even those without descriptions) in task list. Use in
-e VS, --variants=VS Enable or disable variants conjunction with the -T argument.
-f FILE Use FILE as Rsconscript
-F, --show-failure Show failed command log from previous build and exit -b BUILD, --build=BUILD
-h, --help Show rscons help and exit Set build directory (default: build).
-j N, --nthreads=N Set number of threads
-r COLOR, --color=COLOR Set color mode (off, auto, force) -e VS, --variants=VS
-T, --tasks Show task list and parameters and exit Enable or disable variants. VS is a comma-separated list of variant
-v, --verbose Run verbosely entries. If the entry begins with "-" the variant is disabled instead of
--version Show rscons version and exit enabled. If the full list begins with "+" or "-" then it modifies the
variants that are enabled by default by only enabling or disabling the
listed variants. Otherwise, the enabled set of variants is as given and
any variants not listed are disabled. The set of enabled variants is
remembered from when the project is configured.
-f FILE
Use FILE as Rsconscript.
-F, --show-failure
Show failed command log from previous build and exit (does not load build
script).
-h, --help
Show rscons help and exit (does not load build script).
-j N, --nthreads=N
Set number of threads (local default: 16).
-r COLOR, --color=COLOR
Set color mode (off, auto, force).
-T, --tasks
Show task list and parameters and exit (loads build script). By default
only tasks with a description are listed. Use -AT to show all tasks whether
they have a description or not.
-v, --verbose
Run verbosely. This causes Rscons to print the full build command used by
each builder.
--version
Show rscons version and exit (does not load build script).
The user can list any number of tasks on the command line. The user can list any number of tasks on the command line.
Any parameters beginning with a "-" that follow a task are interpreted as task Any parameters beginning with a "-" that follow a task are interpreted as task
@ -190,9 +222,9 @@ will cause Rscons to print each command it is executing.
When Rscons executes, it performs the following phases: When Rscons executes, it performs the following phases:
- Parse the command line. - Parse the command line.
- Exit if --help or --version specified. - This is the last step if --help, --version, or --show-failure is specified.
- Load the build script. - Load the build script.
- Show tasks and exit if -T specified. - This is the last step if --tasks is specified.
- Configure the project by running the `configure` task if necessary (the - Configure the project by running the `configure` task if necessary (the
project has not yet been configured, autoconf is set to true, and the user project has not yet been configured, autoconf is set to true, and the user
is requesting to execute a task that is marked with autoconf set to true) is requesting to execute a task that is marked with autoconf set to true)

54
lib/rscons/cli.rb
View File

@ -149,17 +149,49 @@ module Rscons
Usage: #{$0} [global options] [[task] [task options] ...] Usage: #{$0} [global options] [[task] [task options] ...]
Global options: Global options:
-A, --all Show all tasks (even without descriptions) in task list -A, --all
-b BUILD, --build=BUILD Set build directory (default: build) Show all tasks (even those without descriptions) in task list. Use in
-e VS, --variants=VS Enable or disable variants conjunction with the -T argument.
-f FILE Use FILE as Rsconscript
-F, --show-failure Show failed command log from previous build and exit -b BUILD, --build=BUILD
-h, --help Show rscons help and exit Set build directory (default: build).
-j N, --nthreads=N Set number of threads (local default: #{Rscons.application.n_threads})
-r COLOR, --color=COLOR Set color mode (off, auto, force) -e VS, --variants=VS
-T, --tasks Show task list and parameters and exit Enable or disable variants. VS is a comma-separated list of variant
-v, --verbose Run verbosely entries. If the entry begins with "-" the variant is disabled instead of
--version Show rscons version and exit enabled. If the full list begins with "+" or "-" then it modifies the
variants that are enabled by default by only enabling or disabling the
listed variants. Otherwise, the enabled set of variants is as given and
any variants not listed are disabled. The set of enabled variants is
remembered from when the project is configured.
-f FILE
Use FILE as Rsconscript.
-F, --show-failure
Show failed command log from previous build and exit (does not load build
script).
-h, --help
Show rscons help and exit (does not load build script).
-j N, --nthreads=N
Set number of threads (local default: #{Rscons.application.n_threads}).
-r COLOR, --color=COLOR
Set color mode (off, auto, force).
-T, --tasks
Show task list and parameters and exit (loads build script). By default
only tasks with a description are listed. Use -AT to show all tasks whether
they have a description or not.
-v, --verbose
Run verbosely. This causes Rscons to print the full build command used by
each builder.
--version
Show rscons version and exit (does not load build script).
EOF EOF
end end