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

Merged
merged 21 commits into from
Jun 24, 2024
Merged
Show file tree
Hide file tree
Changes from 12 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
184 changes: 116 additions & 68 deletions src/MSBuild/CommandLineSwitches.cs

Large diffs are not rendered by default.

170 changes: 142 additions & 28 deletions src/MSBuild/Resources/Strings.resx
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
<?xml version="1.0" encoding="utf-8"?>
<root>
<!--
Microsoft ResX Schema
<!--
Microsoft ResX Schema

Version 2.0
The primary goals of this format is to allow a simple XML format
that is mostly human readable. The generation and parsing of the
various data types are done through the TypeConverter classes

The primary goals of this format is to allow a simple XML format
that is mostly human readable. The generation and parsing of the
various data types are done through the TypeConverter classes
associated with the data types.

Example:

... ado.net/XML headers & schema ...
<resheader name="resmimetype">text/microsoft-resx</resheader>
<resheader name="version">2.0</resheader>
Expand All @@ -26,36 +26,36 @@
<value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value>
<comment>This is a comment</comment>
</data>
There are any number of "resheader" rows that contain simple

There are any number of "resheader" rows that contain simple
name/value pairs.
Each data row contains a name, and value. The row also contains a
type or mimetype. Type corresponds to a .NET class that support
text/value conversion through the TypeConverter architecture.
Classes that don't support this are serialized and stored with the

Each data row contains a name, and value. The row also contains a
type or mimetype. Type corresponds to a .NET class that support
text/value conversion through the TypeConverter architecture.
Classes that don't support this are serialized and stored with the
mimetype set.
The mimetype is used for serialized objects, and tells the
ResXResourceReader how to depersist the object. This is currently not

The mimetype is used for serialized objects, and tells the
ResXResourceReader how to depersist the object. This is currently not
extensible. For a given mimetype the value must be set accordingly:
Note - application/x-microsoft.net.object.binary.base64 is the format
that the ResXResourceWriter will generate, however the reader can

Note - application/x-microsoft.net.object.binary.base64 is the format
that the ResXResourceWriter will generate, however the reader can
read any of the formats listed below.

mimetype: application/x-microsoft.net.object.binary.base64
value : The object must be serialized with
value : The object must be serialized with
: System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
: and then encoded with base64 encoding.

mimetype: application/x-microsoft.net.object.soap.base64
value : The object must be serialized with
value : The object must be serialized with
: System.Runtime.Serialization.Formatters.Soap.SoapFormatter
: and then encoded with base64 encoding.

mimetype: application/x-microsoft.net.object.bytearray.base64
value : The object must be serialized into a byte array
value : The object must be serialized into a byte array
: using a System.ComponentModel.TypeConverter
: and then encoded with base64 encoding.
-->
Expand Down Expand Up @@ -929,6 +929,120 @@
LOCALIZATION: None of the lines should be longer than a standard width console window, eg 80 chars.
</comment>
</data>
<data name="HelpMessage_43_GetPropertySwitch" Visibility="Public">
<value> -getProperty:propertyName,...
Write out the value of one or more specified properties
after evaluation, without executing the build, or if either
the -targets option or the -getTargetResult option is
used, write out the values after the build.
</value>
<comment>
LOCALIZATION: "-getProperty" should not be localized.
LOCALIZATION: None of the lines should be longer than a standard width console window, eg 80 chars.
</comment>
</data>
<data name="HelpMessage_44_GetItemSwitch" Visibility="Public">
<value> -getItem:itemName,...
Write out the value of one or more specified items and
their associated metadata after evaluation without
executing the build, or if either the -targets option
or the -getTargetResult option is used, write out
the values after the build.
</value>
<comment>
LOCALIZATION: "-getItem" should not be localized.
LOCALIZATION: None of the lines should be longer than a standard width console window, eg 80 chars.
</comment>
</data>
<data name="HelpMessage_45_GetTargetResultSwitch" Visibility="Public">
<value> -getTargetResult:targetName,...
Write out the output value of one or more targets and
the specified targets will be executed.
</value>
<comment>
LOCALIZATION: "-getTargetResult" should not be localized.
LOCALIZATION: None of the lines should be longer than a standard width console window, eg 80 chars.
</comment>
</data>
<data name="HelpMessage_46_FeatureAvailabilitySwitch" Visibility="Public">
<value> -featureavailability:featureName,...
JaynieBai marked this conversation as resolved.
Show resolved Hide resolved
Check feature availability, The result is one of
JaynieBai marked this conversation as resolved.
Show resolved Hide resolved
"Undefined", "Available", "NotAvailable" strings.
JaynieBai marked this conversation as resolved.
Show resolved Hide resolved
(Short form: -fa)
</value>
<comment>
LOCALIZATION: "-featureavailability" and "-fa" should not be localized.
JaynieBai marked this conversation as resolved.
Show resolved Hide resolved
JaynieBai marked this conversation as resolved.
Show resolved Hide resolved
LOCALIZATION: None of the lines should be longer than a standard width console window, eg 80 chars.
</comment>
</data>
<data name="HelpMessage_47_TerminalLoggerSwitch" Visibility="Public">
<value> -terminallogger
Users are able to opt-in and use the TerminalLogger,
JaynieBai marked this conversation as resolved.
Show resolved Hide resolved
EXCEPT when:
- The terminal does not support ANSI codes or color
- Output is redirected to a file or pipe
(Short form: -tl)
</value>
<comment>
LOCALIZATION: "-terminallogger" and "-tl" should not be localized.
LOCALIZATION: None of the lines should be longer than a standard width console window, eg 80 chars.
</comment>
</data>
<data name="HelpMessage_51_GetResultOutputFileSwitch" Visibility="Public">
<value> -getResultOutputFile:file
Redirect output from get* into a file.

Example:
-getProperty:Bar -getResultOutputFile:Biz.txt
This writes the value of property Bar into Biz.txt.
</value>
<comment>
LOCALIZATION: "-getResultOutputFile" should not be localized.
LOCALIZATION: None of the lines should be longer than a standard width console window, eg 80 chars.
</comment>
</data>
<data name="HelpMessage_48_TerminalLoggerParametersSwitch" Visibility="Public">
<value> -termialLoggerParameters:default=[auto|false|true]
JaynieBai marked this conversation as resolved.
Show resolved Hide resolved
JaynieBai marked this conversation as resolved.
Show resolved Hide resolved
Users are able to opt-in and use the TerminalLogger.
- `true` forces TerminalLogger to be used even wwhen it
JaynieBai marked this conversation as resolved.
Show resolved Hide resolved
would be disabled.
- `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
(Short form: -tlp)
Example:
-termialLoggerParameters:default=auto
</value>
<comment>
LOCALIZATION: "-termialLoggerParameters" and "-tlp" should not be localized.
LOCALIZATION: None of the lines should be longer than a standard width console window, eg 80 chars.
</comment>
</data>
<data name="HelpMessage_49_WaitForDebuggerSwitch" Visibility="Public">
<value> -waitfordebugger
Wait for debugger command line switch in Debug build.
(Short form: -wfd)
</value>
<comment>
LOCALIZATION: "-waitfordebugger" and "-wfd" should not be localized.
LOCALIZATION: None of the lines should be longer than a standard width console window, eg 80 chars.
</comment>
</data>
JaynieBai marked this conversation as resolved.
Show resolved Hide resolved
<data name="HelpMessage_50_NodeModeSwitch" Visibility="Public">
<value> -nodemode:number
It's used when MSBuild spawns a process, indicating that
MSBuild should start up in "Out of process worker node"
mode.
(Short form: -nmode)
Example:
-nodemode:1
</value>
<comment>
LOCALIZATION: "-nodemode" and "-nmode" should not be localized.
LOCALIZATION: None of the lines should be longer than a standard width console window, eg 80 chars.
</comment>
</data>
JaynieBai marked this conversation as resolved.
Show resolved Hide resolved
<data name="InvalidConfigurationFile" xml:space="preserve">
<value>MSBUILD : Configuration error MSB1043: The application could not start. {0}</value>
<comment>
Expand Down Expand Up @@ -1274,7 +1388,7 @@
<value>MSBUILD : error MSB1066: Specify one or more parameters for the terminal logger if using the -terminalLoggerParameters switch</value>
<comment>
{StrBegin="MSBUILD : error MSB1066: "}
UE: This happens if the user does something like "msbuild.exe -termionalLoggerParameters:". The user must pass in one or more parameters
UE: This happens if the user does something like "msbuild.exe -termialLoggerParameters:". The user must pass in one or more parameters
after the switch e.g. "msbuild.exe -terminalLoggerParameters:default=auto".
LOCALIZATION: The prefix "MSBUILD : error MSBxxxx:" should not be localized.
</comment>
Expand Down
Loading
Loading