Change help to use hyphen switches and consistent casing #3785

dasMulli · 2018-09-23T09:38:13Z

Changes help texts and explanations in the resource file to:

use hyphens instead of slashes for command line arguments
use camelCase for all command line arguments

jeffkl · 2018-09-24T14:27:40Z

src/MSBuild.UnitTests/CommandLineSwitches_Tests.cs

                    if (i == 0)
                    {
-                        if (helpMessageLines[i].Trim().StartsWith("/") || helpMessageLines[i].Trim().StartsWith("@"))
+                        if (trimmedLine.StartsWith("/") || trimmedLine.StartsWith("-") || trimmedLine.StartsWith("@"))


This unit test only tests our usage text. I think you should remove the StartsWith("/") so that we make sure all usage messages are correct

jeffkl · 2018-09-24T14:28:14Z

src/MSBuild.UnitTests/CommandLineSwitches_Tests.cs

                            if (item.Key.Contains("Examples"))
                            {
                                // Examples require a certain number of leading spaces
                                Assert.True(helpMessageLines[i].StartsWith(examplesLeadingSpaces), $"Line {i + 1} of '{item.Key}' should start with '{examplesLeadingSpaces}'.");
                            }
-                            else if (helpMessageLines[i].Trim().StartsWith("/") || helpMessageLines[i].Trim().StartsWith("@"))
+                            else if (trimmedLine.StartsWith("/") || trimmedLine.StartsWith("-") || trimmedLine.StartsWith("@"))


rainersigwald

I think this looks good. My only question is: should we support and then suggest using --longForm arguments (with double dashes) or just stick to single-dash/slash everywhere?

I also feel like it's probably worth adding a sentence in the /? help text that says "switches can be specified with either an initial - or an initial /".

dasMulli · 2018-09-24T17:25:05Z

… suggest using --longForm …

not sure. roslyn doesn't do that.
Personally, I like -- arguments only when the single hyphen arguments are flags I can combine (like tar -xvf …)

dasMulli · 2018-09-24T20:42:27Z

Added a commit with explanatory comment on switch usage:

Microsoft (R) Build Engine version 16.0.78-preview+g05baa3878b for .NET Core
Copyright (C) Microsoft Corporation. All rights reserved.

Syntax:              MSBuild.exe [options] [project file | directory]

Description:         Builds the specified targets in the project file. If
                     …

Switches:            Note that you can spefiy switches using both
                     "-switch" and "/switch".

  -target:<targets>  Build these targets in this project. Use a semicolon or a

or should this rather be in the description part?

rainersigwald · 2018-09-24T20:45:17Z

src/MSBuild/Resources/Strings.resx

      4) all verbosity levels and their short forms e.g. quiet, or q
      LOCALIZATION: None of the lines should be longer than a standard width console window, eg 80 chars.
    </comment>
  </data>
  <data name="HelpMessage_3_SwitchesHeader" UESanitized="true" Visibility="Public">
-    <value>Switches:
+    <value>Switches:            Note that you can spefiy switches using both


typo: specify

rainersigwald

Thanks!

dasMulli · 2018-09-24T21:00:15Z

Is the CLA bot expected to work? I should have a valid CLA unless it changed in the last days

rainersigwald · 2018-09-24T21:06:31Z

CLA-bot has been crabby lately. I used my superpowers to redeliver the webhook and it turned green.

AndyGerlicher

Looks really good. Thanks for taking the time to do this!

AndyGerlicher · 2018-09-27T16:41:39Z

@dasMulli Just FYI I want to hold off on this as it could impact Visual Studio (there are some old tests in there). We're working on getting a stable insertion (for other reasons), once we do I'll merge this.

dasMulli · 2018-09-29T00:40:20Z

@AndyGerlicher @rainersigwald @dfederm Or do you want this to go into exp/net472 since there are new switches (-graphBuild) being added there? Or wait until net472 is merged into master before a rebase?

rainersigwald · 2018-10-01T15:02:11Z

I wouldn't object if you wanted to retarget to exp/net472 and fix up the new switches, but I also wouldn't mind fixing them at merge time.

rainersigwald · 2018-11-02T17:07:02Z

Closing/reopening to re-merge and retest post-RI of net472.

dasMulli · 2018-11-02T20:42:22Z

Rebased and squashed the two original commits onto latest master and added additional changes for graph build command line arguments.

dasMulli · 2018-11-14T07:23:51Z

What's the status on this? waiting for decisions or ready to merge?

rainersigwald · 2018-11-14T15:26:43Z

I think I saw your last push and was waiting for tests or something and then forgot about it for two weeks, sorry! Thanks again.

AndyGerlicher · 2018-11-14T17:46:03Z

Also for transparency, we had been trying to avoid changes that weren't strictly necessary and high potential for breaking something (this changed output messages, so might break something) while we worked to get VS updated to 4.7.2 for the first preview of VS 2019. That plus the tools version change to Current will be going out when that's released. It was a tough change since anything that referenced us or Roslyn in VS needed to update. But it should be a great win for .NET Standard components (no more facades!) and perf as well.

dasMulli · 2018-11-16T07:40:40Z

and then forgot about it for two weeks

@rainersigwald I really appreciate that you just tell it like it is and not give some bla bla bullsh*. Not just here but in a lot of places.

we had been trying to avoid changes that weren't strictly necessary

My "open source work" is mostly things that are important to me and not necessarily high enough to land on teams' backlogs so I completely understand.

dasMulli force-pushed the feature/consistent-help branch 2 times, most recently from 7bbfc37 to 593c9cc Compare September 24, 2018 00:32

dasMulli changed the title ~~WIP: Change help to use hyphen switches and consistent casing~~ Change help to use hyphen switches and consistent casing Sep 24, 2018

dasMulli force-pushed the feature/consistent-help branch 3 times, most recently from 0ade69a to 7e40640 Compare September 24, 2018 00:40

jeffkl approved these changes Sep 24, 2018

View reviewed changes

dasMulli force-pushed the feature/consistent-help branch from 7e40640 to 05baa38 Compare September 24, 2018 16:51

rainersigwald reviewed Sep 24, 2018

View reviewed changes

dasMulli closed this Sep 24, 2018

dasMulli reopened this Sep 24, 2018

rainersigwald approved these changes Sep 24, 2018

View reviewed changes

dasMulli force-pushed the feature/consistent-help branch from 03f1927 to 2938050 Compare September 24, 2018 20:44

rainersigwald reviewed Sep 24, 2018

View reviewed changes

dasMulli force-pushed the feature/consistent-help branch from 2938050 to d106cee Compare September 24, 2018 20:51

rainersigwald approved these changes Sep 24, 2018

View reviewed changes

AndyGerlicher approved these changes Sep 25, 2018

View reviewed changes

rainersigwald closed this Nov 2, 2018

rainersigwald reopened this Nov 2, 2018

rainersigwald force-pushed the feature/consistent-help branch from 128e688 to eabfc9c Compare November 2, 2018 19:01

Change help to use hyphen switches and consistent casing

ca95ebd

dasMulli force-pushed the feature/consistent-help branch from eabfc9c to ca95ebd Compare November 2, 2018 20:41

rainersigwald approved these changes Nov 2, 2018

View reviewed changes

rainersigwald merged commit 6fa296f into dotnet:master Nov 14, 2018

dasMulli mentioned this pull request Nov 18, 2018

Change MSBuild arguments to hyphen format NuGet/docs.microsoft.com-nuget#1167

Merged

rainersigwald mentioned this pull request Apr 1, 2019

Wiki Update #4280

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Change help to use hyphen switches and consistent casing #3785

Change help to use hyphen switches and consistent casing #3785

dasMulli commented Sep 23, 2018 •

edited

jeffkl Sep 24, 2018

jeffkl Sep 24, 2018

rainersigwald left a comment

dasMulli commented Sep 24, 2018

dasMulli commented Sep 24, 2018 •

edited

rainersigwald Sep 24, 2018

dasMulli Sep 24, 2018

rainersigwald left a comment

dasMulli commented Sep 24, 2018

rainersigwald commented Sep 24, 2018

AndyGerlicher left a comment

AndyGerlicher commented Sep 27, 2018

dasMulli commented Sep 29, 2018

rainersigwald commented Oct 1, 2018

rainersigwald commented Nov 2, 2018

dasMulli commented Nov 2, 2018

dasMulli commented Nov 14, 2018

rainersigwald commented Nov 14, 2018

AndyGerlicher commented Nov 14, 2018

dasMulli commented Nov 16, 2018

Change help to use hyphen switches and consistent casing #3785

Change help to use hyphen switches and consistent casing #3785

Conversation

dasMulli commented Sep 23, 2018 • edited

jeffkl Sep 24, 2018

Choose a reason for hiding this comment

jeffkl Sep 24, 2018

Choose a reason for hiding this comment

rainersigwald left a comment

Choose a reason for hiding this comment

dasMulli commented Sep 24, 2018

dasMulli commented Sep 24, 2018 • edited

rainersigwald Sep 24, 2018

Choose a reason for hiding this comment

dasMulli Sep 24, 2018

Choose a reason for hiding this comment

rainersigwald left a comment

Choose a reason for hiding this comment

dasMulli commented Sep 24, 2018

rainersigwald commented Sep 24, 2018

AndyGerlicher left a comment

Choose a reason for hiding this comment

AndyGerlicher commented Sep 27, 2018

dasMulli commented Sep 29, 2018

rainersigwald commented Oct 1, 2018

rainersigwald commented Nov 2, 2018

dasMulli commented Nov 2, 2018

dasMulli commented Nov 14, 2018

rainersigwald commented Nov 14, 2018

AndyGerlicher commented Nov 14, 2018

dasMulli commented Nov 16, 2018

dasMulli commented Sep 23, 2018 •

edited

dasMulli commented Sep 24, 2018 •

edited