Editorial pass on some command-line help text.

author: Bob Arnson <bob@firegiant.com> 2023-02-16 15:40:52 -0500
committer: Bob Arnson <github@bobs.org> 2023-02-16 17:17:42 -0500
commit: 9b2edf15154381f76360d91da31bad6978ffaa1c (patch)
tree: 30072d35c2f7d9eb7a94060634eda6bd0b1ba7b9 /src
parent: 6f2511f58f60e63a15357a2fe37f83343dea3090 (diff)
download: wix-9b2edf15154381f76360d91da31bad6978ffaa1c.tar.gz
wix-9b2edf15154381f76360d91da31bad6978ffaa1c.tar.bz2
wix-9b2edf15154381f76360d91da31bad6978ffaa1c.zip
10 files changed, 27 insertions, 42 deletions
diff --git a/src/wix/WixToolset.Converters/ConvertCommand.cs b/src/wix/WixToolset.Converters/ConvertCommand.cs
index bec6cd19..6f0f5cd3 100644
--- a/src/wix/WixToolset.Converters/ConvertCommand.cs
+++ b/src/wix/WixToolset.Converters/ConvertCommand.cs
@@ -21,6 +21,7 @@ namespace WixToolset.Converters
            {
                Switches = new[]
                {
+                    new CommandLineHelpSwitch("--custom-table", "Convert custom table authoring for use in MSI packages (msi) or bundles (bundle)."),
                    new CommandLineHelpSwitch("--dry-run", "-n", "Only display errors, do not update files."),
                    new CommandLineHelpSwitch("--recurse", "-r", "Search for matching files in current dir and subdirs."),
                    new CommandLineHelpSwitch("-set1<file>", "Primary settings file."),
diff --git a/src/wix/WixToolset.Converters/WixConverter.cs b/src/wix/WixToolset.Converters/WixConverter.cs
index 460bb3af..7fc6314a 100644
--- a/src/wix/WixToolset.Converters/WixConverter.cs
+++ b/src/wix/WixToolset.Converters/WixConverter.cs
@@ -2372,7 +2372,7 @@ namespace WixToolset.Converters
                    if (this.State.WixMbaPrereqLicenseUrlElements.Count == 1)
                    {
                        var wixMbaPrereqLicenseUrlElement = this.State.WixMbaPrereqLicenseUrlElements[0];
-                        if (this.OnInformation(ConverterTestType.WixMbaPrereqLicenseUrlDeprecated, wixMbaPrereqLicenseUrlElement, "The magic WixVariable 'WixMbaPrereqLicenseUrl' has been removed. Add bal:PrereqLicenseUrl=\"yes\" to a prereq package instead."))
+                        if (this.OnInformation(ConverterTestType.WixMbaPrereqLicenseUrlDeprecated, wixMbaPrereqLicenseUrlElement, "The magic WixVariable 'WixMbaPrereqLicenseUrl' has been removed. Add bal:PrereqLicenseUrl=\"<url>\" to a prereq package instead."))
                        {
                            var licenseUrl = wixMbaPrereqLicenseUrlElement.Attribute("Value")?.Value;
                            packageElement.Add(new XAttribute(BalPrereqLicenseUrlAttributeName, licenseUrl));
@@ -2394,7 +2394,7 @@ namespace WixToolset.Converters
            foreach (var element in this.State.WixMbaPrereqLicenseUrlElements)
            {
-                this.OnError(ConverterTestType.WixMbaPrereqLicenseUrlDeprecated, element, "The magic WixVariable 'WixMbaPrereqLicenseUrl' has been removed. Add bal:PrereqLicenseUrl=\"yes\" to a prereq package instead.");
+                this.OnError(ConverterTestType.WixMbaPrereqLicenseUrlDeprecated, element, "The magic WixVariable 'WixMbaPrereqLicenseUrl' has been removed. Add bal:PrereqLicenseUrl=\"<url>\" to a prereq package instead.");
            }
        }
@@ -3129,7 +3129,7 @@ namespace WixToolset.Converters
            DisplayInternalUiNotConvertable,
            /// <summary>
-            /// InstallerVersion has breaking change when missing.
+            /// InstallerVersion has breaking change when omitted.
            /// </summary>
            InstallerVersionBehaviorChange,
diff --git a/src/wix/WixToolset.Core.Burn/CommandLine/DetachSubcommand.cs b/src/wix/WixToolset.Core.Burn/CommandLine/DetachSubcommand.cs
index c43e1b62..b034a2e1 100644
--- a/src/wix/WixToolset.Core.Burn/CommandLine/DetachSubcommand.cs
+++ b/src/wix/WixToolset.Core.Burn/CommandLine/DetachSubcommand.cs
@@ -34,7 +34,7 @@ namespace WixToolset.Core.Burn.CommandLine
            return new CommandLineHelp("Detaches the Burn engine from a bundle so it can be signed.", "burn detach [options] original.exe -engine engine.exe", new[]
            {
                new CommandLineHelpSwitch("-intermediateFolder", "Optional working folder. If not specified %TMP% will be used."),
-                new CommandLineHelpSwitch("-engine", "Path to extract bundle's engine file to."),
+                new CommandLineHelpSwitch("-engine", "Path for extracted bundle engine."),
            });
        }
diff --git a/src/wix/WixToolset.Core.Burn/CommandLine/ExtractSubcommand.cs b/src/wix/WixToolset.Core.Burn/CommandLine/ExtractSubcommand.cs
index 1cab276b..a6660a06 100644
--- a/src/wix/WixToolset.Core.Burn/CommandLine/ExtractSubcommand.cs
+++ b/src/wix/WixToolset.Core.Burn/CommandLine/ExtractSubcommand.cs
@@ -33,7 +33,7 @@ namespace WixToolset.Core.Burn.CommandLine
        public override CommandLineHelp GetCommandLineHelp()
        {
-            return new CommandLineHelp("Extracts the internals of a bundle to a folder.", "burn extract [options] bundle.exe -o outputfolder ", new[]
+            return new CommandLineHelp("Extracts the contents of a bundle.", "burn extract [options] bundle.exe -o outputfolder", new[]
            {
                new CommandLineHelpSwitch("-intermediateFolder", "Optional working folder. If not specified %TMP% will be used."),
                new CommandLineHelpSwitch("-outba", "-oba", "Folder to extract the bundle bootstrapper application to."),
@@ -68,7 +68,7 @@ namespace WixToolset.Core.Burn.CommandLine
                    try
                    {
                        if (!String.IsNullOrEmpty(this.ExtractContainersPath))
-                                {
+                        {
                            reader.ExtractAttachedContainers(this.ExtractContainersPath, this.IntermediateFolder);
                        }
                    }
@@ -92,7 +92,7 @@ namespace WixToolset.Core.Burn.CommandLine
                    case "intermediatefolder":
                        this.IntermediateFolder = parser.GetNextArgumentAsDirectoryOrError(argument);
                        return true;
-                        
                    case "oba":
                    case "outba":
                        this.ExtractBootstrapperApplicationPath = parser.GetNextArgumentAsDirectoryOrError(argument);
diff --git a/src/wix/WixToolset.Core.Burn/CommandLine/ReattachSubcommand.cs b/src/wix/WixToolset.Core.Burn/CommandLine/ReattachSubcommand.cs
index d02a98fc..bea26cd1 100644
--- a/src/wix/WixToolset.Core.Burn/CommandLine/ReattachSubcommand.cs
+++ b/src/wix/WixToolset.Core.Burn/CommandLine/ReattachSubcommand.cs
@@ -35,8 +35,9 @@ namespace WixToolset.Core.Burn.CommandLine
        {
            return new CommandLineHelp("Reattaches a signed burn engine to a bundle.", "burn reattach [options] original.exe -engine signed.exe -o final.exe", new[]
            {
+                new CommandLineHelpSwitch("-engine", "Burn engine extracted using `wix burn detach` and then signed."),
                new CommandLineHelpSwitch("-intermediateFolder", "Optional working folder. If not specified %TMP% will be used."),
-                new CommandLineHelpSwitch("-out", "-o", "Output bundle with signed engine attached."),
+                new CommandLineHelpSwitch("-out", "-o", "Required path to output bundle with reattached signed engine that can then be signed as a whole."),
            });
        }
diff --git a/src/wix/WixToolset.Core.Burn/CommandLine/RemotePayloadSubcommand.cs b/src/wix/WixToolset.Core.Burn/CommandLine/RemotePayloadSubcommand.cs
index 2d65e740..3a232754 100644
--- a/src/wix/WixToolset.Core.Burn/CommandLine/RemotePayloadSubcommand.cs
+++ b/src/wix/WixToolset.Core.Burn/CommandLine/RemotePayloadSubcommand.cs
@@ -69,32 +69,17 @@ namespace WixToolset.Core.Burn.CommandLine
        public override CommandLineHelp GetCommandLineHelp()
        {
-            return new CommandLineHelp("Generate source code for a remote payload", "burn remotepayload [options] payloadfile [payloadfile ...]", new[]
+            return new CommandLineHelp("Generate source code for a remote payload.", "burn remotepayload [options] payloadfile [payloadfile ...]", new[]
            {
                new CommandLineHelpSwitch("-basepath", "-bp", "Folder as base to make payloads relative."),
-                new CommandLineHelpSwitch("-bundlepayloadgeneration", "Sets the package payload generation option; see the Payload Generation Types below."),
+                new CommandLineHelpSwitch("-bundlepayloadgeneration", "Sets the package payload generation option; available types are: none, externalwithoutdownloadurl, external, all."),
                new CommandLineHelpSwitch("-downloadurl", "-du", "Set the DownloadUrl attribute on the generated payloads."),
                new CommandLineHelpSwitch("-out", "-o", "Path to output the source code file."),
-                new CommandLineHelpSwitch("-recurse", "-r", "Indicates to add all payloads in directory recursively."),
+                new CommandLineHelpSwitch("-recurse", "-r", "Generate source code for all payloads in directory recursively."),
                new CommandLineHelpSwitch("-intermediatefolder", "Optional working folder. If not specified %TMP% folder will be created."),
-                new CommandLineHelpSwitch("-packagetype", "Explicitly set package type; see the Pacakge Types below."),
+                new CommandLineHelpSwitch("-packagetype", "Explicitly set package type; available types are: _bundle_, _exe_, _msu_."),
                new CommandLineHelpSwitch("-usecertificate", "Use certificate to validate signed payloads. This option is not recommended."),
-            })
+            });
-            {
-                Notes = String.Join(Environment.NewLine,
-                    "Payload Generation Types:",
-                    "  none",
-                    "  externalwithoutdownloadurl",
-                    "  external",
-                    "  all",
-                    String.Empty,
-                    "Package Types:",
-                    "  bundle",
-                    "  exe",
-                    "  msi",
-                    "  msp",
-                    "  msu")
-            };
        }
        public override Task<int> ExecuteAsync(CancellationToken cancellationToken)
diff --git a/src/wix/WixToolset.Core.WindowsInstaller/CommandLine/DecompilerSubcommand.cs b/src/wix/WixToolset.Core.WindowsInstaller/CommandLine/DecompilerSubcommand.cs
index 549b88aa..cac665c1 100644
--- a/src/wix/WixToolset.Core.WindowsInstaller/CommandLine/DecompilerSubcommand.cs
+++ b/src/wix/WixToolset.Core.WindowsInstaller/CommandLine/DecompilerSubcommand.cs
@@ -46,18 +46,17 @@ namespace WixToolset.Core.WindowsInstaller.CommandLine
        public override CommandLineHelp GetCommandLineHelp()
        {
-            return new CommandLineHelp("Converts a Windows Installer database back into source code.", "msi decompile [options] inputfile", new[]
+            return new CommandLineHelp("Converts a Windows Installer database back into source code.", "msi decompile [options] {inputfile.msi|inputfile.msm}", new[]
            {
-                new CommandLineHelpSwitch("-cub", "Optional path to a custom validation .CUBe file."),
+                new CommandLineHelpSwitch("-data", "Save output as WiX data instead of as a source file."),
-                new CommandLineHelpSwitch("-data", "Save output as data instead of as a source file."),
                new CommandLineHelpSwitch("-sct", "Suppress decompiling custom tables."),
                new CommandLineHelpSwitch("-sdet", "Suppress dropping empty tables."),
                new CommandLineHelpSwitch("-sras", "Suppress relative action sequencing."),
                new CommandLineHelpSwitch("-sui", "Suppress decompiling UI tables."),
-                new CommandLineHelpSwitch("-type", "Optional specify the input file type: msi or msm. If not specified, type will be inferred by file extension."),
+                new CommandLineHelpSwitch("-type", "Optionally specify the input file type: msi or msm. If not specified, type will be inferred by file extension."),
-                new CommandLineHelpSwitch("-intermediateFolder", "Optional working folder. If not specified %TMP% will be used."),
+                new CommandLineHelpSwitch("-intermediateFolder", "Optional working folder. If not specified, %TMP% will be used."),
-                new CommandLineHelpSwitch("-out", "-o", "Path to output the decompiled output file. If not specified, outputs next to inputfile"),
+                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."),
-                new CommandLineHelpSwitch("-x", "Folder to export embedded binaries and icons to."),
+                new CommandLineHelpSwitch("-x", "If specified, export embedded binaries and icons to specified folder."),
            });
        }
diff --git a/src/wix/WixToolset.Core.WindowsInstaller/CommandLine/TransformSubcommand.cs b/src/wix/WixToolset.Core.WindowsInstaller/CommandLine/TransformSubcommand.cs
index 0689773e..373cd2d4 100644
--- a/src/wix/WixToolset.Core.WindowsInstaller/CommandLine/TransformSubcommand.cs
+++ b/src/wix/WixToolset.Core.WindowsInstaller/CommandLine/TransformSubcommand.cs
@@ -62,13 +62,12 @@ namespace WixToolset.Core.WindowsInstaller.CommandLine
            {
                Switches = new[]
                {
-                    new CommandLineHelpSwitch("-a", "Admin image, generates source file information in the transform."),
                    new CommandLineHelpSwitch("-intermediateFolder", "Optional working folder. If not specified %TMP% will be used."),
                    new CommandLineHelpSwitch("-p", "Preserve unchanged rows."),
                    new CommandLineHelpSwitch("-pedantic", "Show pedantic messages."),
-                    new CommandLineHelpSwitch("-serr <flags>", "Suppress error when applying transform; see Error flags below"),
+                    new CommandLineHelpSwitch("-serr <flags>", "Suppress error when applying transform; see Error flags below."),
-                    new CommandLineHelpSwitch("-t <type>", "Use default validation flags for the transform type; see Transform types below"),
+                    new CommandLineHelpSwitch("-t <type>", "Use default validation flags for the transform type; see Transform types below."),
-                    new CommandLineHelpSwitch("-val <flags>", "Validation flags for the transform; see Validation flags below"),
+                    new CommandLineHelpSwitch("-val <flags>", "Validation flags for the transform; see Validation flags below."),
                    new CommandLineHelpSwitch("-x", "Folder to extract binaries."),
                    new CommandLineHelpSwitch("-xo", "Output transfrom as a WiX output instead of an MST file."),
                    new CommandLineHelpSwitch("-out", "-o", "Path to output the transform file."),
diff --git a/src/wix/WixToolset.Core.WindowsInstaller/CommandLine/ValidateSubcommand.cs b/src/wix/WixToolset.Core.WindowsInstaller/CommandLine/ValidateSubcommand.cs
index a3db003c..1294c87f 100644
--- a/src/wix/WixToolset.Core.WindowsInstaller/CommandLine/ValidateSubcommand.cs
+++ b/src/wix/WixToolset.Core.WindowsInstaller/CommandLine/ValidateSubcommand.cs
@@ -39,7 +39,7 @@ namespace WixToolset.Core.WindowsInstaller.CommandLine
        public override CommandLineHelp GetCommandLineHelp()
        {
-            return new CommandLineHelp("Validates MSI database using standard or custom ICEs.", "msi validate [options] inputfile", new[]
+            return new CommandLineHelp("Validates MSI database using standard or custom ICEs.", "msi validate [options] {inputfile.msi|inputfile.msm}", new[]
            {
                new CommandLineHelpSwitch("-cub", "Optional path to a custom validation .CUBe file."),
                new CommandLineHelpSwitch("-ice", "Validates only with the specified ICE. May be provided multiple times."),
diff --git a/src/wix/test/WixToolsetTest.Converters/PrereqPackageFixture.cs b/src/wix/test/WixToolsetTest.Converters/PrereqPackageFixture.cs
index b18dbfd3..1f095e67 100644
--- a/src/wix/test/WixToolsetTest.Converters/PrereqPackageFixture.cs
+++ b/src/wix/test/WixToolsetTest.Converters/PrereqPackageFixture.cs
@@ -48,7 +48,7 @@ namespace WixToolsetTest.Converters
            WixAssert.CompareLineByLine(new[]
            {
                "[Converted] The magic WixVariable 'WixMbaPrereqPackageId' has been removed. Add bal:PrereqPackage=\"yes\" to the target package instead. (WixMbaPrereqPackageIdDeprecated)",
-                "[Converted] The magic WixVariable 'WixMbaPrereqLicenseUrl' has been removed. Add bal:PrereqLicenseUrl=\"yes\" to a prereq package instead. (WixMbaPrereqLicenseUrlDeprecated)",
+                "[Converted] The magic WixVariable 'WixMbaPrereqLicenseUrl' has been removed. Add bal:PrereqLicenseUrl=\"<url>\" to a prereq package instead. (WixMbaPrereqLicenseUrlDeprecated)",
            }, messaging.Messages.Select(m => m.ToString()).ToArray());
            WixAssert.CompareLineByLine(expected, actualLines);
        }
@@ -86,7 +86,7 @@ namespace WixToolsetTest.Converters
            WixAssert.CompareLineByLine(new[]
            {
                "The magic WixVariable 'WixMbaPrereqPackageId' has been removed. Add bal:PrereqPackage=\"yes\" to the target package instead. (WixMbaPrereqPackageIdDeprecated)",
-                "The magic WixVariable 'WixMbaPrereqLicenseUrl' has been removed. Add bal:PrereqLicenseUrl=\"yes\" to a prereq package instead. (WixMbaPrereqLicenseUrlDeprecated)",
+                "The magic WixVariable 'WixMbaPrereqLicenseUrl' has been removed. Add bal:PrereqLicenseUrl=\"<url>\" to a prereq package instead. (WixMbaPrereqLicenseUrlDeprecated)",
            }, messaging.Messages.Select(m => m.ToString()).ToArray());
            WixAssert.CompareLineByLine(expected, actualLines);
        }
author	Bob Arnson <bob@firegiant.com>	2023-02-16 15:40:52 -0500
committer	Bob Arnson <github@bobs.org>	2023-02-16 17:17:42 -0500
commit	9b2edf15154381f76360d91da31bad6978ffaa1c (patch)
tree	30072d35c2f7d9eb7a94060634eda6bd0b1ba7b9 /src
parent	6f2511f58f60e63a15357a2fe37f83343dea3090 (diff)
download	wix-9b2edf15154381f76360d91da31bad6978ffaa1c.tar.gz wix-9b2edf15154381f76360d91da31bad6978ffaa1c.tar.bz2 wix-9b2edf15154381f76360d91da31bad6978ffaa1c.zip