Skip to content

Commit bf30883

Browse files
authored
Merge pull request #4764 from davidjenni/fix-tool-diag-doc
doc: update CLI/tool documentation for /diag argument
2 parents 24cf318 + dc77d63 commit bf30883

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

docs/input/docs/usage/cli/arguments.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@ GitVersion [path]
2424
path The directory containing .git. If not defined current
2525
directory is used. (Must be first argument)
2626
/version Displays the version of GitVersion
27-
/diag Runs GitVersion with additional diagnostic information
27+
/diag Runs GitVersion with additional diagnostic information;
28+
also needs the '/l' argument to specify a logfile or stdout
2829
(requires git.exe to be installed)
2930
/h or /? Shows Help
3031

@@ -41,7 +42,7 @@ GitVersion [path]
4142
Supports C# format strings - see [Format Strings](/docs/reference/custom-formatting) for details.
4243
E.g. /output json /format {SemVer} - will output `1.2.3+beta.4`
4344
/output json /format {Major}.{Minor} - will output `1.2`
44-
/l Path to logfile.
45+
/l Path to logfile; specify 'console' to emit to stdout.
4546
/config Path to config file (defaults to GitVersion.yml, GitVersion.yaml, .GitVersion.yml or .GitVersion.yaml)
4647
/showconfig Outputs the effective GitVersion config (defaults + custom
4748
from GitVersion.yml, GitVersion.yaml, .GitVersion.yml or .GitVersion.yaml) in yaml format

src/GitVersion.App.Tests/HelpWriterTests.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ public void AllArgsAreInHelp()
2727
{ nameof(Arguments.ClonePath), "/dynamicRepoLocation" },
2828
{ nameof(Arguments.CommitId), "/c" },
2929

30+
{ nameof(Arguments.Diag) , "/diag" },
3031
{ nameof(Arguments.LogFilePath) , "/l" },
3132
{ nameof(Arguments.Verbosity), "/verbosity" },
3233
{ nameof(Arguments.Output) , "/output" },

0 commit comments

Comments
 (0)