diff --git a/docs/input/docs/usage/cli/arguments.md b/docs/input/docs/usage/cli/arguments.md index c8a95ddbc5..d873130986 100644 --- a/docs/input/docs/usage/cli/arguments.md +++ b/docs/input/docs/usage/cli/arguments.md @@ -24,7 +24,8 @@ GitVersion [path] path The directory containing .git. If not defined current directory is used. (Must be first argument) /version Displays the version of GitVersion - /diag Runs GitVersion with additional diagnostic information + /diag Runs GitVersion with additional diagnostic information; + also needs the '/l' argument to specify a logfile or stdout (requires git.exe to be installed) /h or /? Shows Help @@ -41,7 +42,7 @@ GitVersion [path] Supports C# format strings - see [Format Strings](/docs/reference/custom-formatting) for details. E.g. /output json /format {SemVer} - will output `1.2.3+beta.4` /output json /format {Major}.{Minor} - will output `1.2` - /l Path to logfile. + /l Path to logfile; specify 'console' to emit to stdout. /config Path to config file (defaults to GitVersion.yml, GitVersion.yaml, .GitVersion.yml or .GitVersion.yaml) /showconfig Outputs the effective GitVersion config (defaults + custom from GitVersion.yml, GitVersion.yaml, .GitVersion.yml or .GitVersion.yaml) in yaml format diff --git a/src/GitVersion.App.Tests/HelpWriterTests.cs b/src/GitVersion.App.Tests/HelpWriterTests.cs index 38ef352b1f..f9d5f61a78 100644 --- a/src/GitVersion.App.Tests/HelpWriterTests.cs +++ b/src/GitVersion.App.Tests/HelpWriterTests.cs @@ -27,6 +27,7 @@ public void AllArgsAreInHelp() { nameof(Arguments.ClonePath), "/dynamicRepoLocation" }, { nameof(Arguments.CommitId), "/c" }, + { nameof(Arguments.Diag) , "/diag" }, { nameof(Arguments.LogFilePath) , "/l" }, { nameof(Arguments.Verbosity), "/verbosity" }, { nameof(Arguments.Output) , "/output" },