Skip to content

Commit 21eb86d

Browse files
committed
[#403] Update cobra-generated doc with "retro" subcommand
1 parent ab7b1a8 commit 21eb86d

File tree

2 files changed

+54
-0
lines changed

2 files changed

+54
-0
lines changed

doc/tcr.md

+1
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ tcr [flags]
4141
* [tcr log](tcr_log.md) - Print the TCR commit history
4242
* [tcr mob](tcr_mob.md) - Run TCR in mob mode
4343
* [tcr one-shot](tcr_one-shot.md) - Run one TCR cycle and exit
44+
* [tcr retro](tcr_retro.md) - Generate retrospective template with stats
4445
* [tcr solo](tcr_solo.md) - Run TCR in solo mode
4546
* [tcr stats](tcr_stats.md) - Print TCR stats
4647
* [tcr web](tcr_web.md) - Run TCR with web user interface (experimental)

doc/tcr_retro.md

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
## tcr retro
2+
3+
Generate retrospective template with stats
4+
5+
### Synopsis
6+
7+
8+
TCR retro subcommand generates a retrospective template in markdown format prefilled with TCR execution info.
9+
The markdown file is saved into the TCR base directory with the name 'tcr-retro.md'.
10+
11+
The following information is included in the markdown:
12+
13+
- Average size of changes per passing commit
14+
- Average size of changes per failing commit
15+
16+
These stats are extracted for the repository containing TCR base directory (cf. -b option).
17+
The branch is the current working branch set for this repository.
18+
19+
This subcommand does not start TCR engine.
20+
21+
```
22+
tcr retro [flags]
23+
```
24+
25+
### Options
26+
27+
```
28+
-h, --help help for retro
29+
```
30+
31+
### Options inherited from parent commands
32+
33+
```
34+
-p, --auto-push enable VCS push after every commit
35+
-b, --base-dir string indicate the directory from which TCR is looking for files (default: current directory)
36+
-c, --config-dir string indicate the directory where TCR configuration is stored (default: current directory)
37+
-d, --duration duration set the duration for role rotation countdown timer
38+
-g, --git-remote string name of the git remote repository to sync with (default: "origin")
39+
-l, --language string indicate the programming language to be used by TCR
40+
-m, --message-suffix string indicate text to append at the end of TCR commit messages (ex: "[#1234]")
41+
-o, --polling duration set VCS polling period when running as navigator
42+
-P, --port-number int indicate port number used by TCR HTTP server in web mode (experimental) (default: 8483)
43+
-t, --toolchain string indicate the toolchain to be used by TCR
44+
-T, --trace string indicate trace options. Recognized values: none (default), vcs or http
45+
-r, --variant string indicate the variant to be used by TCR: relaxed (default), btcr, or introspective
46+
-V, --vcs string indicate the VCS (version control system) to be used by TCR: git (default) or p4
47+
-w, --work-dir string indicate the directory from which TCR is running (default: current directory)
48+
```
49+
50+
### SEE ALSO
51+
52+
* [tcr](tcr.md) - TCR (Test && Commit || Revert)
53+

0 commit comments

Comments
 (0)