Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add the missing help messages for some switches #9719

Open
wants to merge 20 commits into
base: main
Choose a base branch
from

Conversation

JaynieBai
Copy link
Member

@JaynieBai JaynieBai commented Feb 8, 2024

Fixes #9710

Context

Some of the supported command line switches are not mentioned in the help message

Changes Made

List the relevant string resource ID in s_parameterlessSwitchesMap / s_parameterizedSwitchesMap. And iterate the resource ids in the ShowHelpMessage

Testing

Before:
msbuildBefore.txt

dotnetmsbuildBefore.txt

After:
msbuildAfter.txt
netMSBuildAfter.txt

Notes

src/MSBuild/Resources/Strings.resx Outdated Show resolved Hide resolved
src/MSBuild/Resources/Strings.resx Outdated Show resolved Hide resolved
src/MSBuild/CommandLineSwitches.cs Show resolved Hide resolved
src/MSBuild/XMake.cs Outdated Show resolved Hide resolved
@JaynieBai JaynieBai marked this pull request as ready for review March 13, 2024 04:34
Copy link
Member

@JanKrivanek JanKrivanek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good.

I agree that getTargetResult should probably specify that the specified target will be executed.

src/MSBuild/Resources/Strings.resx Outdated Show resolved Hide resolved
src/MSBuild/Resources/Strings.resx Outdated Show resolved Hide resolved
src/MSBuild/Resources/Strings.resx Outdated Show resolved Hide resolved
@JaynieBai
Copy link
Member Author

Looks good.

I agree that getTargetResult should probably specify that the specified target will be executed.

Thanks, have updated the help message for this property.

Copy link
Member

@ladipro ladipro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, I've left a few comments inline. For testing, can you please compare the help output before and after, and from both MSBuild.exe and dotnet build?

src/MSBuild/CommandLineSwitches.cs Outdated Show resolved Hide resolved
src/MSBuild/CommandLineSwitches.cs Outdated Show resolved Hide resolved
src/MSBuild/CommandLineSwitches.cs Outdated Show resolved Hide resolved
src/MSBuild/XMake.cs Outdated Show resolved Hide resolved
src/MSBuild/XMake.cs Outdated Show resolved Hide resolved
@JaynieBai
Copy link
Member Author

Thank you, I've left a few comments inline. For testing, can you please compare the help output before and after, and from both MSBuild.exe and dotnet build?

I upload the text based on test. There is a change in the order of the switches. Please have a look if that is acceptable. -help is earlier than other no parameters switches since the

{
//---------------------------------------------------------------------------------------------------------------------------------------------------
// Switch Names Switch Id Dup Error Light up key
//---------------------------------------------------------------------------------------------------------------------------------------------------
new ParameterlessSwitchInfo( new string[] { "help", "h", "?" }, ParameterlessSwitch.Help, null),
new ParameterlessSwitchInfo( new string[] { "version", "ver" }, ParameterlessSwitch.Version, null),
new ParameterlessSwitchInfo( new string[] { "nologo" }, ParameterlessSwitch.NoLogo, null),
new ParameterlessSwitchInfo( new string[] { "noautoresponse", "noautorsp" }, ParameterlessSwitch.NoAutoResponse, null),
new ParameterlessSwitchInfo( new string[] { "noconsolelogger", "noconlog" }, ParameterlessSwitch.NoConsoleLogger, null),
new ParameterlessSwitchInfo( new string[] { "filelogger", "fl" }, ParameterlessSwitch.FileLogger, null),
new ParameterlessSwitchInfo( new string[] { "filelogger1", "fl1" }, ParameterlessSwitch.FileLogger1, null),
new ParameterlessSwitchInfo( new string[] { "filelogger2", "fl2" }, ParameterlessSwitch.FileLogger2, null),
new ParameterlessSwitchInfo( new string[] { "filelogger3", "fl3" }, ParameterlessSwitch.FileLogger3, null),
new ParameterlessSwitchInfo( new string[] { "filelogger4", "fl4" }, ParameterlessSwitch.FileLogger4, null),
new ParameterlessSwitchInfo( new string[] { "filelogger5", "fl5" }, ParameterlessSwitch.FileLogger5, null),
new ParameterlessSwitchInfo( new string[] { "filelogger6", "fl6" }, ParameterlessSwitch.FileLogger6, null),
new ParameterlessSwitchInfo( new string[] { "filelogger7", "fl7" }, ParameterlessSwitch.FileLogger7, null),
new ParameterlessSwitchInfo( new string[] { "filelogger8", "fl8" }, ParameterlessSwitch.FileLogger8, null),
new ParameterlessSwitchInfo( new string[] { "filelogger9", "fl9" }, ParameterlessSwitch.FileLogger9, null),
new ParameterlessSwitchInfo( new string[] { "distributedfilelogger", "dfl" }, ParameterlessSwitch.DistributedFileLogger, null),
#if DEBUG
new ParameterlessSwitchInfo( new string[] { "waitfordebugger", "wfd" }, ParameterlessSwitch.WaitForDebugger, null),
#endif
};

image

Copy link
Member

@ladipro ladipro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I upload the text based on test. There is a change in the order of the switches. Please have a look if that is acceptable.

I can't imagine something would depend on the order. Reviewers, please chime in. I've left a few inline comments. Thank you!

src/MSBuild/Resources/Strings.resx Outdated Show resolved Hide resolved
src/MSBuild/Resources/Strings.resx Outdated Show resolved Hide resolved
src/MSBuild/Resources/Strings.resx Outdated Show resolved Hide resolved
src/MSBuild/Resources/Strings.resx Outdated Show resolved Hide resolved
src/MSBuild/Resources/Strings.resx Outdated Show resolved Hide resolved
src/MSBuild/Resources/Strings.resx Outdated Show resolved Hide resolved
src/MSBuild/XMake.cs Outdated Show resolved Hide resolved
src/MSBuild/XMake.cs Outdated Show resolved Hide resolved
src/MSBuild/Resources/Strings.resx Outdated Show resolved Hide resolved
src/MSBuild/Resources/Strings.resx Outdated Show resolved Hide resolved
src/MSBuild/Resources/Strings.resx Outdated Show resolved Hide resolved
src/MSBuild/Resources/Strings.resx Outdated Show resolved Hide resolved
src/MSBuild/Resources/Strings.resx Outdated Show resolved Hide resolved
src/MSBuild/Resources/Strings.resx Outdated Show resolved Hide resolved
src/MSBuild/Resources/Strings.resx Outdated Show resolved Hide resolved
@JaynieBai
Copy link
Member Author

/azp run

Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@JaynieBai
Copy link
Member Author

There are conflicts since the new analyzer switch in the commit f744eb5#diff-c0f68f9abf837e0ecb1e4de52b83e9e81d6934c5596bc213e4b1de45e591d7ce But there is no help message for this analyzer switch. @JanKrivanek , Could you give more info about this switch? Should we show the help message for this switch?

@JanKrivanek
Copy link
Member

There are conflicts since the new analyzer switch in the commit f744eb5#diff-c0f68f9abf837e0ecb1e4de52b83e9e81d6934c5596bc213e4b1de45e591d7ce But there is no help message for this analyzer switch. @JanKrivanek , Could you give more info about this switch? Should we show the help message for this switch?

Disccussed offline.
-analyze should not be included in help message now

Comment on lines +1020 to +1031
<value> -terminalLoggerParameters: &lt;parameters&gt;
Parameters for the TerminalLogger. (Short form: -tlp)
default parameter.
- `on`, `true` forces TerminalLogger to be used even when
it would be disabled.
- `off`, `false` forces TerminalLogger to not be used even
when it would be enabled.
- `auto` enables TerminalLogger when the terminal supports
it and the session doesn't have redirected stdout/stderr

Example:
-terminalLoggerParameters:default=auto
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems not complete. This is what we support based on code:

switch (parameterName.ToUpperInvariant())
{
case "V":
case "VERBOSITY":
ApplyVerbosityParameter(parameterValue);
break;
case "SHOWCOMMANDLINE":
TryApplyShowCommandLineParameter(parameterValue);
break;
}

in addition to

msbuild/src/MSBuild/XMake.cs

Lines 2826 to 2827 in 9ead13b

// Find default configuration so it is part of telemetry even when default is not used.
// Default can be stored in /tlp:default=true|false|on|off|auto

So basicaly the parameters is a semicolon separated list - par1;par2;par3..., where each parameter is either in a form of setting=value or just setting

The settings currently can be:

  • default - requires value
  • v|verbosity - requires value
  • ShowCommandline - just setting, value must not be specified

Please ping me once you have formulation of this section that incorporates the above and I'll have a look and signoff or object :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: Help message does not contain some switches (-getProperty, -getTargetResult)
8 participants