doc: update CLI/tool documentation for /diag argument #4764
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.



Description
Update CLI/tool documentation on how to correctly emit
/diaginformation via logfile or stdout.Also adds an opportunistic test coverage for the
/diagswitch in the HelpWriterTests suite.The same .md is used for both CLI and the documentation web site; caveat emptor to the project owners to not deploy doc updates until the next 6.x milestone release (or hold this PR merge)?
Related Issue
Resolves #4539; covers the follow up CR comment in #4762
Motivation and Context
As discussed in 4539, the agreed approach to "fix" the >= 6.3.0 breaking change behavior for the
/diagswitch is to document that it is now required to also supply the output stream, e.g./diag /l consoleto emit both diagnostic info and JSON into stdoutHow Has This Been Tested?
dotnet run --project src/GitVersion.App/GitVersion.App.csproj -f net10.0 -- -h-> updated help texts do show up
Screenshots (if appropriate):
Checklist: