Editorial pass on some command-line help text.
Bob Arnson committed
Feb 16, 2023 at 15:40 UTC
9b2edf15154381f76360d91da31bad6978ffaa1c
10 files changed
+27
-42
src/wix/WixToolset.Converters/ConvertCommand.cs
+1
@@ -21,6 +21,7 @@ namespace WixToolset.Converters
21
{
22
Switches = new[]
23
{
24
+ new CommandLineHelpSwitch("--custom-table", "Convert custom table authoring for use in MSI packages (msi) or bundles (bundle)."),
25
new CommandLineHelpSwitch("--dry-run", "-n", "Only display errors, do not update files."),
26
new CommandLineHelpSwitch("--recurse", "-r", "Search for matching files in current dir and subdirs."),
27
new CommandLineHelpSwitch("-set1<file>", "Primary settings file."),
src/wix/WixToolset.Converters/WixConverter.cs
+3
-3
@@ -2372,7 +2372,7 @@ namespace WixToolset.Converters
2372
if (this.State.WixMbaPrereqLicenseUrlElements.Count == 1)
2373
{
2374
var wixMbaPrereqLicenseUrlElement = this.State.WixMbaPrereqLicenseUrlElements[0];
2375
- if (this.OnInformation(ConverterTestType.WixMbaPrereqLicenseUrlDeprecated, wixMbaPrereqLicenseUrlElement, "The magic WixVariable 'WixMbaPrereqLicenseUrl' has been removed. Add bal:PrereqLicenseUrl=\"yes\" to a prereq package instead."))
2375
+ if (this.OnInformation(ConverterTestType.WixMbaPrereqLicenseUrlDeprecated, wixMbaPrereqLicenseUrlElement, "The magic WixVariable 'WixMbaPrereqLicenseUrl' has been removed. Add bal:PrereqLicenseUrl=\"<url>\" to a prereq package instead."))
2376
{
2377
var licenseUrl = wixMbaPrereqLicenseUrlElement.Attribute("Value")?.Value;
2378
packageElement.Add(new XAttribute(BalPrereqLicenseUrlAttributeName, licenseUrl));
@@ -2394,7 +2394,7 @@ namespace WixToolset.Converters
2394
2395
foreach (var element in this.State.WixMbaPrereqLicenseUrlElements)
2396
{
2397
- this.OnError(ConverterTestType.WixMbaPrereqLicenseUrlDeprecated, element, "The magic WixVariable 'WixMbaPrereqLicenseUrl' has been removed. Add bal:PrereqLicenseUrl=\"yes\" to a prereq package instead.");
2397
+ this.OnError(ConverterTestType.WixMbaPrereqLicenseUrlDeprecated, element, "The magic WixVariable 'WixMbaPrereqLicenseUrl' has been removed. Add bal:PrereqLicenseUrl=\"<url>\" to a prereq package instead.");
2398
}
2399
}
2400
@@ -3129,7 +3129,7 @@ namespace WixToolset.Converters
3129
DisplayInternalUiNotConvertable,
3130
3131
/// <summary>
3132
- /// InstallerVersion has breaking change when missing.
3132
+ /// InstallerVersion has breaking change when omitted.
3133
/// </summary>
3134
InstallerVersionBehaviorChange,
3135
src/wix/WixToolset.Core.Burn/CommandLine/DetachSubcommand.cs
+1
-1
@@ -34,7 +34,7 @@ namespace WixToolset.Core.Burn.CommandLine
34
return new CommandLineHelp("Detaches the Burn engine from a bundle so it can be signed.", "burn detach [options] original.exe -engine engine.exe", new[]
35
{
36
new CommandLineHelpSwitch("-intermediateFolder", "Optional working folder. If not specified %TMP% will be used."),
37
- new CommandLineHelpSwitch("-engine", "Path to extract bundle's engine file to."),
37
+ new CommandLineHelpSwitch("-engine", "Path for extracted bundle engine."),
38
});
39
}
40
src/wix/WixToolset.Core.Burn/CommandLine/ExtractSubcommand.cs
+3
-3
@@ -33,7 +33,7 @@ namespace WixToolset.Core.Burn.CommandLine
33
34
public override CommandLineHelp GetCommandLineHelp()
35
{
36
- return new CommandLineHelp("Extracts the internals of a bundle to a folder.", "burn extract [options] bundle.exe -o outputfolder ", new[]
36
+ return new CommandLineHelp("Extracts the contents of a bundle.", "burn extract [options] bundle.exe -o outputfolder", new[]
37
{
38
new CommandLineHelpSwitch("-intermediateFolder", "Optional working folder. If not specified %TMP% will be used."),
39
new CommandLineHelpSwitch("-outba", "-oba", "Folder to extract the bundle bootstrapper application to."),
@@ -68,7 +68,7 @@ namespace WixToolset.Core.Burn.CommandLine
68
try
69
{
70
if (!String.IsNullOrEmpty(this.ExtractContainersPath))
71
- {
71
+ {
72
reader.ExtractAttachedContainers(this.ExtractContainersPath, this.IntermediateFolder);
73
}
74
}
@@ -92,7 +92,7 @@ namespace WixToolset.Core.Burn.CommandLine
92
case "intermediatefolder":
93
this.IntermediateFolder = parser.GetNextArgumentAsDirectoryOrError(argument);
94
return true;
95
-
95
+
96
case "oba":
97
case "outba":
98
this.ExtractBootstrapperApplicationPath = parser.GetNextArgumentAsDirectoryOrError(argument);
src/wix/WixToolset.Core.Burn/CommandLine/ReattachSubcommand.cs
+2
-1
@@ -35,8 +35,9 @@ namespace WixToolset.Core.Burn.CommandLine
35
{
36
return new CommandLineHelp("Reattaches a signed burn engine to a bundle.", "burn reattach [options] original.exe -engine signed.exe -o final.exe", new[]
37
{
38
+ new CommandLineHelpSwitch("-engine", "Burn engine extracted using `wix burn detach` and then signed."),
39
new CommandLineHelpSwitch("-intermediateFolder", "Optional working folder. If not specified %TMP% will be used."),
39
- new CommandLineHelpSwitch("-out", "-o", "Output bundle with signed engine attached."),
40
+ new CommandLineHelpSwitch("-out", "-o", "Required path to output bundle with reattached signed engine that can then be signed as a whole."),
41
});
42
}
43
src/wix/WixToolset.Core.Burn/CommandLine/RemotePayloadSubcommand.cs
+5
-20
@@ -69,32 +69,17 @@ namespace WixToolset.Core.Burn.CommandLine
69
70
public override CommandLineHelp GetCommandLineHelp()
71
{
72
- return new CommandLineHelp("Generate source code for a remote payload", "burn remotepayload [options] payloadfile [payloadfile ...]", new[]
72
+ return new CommandLineHelp("Generate source code for a remote payload.", "burn remotepayload [options] payloadfile [payloadfile ...]", new[]
73
{
74
new CommandLineHelpSwitch("-basepath", "-bp", "Folder as base to make payloads relative."),
75
- new CommandLineHelpSwitch("-bundlepayloadgeneration", "Sets the package payload generation option; see the Payload Generation Types below."),
75
+ new CommandLineHelpSwitch("-bundlepayloadgeneration", "Sets the package payload generation option; available types are: none, externalwithoutdownloadurl, external, all."),
76
new CommandLineHelpSwitch("-downloadurl", "-du", "Set the DownloadUrl attribute on the generated payloads."),
77
new CommandLineHelpSwitch("-out", "-o", "Path to output the source code file."),
78
- new CommandLineHelpSwitch("-recurse", "-r", "Indicates to add all payloads in directory recursively."),
78
+ new CommandLineHelpSwitch("-recurse", "-r", "Generate source code for all payloads in directory recursively."),
79
new CommandLineHelpSwitch("-intermediatefolder", "Optional working folder. If not specified %TMP% folder will be created."),
80
- new CommandLineHelpSwitch("-packagetype", "Explicitly set package type; see the Pacakge Types below."),
80
+ new CommandLineHelpSwitch("-packagetype", "Explicitly set package type; available types are: _bundle_, _exe_, _msu_."),
81
new CommandLineHelpSwitch("-usecertificate", "Use certificate to validate signed payloads. This option is not recommended."),
82
- })
83
- {
84
- Notes = String.Join(Environment.NewLine,
85
- "Payload Generation Types:",
86
- " none",
87
- " externalwithoutdownloadurl",
88
- " external",
89
- " all",
90
- String.Empty,
91
- "Package Types:",
92
- " bundle",
93
- " exe",
94
- " msi",
95
- " msp",
96
- " msu")
97
- };
82
+ });
83
}
84
85
public override Task<int> ExecuteAsync(CancellationToken cancellationToken)
src/wix/WixToolset.Core.WindowsInstaller/CommandLine/DecompilerSubcommand.cs
+6
-7
@@ -46,18 +46,17 @@ namespace WixToolset.Core.WindowsInstaller.CommandLine
46
47
public override CommandLineHelp GetCommandLineHelp()
48
{
49
- return new CommandLineHelp("Converts a Windows Installer database back into source code.", "msi decompile [options] inputfile", new[]
49
+ return new CommandLineHelp("Converts a Windows Installer database back into source code.", "msi decompile [options] {inputfile.msi|inputfile.msm}", new[]
50
{
51
- new CommandLineHelpSwitch("-cub", "Optional path to a custom validation .CUBe file."),
52
- new CommandLineHelpSwitch("-data", "Save output as data instead of as a source file."),
51
+ new CommandLineHelpSwitch("-data", "Save output as WiX data instead of as a source file."),
52
new CommandLineHelpSwitch("-sct", "Suppress decompiling custom tables."),
53
new CommandLineHelpSwitch("-sdet", "Suppress dropping empty tables."),
54
new CommandLineHelpSwitch("-sras", "Suppress relative action sequencing."),
55
new CommandLineHelpSwitch("-sui", "Suppress decompiling UI tables."),
57
- new CommandLineHelpSwitch("-type", "Optional specify the input file type: msi or msm. If not specified, type will be inferred by file extension."),
58
- new CommandLineHelpSwitch("-intermediateFolder", "Optional working folder. If not specified %TMP% will be used."),
59
- new CommandLineHelpSwitch("-out", "-o", "Path to output the decompiled output file. If not specified, outputs next to inputfile"),
60
- new CommandLineHelpSwitch("-x", "Folder to export embedded binaries and icons to."),
56
+ new CommandLineHelpSwitch("-type", "Optionally specify the input file type: msi or msm. If not specified, type will be inferred by file extension."),
57
+ new CommandLineHelpSwitch("-intermediateFolder", "Optional working folder. If not specified, %TMP% will be used."),
58
+ new CommandLineHelpSwitch("-out", "-o", "Optional path for the decompiled output file. If not specified, output path will have the same base name as the input file in the same directory."),
59
+ new CommandLineHelpSwitch("-x", "If specified, export embedded binaries and icons to specified folder."),
60
});
61
}
62
src/wix/WixToolset.Core.WindowsInstaller/CommandLine/TransformSubcommand.cs
+3
-4
@@ -62,13 +62,12 @@ namespace WixToolset.Core.WindowsInstaller.CommandLine
62
{
63
Switches = new[]
64
{
65
- new CommandLineHelpSwitch("-a", "Admin image, generates source file information in the transform."),
65
new CommandLineHelpSwitch("-intermediateFolder", "Optional working folder. If not specified %TMP% will be used."),
66
new CommandLineHelpSwitch("-p", "Preserve unchanged rows."),
67
new CommandLineHelpSwitch("-pedantic", "Show pedantic messages."),
69
- new CommandLineHelpSwitch("-serr <flags>", "Suppress error when applying transform; see Error flags below"),
70
- new CommandLineHelpSwitch("-t <type>", "Use default validation flags for the transform type; see Transform types below"),
71
- new CommandLineHelpSwitch("-val <flags>", "Validation flags for the transform; see Validation flags below"),
68
+ new CommandLineHelpSwitch("-serr <flags>", "Suppress error when applying transform; see Error flags below."),
69
+ new CommandLineHelpSwitch("-t <type>", "Use default validation flags for the transform type; see Transform types below."),
70
+ new CommandLineHelpSwitch("-val <flags>", "Validation flags for the transform; see Validation flags below."),
71
new CommandLineHelpSwitch("-x", "Folder to extract binaries."),
72
new CommandLineHelpSwitch("-xo", "Output transfrom as a WiX output instead of an MST file."),
73
new CommandLineHelpSwitch("-out", "-o", "Path to output the transform file."),
src/wix/WixToolset.Core.WindowsInstaller/CommandLine/ValidateSubcommand.cs
+1
-1
@@ -39,7 +39,7 @@ namespace WixToolset.Core.WindowsInstaller.CommandLine
39
40
public override CommandLineHelp GetCommandLineHelp()
41
{
42
- return new CommandLineHelp("Validates MSI database using standard or custom ICEs.", "msi validate [options] inputfile", new[]
42
+ return new CommandLineHelp("Validates MSI database using standard or custom ICEs.", "msi validate [options] {inputfile.msi|inputfile.msm}", new[]
43
{
44
new CommandLineHelpSwitch("-cub", "Optional path to a custom validation .CUBe file."),
45
new CommandLineHelpSwitch("-ice", "Validates only with the specified ICE. May be provided multiple times."),
src/wix/test/WixToolsetTest.Converters/PrereqPackageFixture.cs
+2
-2
@@ -48,7 +48,7 @@ namespace WixToolsetTest.Converters
48
WixAssert.CompareLineByLine(new[]
49
{
50
"[Converted] The magic WixVariable 'WixMbaPrereqPackageId' has been removed. Add bal:PrereqPackage=\"yes\" to the target package instead. (WixMbaPrereqPackageIdDeprecated)",
51
- "[Converted] The magic WixVariable 'WixMbaPrereqLicenseUrl' has been removed. Add bal:PrereqLicenseUrl=\"yes\" to a prereq package instead. (WixMbaPrereqLicenseUrlDeprecated)",
51
+ "[Converted] The magic WixVariable 'WixMbaPrereqLicenseUrl' has been removed. Add bal:PrereqLicenseUrl=\"<url>\" to a prereq package instead. (WixMbaPrereqLicenseUrlDeprecated)",
52
}, messaging.Messages.Select(m => m.ToString()).ToArray());
53
WixAssert.CompareLineByLine(expected, actualLines);
54
}
@@ -86,7 +86,7 @@ namespace WixToolsetTest.Converters
86
WixAssert.CompareLineByLine(new[]
87
{
88
"The magic WixVariable 'WixMbaPrereqPackageId' has been removed. Add bal:PrereqPackage=\"yes\" to the target package instead. (WixMbaPrereqPackageIdDeprecated)",
89
- "The magic WixVariable 'WixMbaPrereqLicenseUrl' has been removed. Add bal:PrereqLicenseUrl=\"yes\" to a prereq package instead. (WixMbaPrereqLicenseUrlDeprecated)",
89
+ "The magic WixVariable 'WixMbaPrereqLicenseUrl' has been removed. Add bal:PrereqLicenseUrl=\"<url>\" to a prereq package instead. (WixMbaPrereqLicenseUrlDeprecated)",
90
}, messaging.Messages.Select(m => m.ToString()).ToArray());
91
WixAssert.CompareLineByLine(expected, actualLines);
92
}