Skip to content

Commit

Permalink
[#674] Refresh command line help documentation
Browse files Browse the repository at this point in the history
- removes --commit-failures flag
- updates --variant flag description
  • Loading branch information
mengdaming committed Oct 1, 2024
1 parent c748bef commit af30534
Show file tree
Hide file tree
Showing 13 changed files with 13 additions and 26 deletions.
3 changes: 1 addition & 2 deletions doc/tcr.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ tcr [flags]
```
-p, --auto-push enable VCS push after every commit
-b, --base-dir string indicate the directory from which TCR is looking for files (default: current directory)
-F, --commit-failures enable committing reverts on tests failure
-c, --config-dir string indicate the directory where TCR configuration is stored (default: current directory)
-d, --duration duration set the duration for role rotation countdown timer
-h, --help help for tcr
Expand All @@ -28,7 +27,7 @@ tcr [flags]
-P, --port-number int indicate port number used by TCR HTTP server in web mode (experimental) (default: 8483)
-t, --toolchain string indicate the toolchain to be used by TCR
-T, --trace string indicate trace options. Recognized values: none (default), vcs or http
-r, --variant string indicate the variant to be used by TCR: nice (default) or original
-r, --variant string indicate the variant to be used by TCR: relaxed (default), btcr, or introspective
-V, --vcs string indicate the VCS (version control system) to be used by TCR: git (default) or p4
-w, --work-dir string indicate the directory from which TCR is running (default: current directory)
```
Expand Down
3 changes: 1 addition & 2 deletions doc/tcr_check.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,6 @@ tcr check [flags]
```
-p, --auto-push enable VCS push after every commit
-b, --base-dir string indicate the directory from which TCR is looking for files (default: current directory)
-F, --commit-failures enable committing reverts on tests failure
-c, --config-dir string indicate the directory where TCR configuration is stored (default: current directory)
-d, --duration duration set the duration for role rotation countdown timer
-l, --language string indicate the programming language to be used by TCR
Expand All @@ -55,7 +54,7 @@ tcr check [flags]
-P, --port-number int indicate port number used by TCR HTTP server in web mode (experimental) (default: 8483)
-t, --toolchain string indicate the toolchain to be used by TCR
-T, --trace string indicate trace options. Recognized values: none (default), vcs or http
-r, --variant string indicate the variant to be used by TCR: nice (default) or original
-r, --variant string indicate the variant to be used by TCR: relaxed (default), btcr, or introspective
-V, --vcs string indicate the VCS (version control system) to be used by TCR: git (default) or p4
-w, --work-dir string indicate the directory from which TCR is running (default: current directory)
```
Expand Down
3 changes: 1 addition & 2 deletions doc/tcr_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ tcr config [flags]
```
-p, --auto-push enable VCS push after every commit
-b, --base-dir string indicate the directory from which TCR is looking for files (default: current directory)
-F, --commit-failures enable committing reverts on tests failure
-c, --config-dir string indicate the directory where TCR configuration is stored (default: current directory)
-d, --duration duration set the duration for role rotation countdown timer
-l, --language string indicate the programming language to be used by TCR
Expand All @@ -33,7 +32,7 @@ tcr config [flags]
-P, --port-number int indicate port number used by TCR HTTP server in web mode (experimental) (default: 8483)
-t, --toolchain string indicate the toolchain to be used by TCR
-T, --trace string indicate trace options. Recognized values: none (default), vcs or http
-r, --variant string indicate the variant to be used by TCR: nice (default) or original
-r, --variant string indicate the variant to be used by TCR: relaxed (default), btcr, or introspective
-V, --vcs string indicate the VCS (version control system) to be used by TCR: git (default) or p4
-w, --work-dir string indicate the directory from which TCR is running (default: current directory)
```
Expand Down
3 changes: 1 addition & 2 deletions doc/tcr_config_reset.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ tcr config reset [flags]
```
-p, --auto-push enable VCS push after every commit
-b, --base-dir string indicate the directory from which TCR is looking for files (default: current directory)
-F, --commit-failures enable committing reverts on tests failure
-c, --config-dir string indicate the directory where TCR configuration is stored (default: current directory)
-d, --duration duration set the duration for role rotation countdown timer
-l, --language string indicate the programming language to be used by TCR
Expand All @@ -33,7 +32,7 @@ tcr config reset [flags]
-P, --port-number int indicate port number used by TCR HTTP server in web mode (experimental) (default: 8483)
-t, --toolchain string indicate the toolchain to be used by TCR
-T, --trace string indicate trace options. Recognized values: none (default), vcs or http
-r, --variant string indicate the variant to be used by TCR: nice (default) or original
-r, --variant string indicate the variant to be used by TCR: relaxed (default), btcr, or introspective
-V, --vcs string indicate the VCS (version control system) to be used by TCR: git (default) or p4
-w, --work-dir string indicate the directory from which TCR is running (default: current directory)
```
Expand Down
3 changes: 1 addition & 2 deletions doc/tcr_config_save.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ tcr config save [flags]
```
-p, --auto-push enable VCS push after every commit
-b, --base-dir string indicate the directory from which TCR is looking for files (default: current directory)
-F, --commit-failures enable committing reverts on tests failure
-c, --config-dir string indicate the directory where TCR configuration is stored (default: current directory)
-d, --duration duration set the duration for role rotation countdown timer
-l, --language string indicate the programming language to be used by TCR
Expand All @@ -33,7 +32,7 @@ tcr config save [flags]
-P, --port-number int indicate port number used by TCR HTTP server in web mode (experimental) (default: 8483)
-t, --toolchain string indicate the toolchain to be used by TCR
-T, --trace string indicate trace options. Recognized values: none (default), vcs or http
-r, --variant string indicate the variant to be used by TCR: nice (default) or original
-r, --variant string indicate the variant to be used by TCR: relaxed (default), btcr, or introspective
-V, --vcs string indicate the VCS (version control system) to be used by TCR: git (default) or p4
-w, --work-dir string indicate the directory from which TCR is running (default: current directory)
```
Expand Down
3 changes: 1 addition & 2 deletions doc/tcr_config_show.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ tcr config show [flags]
```
-p, --auto-push enable VCS push after every commit
-b, --base-dir string indicate the directory from which TCR is looking for files (default: current directory)
-F, --commit-failures enable committing reverts on tests failure
-c, --config-dir string indicate the directory where TCR configuration is stored (default: current directory)
-d, --duration duration set the duration for role rotation countdown timer
-l, --language string indicate the programming language to be used by TCR
Expand All @@ -33,7 +32,7 @@ tcr config show [flags]
-P, --port-number int indicate port number used by TCR HTTP server in web mode (experimental) (default: 8483)
-t, --toolchain string indicate the toolchain to be used by TCR
-T, --trace string indicate trace options. Recognized values: none (default), vcs or http
-r, --variant string indicate the variant to be used by TCR: nice (default) or original
-r, --variant string indicate the variant to be used by TCR: relaxed (default), btcr, or introspective
-V, --vcs string indicate the VCS (version control system) to be used by TCR: git (default) or p4
-w, --work-dir string indicate the directory from which TCR is running (default: current directory)
```
Expand Down
3 changes: 1 addition & 2 deletions doc/tcr_info.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ tcr info [flags]
```
-p, --auto-push enable VCS push after every commit
-b, --base-dir string indicate the directory from which TCR is looking for files (default: current directory)
-F, --commit-failures enable committing reverts on tests failure
-c, --config-dir string indicate the directory where TCR configuration is stored (default: current directory)
-d, --duration duration set the duration for role rotation countdown timer
-l, --language string indicate the programming language to be used by TCR
Expand All @@ -33,7 +32,7 @@ tcr info [flags]
-P, --port-number int indicate port number used by TCR HTTP server in web mode (experimental) (default: 8483)
-t, --toolchain string indicate the toolchain to be used by TCR
-T, --trace string indicate trace options. Recognized values: none (default), vcs or http
-r, --variant string indicate the variant to be used by TCR: nice (default) or original
-r, --variant string indicate the variant to be used by TCR: relaxed (default), btcr, or introspective
-V, --vcs string indicate the VCS (version control system) to be used by TCR: git (default) or p4
-w, --work-dir string indicate the directory from which TCR is running (default: current directory)
```
Expand Down
3 changes: 1 addition & 2 deletions doc/tcr_log.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ tcr log [flags]
```
-p, --auto-push enable VCS push after every commit
-b, --base-dir string indicate the directory from which TCR is looking for files (default: current directory)
-F, --commit-failures enable committing reverts on tests failure
-c, --config-dir string indicate the directory where TCR configuration is stored (default: current directory)
-d, --duration duration set the duration for role rotation countdown timer
-l, --language string indicate the programming language to be used by TCR
Expand All @@ -41,7 +40,7 @@ tcr log [flags]
-P, --port-number int indicate port number used by TCR HTTP server in web mode (experimental) (default: 8483)
-t, --toolchain string indicate the toolchain to be used by TCR
-T, --trace string indicate trace options. Recognized values: none (default), vcs or http
-r, --variant string indicate the variant to be used by TCR: nice (default) or original
-r, --variant string indicate the variant to be used by TCR: relaxed (default), btcr, or introspective
-V, --vcs string indicate the VCS (version control system) to be used by TCR: git (default) or p4
-w, --work-dir string indicate the directory from which TCR is running (default: current directory)
```
Expand Down
3 changes: 1 addition & 2 deletions doc/tcr_mob.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ tcr mob [flags]
```
-p, --auto-push enable VCS push after every commit
-b, --base-dir string indicate the directory from which TCR is looking for files (default: current directory)
-F, --commit-failures enable committing reverts on tests failure
-c, --config-dir string indicate the directory where TCR configuration is stored (default: current directory)
-d, --duration duration set the duration for role rotation countdown timer
-l, --language string indicate the programming language to be used by TCR
Expand All @@ -33,7 +32,7 @@ tcr mob [flags]
-P, --port-number int indicate port number used by TCR HTTP server in web mode (experimental) (default: 8483)
-t, --toolchain string indicate the toolchain to be used by TCR
-T, --trace string indicate trace options. Recognized values: none (default), vcs or http
-r, --variant string indicate the variant to be used by TCR: nice (default) or original
-r, --variant string indicate the variant to be used by TCR: relaxed (default), btcr, or introspective
-V, --vcs string indicate the VCS (version control system) to be used by TCR: git (default) or p4
-w, --work-dir string indicate the directory from which TCR is running (default: current directory)
```
Expand Down
3 changes: 1 addition & 2 deletions doc/tcr_one-shot.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@ tcr one-shot [flags]
```
-p, --auto-push enable VCS push after every commit
-b, --base-dir string indicate the directory from which TCR is looking for files (default: current directory)
-F, --commit-failures enable committing reverts on tests failure
-c, --config-dir string indicate the directory where TCR configuration is stored (default: current directory)
-d, --duration duration set the duration for role rotation countdown timer
-l, --language string indicate the programming language to be used by TCR
Expand All @@ -44,7 +43,7 @@ tcr one-shot [flags]
-P, --port-number int indicate port number used by TCR HTTP server in web mode (experimental) (default: 8483)
-t, --toolchain string indicate the toolchain to be used by TCR
-T, --trace string indicate trace options. Recognized values: none (default), vcs or http
-r, --variant string indicate the variant to be used by TCR: nice (default) or original
-r, --variant string indicate the variant to be used by TCR: relaxed (default), btcr, or introspective
-V, --vcs string indicate the VCS (version control system) to be used by TCR: git (default) or p4
-w, --work-dir string indicate the directory from which TCR is running (default: current directory)
```
Expand Down
3 changes: 1 addition & 2 deletions doc/tcr_solo.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ tcr solo [flags]
```
-p, --auto-push enable VCS push after every commit
-b, --base-dir string indicate the directory from which TCR is looking for files (default: current directory)
-F, --commit-failures enable committing reverts on tests failure
-c, --config-dir string indicate the directory where TCR configuration is stored (default: current directory)
-d, --duration duration set the duration for role rotation countdown timer
-l, --language string indicate the programming language to be used by TCR
Expand All @@ -33,7 +32,7 @@ tcr solo [flags]
-P, --port-number int indicate port number used by TCR HTTP server in web mode (experimental) (default: 8483)
-t, --toolchain string indicate the toolchain to be used by TCR
-T, --trace string indicate trace options. Recognized values: none (default), vcs or http
-r, --variant string indicate the variant to be used by TCR: nice (default) or original
-r, --variant string indicate the variant to be used by TCR: relaxed (default), btcr, or introspective
-V, --vcs string indicate the VCS (version control system) to be used by TCR: git (default) or p4
-w, --work-dir string indicate the directory from which TCR is running (default: current directory)
```
Expand Down
3 changes: 1 addition & 2 deletions doc/tcr_stats.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,6 @@ tcr stats [flags]
```
-p, --auto-push enable VCS push after every commit
-b, --base-dir string indicate the directory from which TCR is looking for files (default: current directory)
-F, --commit-failures enable committing reverts on tests failure
-c, --config-dir string indicate the directory where TCR configuration is stored (default: current directory)
-d, --duration duration set the duration for role rotation countdown timer
-l, --language string indicate the programming language to be used by TCR
Expand All @@ -61,7 +60,7 @@ tcr stats [flags]
-P, --port-number int indicate port number used by TCR HTTP server in web mode (experimental) (default: 8483)
-t, --toolchain string indicate the toolchain to be used by TCR
-T, --trace string indicate trace options. Recognized values: none (default), vcs or http
-r, --variant string indicate the variant to be used by TCR: nice (default) or original
-r, --variant string indicate the variant to be used by TCR: relaxed (default), btcr, or introspective
-V, --vcs string indicate the VCS (version control system) to be used by TCR: git (default) or p4
-w, --work-dir string indicate the directory from which TCR is running (default: current directory)
```
Expand Down
3 changes: 1 addition & 2 deletions doc/tcr_web.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ tcr web [flags]
```
-p, --auto-push enable VCS push after every commit
-b, --base-dir string indicate the directory from which TCR is looking for files (default: current directory)
-F, --commit-failures enable committing reverts on tests failure
-c, --config-dir string indicate the directory where TCR configuration is stored (default: current directory)
-d, --duration duration set the duration for role rotation countdown timer
-l, --language string indicate the programming language to be used by TCR
Expand All @@ -39,7 +38,7 @@ tcr web [flags]
-P, --port-number int indicate port number used by TCR HTTP server in web mode (experimental) (default: 8483)
-t, --toolchain string indicate the toolchain to be used by TCR
-T, --trace string indicate trace options. Recognized values: none (default), vcs or http
-r, --variant string indicate the variant to be used by TCR: nice (default) or original
-r, --variant string indicate the variant to be used by TCR: relaxed (default), btcr, or introspective
-V, --vcs string indicate the VCS (version control system) to be used by TCR: git (default) or p4
-w, --work-dir string indicate the directory from which TCR is running (default: current directory)
```
Expand Down

0 comments on commit af30534

Please sign in to comment.