Skip to content

Commit 6cbdb82

Browse files
committed
(doc) Change source code to match production docs
While running the GenerateDocs.ps1 script, ahead of releasing version 2.3.0, it was found that the production docs has been updated to make some changes, for example, removal of older version numbers that no longer need to be displayed. This commit addresses this change in the production docs, but making the same change in the source code, so that the next time that GenerateDocs.ps1 is run, the output will better match what is already in place.
1 parent 5cb45e4 commit 6cbdb82

File tree

4 files changed

+4
-9
lines changed

4 files changed

+4
-9
lines changed

src/chocolatey/infrastructure.app/builders/ConfigurationBuilder.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -340,7 +340,7 @@ private static void SetAllFeatureFlags(ChocolateyConfiguration config, ConfigFil
340340
config.Features.UsePackageRepositoryOptimizations = SetFeatureFlag(ApplicationParameters.Features.UsePackageRepositoryOptimizations, configFileSettings, defaultEnabled: true, description: "Use Package Repository Optimizations - Turn on optimizations for reducing bandwidth with repository queries during package install/upgrade/outdated operations. Should generally be left enabled, unless a repository needs to support older methods of query. When disabled, this makes queries similar to the way they were done in earlier versions of Chocolatey.");
341341
config.Features.UsePackageHashValidation = SetFeatureFlag(ApplicationParameters.Features.UsePackageHashValidation, configFileSettings, defaultEnabled: false, description: "Use Package Hash Validation - Check the hash of the downloaded package file against the source provided hash. Only supports sources that provide SHA512 hashes. Disabled by default. Available in 2.3.0+");
342342
config.PromptForConfirmation = !SetFeatureFlag(ApplicationParameters.Features.AllowGlobalConfirmation, configFileSettings, defaultEnabled: false, description: "Prompt for confirmation in scripts or bypass.");
343-
config.DisableCompatibilityChecks = SetFeatureFlag(ApplicationParameters.Features.DisableCompatibilityChecks, configFileSettings, defaultEnabled: false, description: "Disable Compatibility Checks - Disable showing a warning when there is an incompatibility between Chocolatey CLI and Chocolatey Licensed Extension. Available in 1.1.0+");
343+
config.DisableCompatibilityChecks = SetFeatureFlag(ApplicationParameters.Features.DisableCompatibilityChecks, configFileSettings, defaultEnabled: false, description: "Disable Compatibility Checks - Disable showing a warning when there is an incompatibility between Chocolatey CLI and Chocolatey Licensed Extension.");
344344
}
345345

346346
private static bool SetFeatureFlag(string featureName, ConfigFileSettings configFileSettings, bool defaultEnabled, string description)
@@ -456,7 +456,7 @@ private static void SetGlobalOptions(IList<string> args, ChocolateyConfiguration
456456
"Log File to output to in addition to regular loggers.",
457457
option => config.AdditionalLogFileLocation = option.UnquoteSafe())
458458
.Add("skipcompatibilitychecks|skip-compatibility-checks",
459-
"SkipCompatibilityChecks - Prevent warnings being shown before and after command execution when a runtime compatibility problem is found between the version of Chocolatey and the Chocolatey Licensed Extension. Available in 1.1.0+",
459+
"SkipCompatibilityChecks - Prevent warnings being shown before and after command execution when a runtime compatibility problem is found between the version of Chocolatey and the Chocolatey Licensed Extension.",
460460
option => config.DisableCompatibilityChecks = option != null)
461461
.Add("ignore-http-cache",
462462
"IgnoreHttpCache - Ignore any HTTP caches that have previously been created when querying sources, and create new caches. Available in 2.1.0+",

src/chocolatey/infrastructure.app/commands/ChocolateyInstallCommand.cs

-4
Original file line numberDiff line numberDiff line change
@@ -279,10 +279,6 @@ Installs a package or a list of packages (sometimes specified as a
279279
"chocolatey".Log().Info(@"
280280
choco install <pkg|packages.config> [<pkg2> <pkgN>] [<options/switches>]
281281
282-
NOTE: `all` is a special package keyword that will allow you to install
283-
all packages from a custom feed. Will not work with Chocolatey default
284-
feed. THIS IS NOT YET REIMPLEMENTED.
285-
286282
NOTE: Any package name ending with .config is considered a
287283
'packages.config' file. Please see https://ch0.co/packages_config
288284

src/chocolatey/infrastructure.app/commands/ChocolateySearchCommand.cs

-1
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,6 @@ file a ticket so we can document it at
212212
choco {0}: https://raw.githubusercontent.com/wiki/chocolatey/choco/images/gifs/choco_search.gif
213213
214214
".FormatWith(configuration.CommandName));
215-
"chocolatey".Log().Info(ChocolateyLoggers.Important, "Alternative Sources");
216215

217216
"chocolatey".Log().Info(ChocolateyLoggers.Important, "Options and Switches");
218217
}

src/chocolatey/infrastructure.app/commands/ChocolateySourceCommand.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -70,10 +70,10 @@ public virtual void ConfigureArgumentParser(OptionSet optionSet, ChocolateyConfi
7070
"Bypass Proxy - Should this source explicitly bypass any explicitly or system configured proxies? Defaults to false.",
7171
option => configuration.SourceCommand.BypassProxy = option != null)
7272
.Add("allowselfservice|allow-self-service",
73-
"Allow Self-Service - Should this source be allowed to be used with self-service? Requires business edition (v1.10.0+) with feature 'useBackgroundServiceWithSelfServiceSourcesOnly' turned on. Defaults to false.",
73+
"Allow Self-Service - Should this source be allowed to be used with self-service? Requires business edition with feature 'useBackgroundServiceWithSelfServiceSourcesOnly' turned on. Defaults to false.",
7474
option => configuration.SourceCommand.AllowSelfService = option != null)
7575
.Add("adminonly|admin-only",
76-
"Visible to Administrators Only - Should this source be visible to non-administrators? Requires business edition (v1.12.2+). Defaults to false.",
76+
"Visible to Administrators Only - Should this source be visible to non-administrators? Requires business edition. Defaults to false.",
7777
option => configuration.SourceCommand.VisibleToAdminsOnly = option != null)
7878
;
7979
}

0 commit comments

Comments
 (0)