diff --git a/Library/Homebrew/cask/cmd/abstract_command.rb b/Library/Homebrew/cask/cmd/abstract_command.rb
index acea33ce5811aaa69f208abc9cfaf9ec6fdadae7..fe57b597c8957ffd4204f599aed9432ad143dc15 100644
--- a/Library/Homebrew/cask/cmd/abstract_command.rb
+++ b/Library/Homebrew/cask/cmd/abstract_command.rb
@@ -42,7 +42,7 @@ module Cask
OPTIONS = [
[:switch, "--[no-]binaries", {
- description: "Disable/enable linking of helper executables. Default: enabled",
+ description: "Disable/enable linking of helper executables (default: enabled).",
env: :cask_opts_binaries,
}],
[:switch, "--require-sha", {
@@ -50,7 +50,7 @@ module Cask
env: :cask_opts_require_sha,
}],
[:switch, "--[no-]quarantine", {
- description: "Disable/enable quarantining of downloads. Default: enabled",
+ description: "Disable/enable quarantining of downloads (default: enabled).",
env: :cask_opts_quarantine,
}],
].freeze
diff --git a/Library/Homebrew/cli/parser.rb b/Library/Homebrew/cli/parser.rb
index 433bf8fdbf9dd3fd7a797a5eb1f43cee7687f4b2..6ff29d5a37c7a7f7e9fe8166c3d0be212455c476 100644
--- a/Library/Homebrew/cli/parser.rb
+++ b/Library/Homebrew/cli/parser.rb
@@ -33,65 +33,65 @@ module Homebrew
def self.global_cask_options
[
[:flag, "--appdir=", {
- description: "Target location for Applications. " \
- "Default: `#{Cask::Config::DEFAULT_DIRS[:appdir]}`",
+ description: "Target location for Applications " \
+ "(default: `#{Cask::Config::DEFAULT_DIRS[:appdir]}`).",
}],
[:flag, "--colorpickerdir=", {
- description: "Target location for Color Pickers. " \
- "Default: `#{Cask::Config::DEFAULT_DIRS[:colorpickerdir]}`",
+ description: "Target location for Color Pickers " \
+ "(default: `#{Cask::Config::DEFAULT_DIRS[:colorpickerdir]}`).",
}],
[:flag, "--prefpanedir=", {
- description: "Target location for Preference Panes. " \
- "Default: `#{Cask::Config::DEFAULT_DIRS[:prefpanedir]}`",
+ description: "Target location for Preference Panes " \
+ "(default: `#{Cask::Config::DEFAULT_DIRS[:prefpanedir]}`).",
}],
[:flag, "--qlplugindir=", {
- description: "Target location for QuickLook Plugins. " \
- "Default: `#{Cask::Config::DEFAULT_DIRS[:qlplugindir]}`",
+ description: "Target location for QuickLook Plugins " \
+ "(default: `#{Cask::Config::DEFAULT_DIRS[:qlplugindir]}`).",
}],
[:flag, "--mdimporterdir=", {
- description: "Target location for Spotlight Plugins. " \
- "Default: `#{Cask::Config::DEFAULT_DIRS[:mdimporterdir]}`",
+ description: "Target location for Spotlight Plugins " \
+ "(default: `#{Cask::Config::DEFAULT_DIRS[:mdimporterdir]}`).",
}],
[:flag, "--dictionarydir=", {
- description: "Target location for Dictionaries. " \
- "Default: `#{Cask::Config::DEFAULT_DIRS[:dictionarydir]}`",
+ description: "Target location for Dictionaries " \
+ "(default: `#{Cask::Config::DEFAULT_DIRS[:dictionarydir]}`).",
}],
[:flag, "--fontdir=", {
- description: "Target location for Fonts. " \
- "Default: `#{Cask::Config::DEFAULT_DIRS[:fontdir]}`",
+ description: "Target location for Fonts " \
+ "(default: `#{Cask::Config::DEFAULT_DIRS[:fontdir]}`).",
}],
[:flag, "--servicedir=", {
- description: "Target location for Services. " \
- "Default: `#{Cask::Config::DEFAULT_DIRS[:servicedir]}`",
+ description: "Target location for Services " \
+ "(default: `#{Cask::Config::DEFAULT_DIRS[:servicedir]}`).",
}],
[:flag, "--input_methoddir=", {
- description: "Target location for Input Methods. " \
- "Default: `#{Cask::Config::DEFAULT_DIRS[:input_methoddir]}`",
+ description: "Target location for Input Methods " \
+ "(default: `#{Cask::Config::DEFAULT_DIRS[:input_methoddir]}`).",
}],
[:flag, "--internet_plugindir=", {
- description: "Target location for Internet Plugins. " \
- "Default: `#{Cask::Config::DEFAULT_DIRS[:internet_plugindir]}`",
+ description: "Target location for Internet Plugins " \
+ "(default: `#{Cask::Config::DEFAULT_DIRS[:internet_plugindir]}`).",
}],
[:flag, "--audio_unit_plugindir=", {
- description: "Target location for Audio Unit Plugins. " \
- "Default: `#{Cask::Config::DEFAULT_DIRS[:audio_unit_plugindir]}`",
+ description: "Target location for Audio Unit Plugins " \
+ "(default: `#{Cask::Config::DEFAULT_DIRS[:audio_unit_plugindir]}`).",
}],
[:flag, "--vst_plugindir=", {
- description: "Target location for VST Plugins. " \
- "Default: `#{Cask::Config::DEFAULT_DIRS[:vst_plugindir]}`",
+ description: "Target location for VST Plugins " \
+ "(default: `#{Cask::Config::DEFAULT_DIRS[:vst_plugindir]}`).",
}],
[:flag, "--vst3_plugindir=", {
- description: "Target location for VST3 Plugins. " \
- "Default: `#{Cask::Config::DEFAULT_DIRS[:vst3_plugindir]}`",
+ description: "Target location for VST3 Plugins " \
+ "(default: `#{Cask::Config::DEFAULT_DIRS[:vst3_plugindir]}`).",
}],
[:flag, "--screen_saverdir=", {
- description: "Target location for Screen Savers. " \
- "Default: `#{Cask::Config::DEFAULT_DIRS[:screen_saverdir]}`",
+ description: "Target location for Screen Savers " \
+ "(default: `#{Cask::Config::DEFAULT_DIRS[:screen_saverdir]}`).",
}],
[:comma_array, "--language", {
- description: "Set language of the Cask to install. The first matching " \
- "language is used, otherwise the default language on the Cask. " \
- "The default value is the `language of your system`",
+ description: "Comma-separated list of language codes to prefer for cask installation. " \
+ "The first matching language is used, otherwise it reverts to the cask's " \
+ "default language. The default value is the language of your system.",
}],
]
end
diff --git a/Library/Homebrew/cmd/list.rb b/Library/Homebrew/cmd/list.rb
index 83788413bc8781c6bbd3324624a57805b51f44a7..13dc067728d32ffc1e35863b555c1dd4002665cd 100644
--- a/Library/Homebrew/cmd/list.rb
+++ b/Library/Homebrew/cmd/list.rb
@@ -17,12 +17,12 @@ module Homebrew
usage_banner <<~EOS
`list`, `ls` [<options>] [<formula|cask>]
- List all installed formulae or casks
+ List all installed formulae and casks.
If <formula> is provided, summarise the paths within its current keg.
EOS
switch "--formula", "--formulae",
- description: "List only formulae. `This is the default action on non TTY.`"
+ description: "List only formulae. This is the default when output is not to a terminal."
switch "--cask", "--casks",
description: "List only casks, or <cask> if provided."
switch "--unbrewed",
diff --git a/Library/Homebrew/cmd/outdated.rb b/Library/Homebrew/cmd/outdated.rb
index d3261a337abde2a9f75d4acf235e4f425fbf6fc2..6cb52621cbe764ecdc406a94840b78647fdaf2a9 100644
--- a/Library/Homebrew/cmd/outdated.rb
+++ b/Library/Homebrew/cmd/outdated.rb
@@ -26,9 +26,9 @@ module Homebrew
switch "-v", "--verbose",
description: "Include detailed version information."
switch "--formula",
- description: "Only output outdated formulae."
+ description: "List only outdated formulae."
switch "--cask",
- description: "Only output outdated casks."
+ description: "List only outdated casks."
flag "--json",
description: "Print output in JSON format. There are two versions: v1 and v2. " \
"v1 is deprecated and is currently the default if no version is specified. " \
diff --git a/Library/Homebrew/cmd/search.rb b/Library/Homebrew/cmd/search.rb
index 7fc967ecb0a7448c800ba8173b4aded8f3feb82d..4dca6423bbda6f0f72169f260ab3df192a559be7 100644
--- a/Library/Homebrew/cmd/search.rb
+++ b/Library/Homebrew/cmd/search.rb
@@ -50,7 +50,7 @@ module Homebrew
description: "Search for formulae with a description matching <text> and casks with "\
"a name matching <text>."
switch "--pull-request",
- description: "Search for GitHub pull requests for <text>."
+ description: "Search for GitHub pull requests containing <text>."
package_manager_switches = PACKAGE_MANAGERS.keys.map { |name| "--#{name}" }
package_manager_switches.each do |s|
diff --git a/Library/Homebrew/dev-cmd/audit.rb b/Library/Homebrew/dev-cmd/audit.rb
index 5b1a3027063451f9510a00f1aba01c2174c50bb4..9d4b2311ae4d18059f9ea87aa6b2569023bdcfca 100644
--- a/Library/Homebrew/dev-cmd/audit.rb
+++ b/Library/Homebrew/dev-cmd/audit.rb
@@ -54,7 +54,7 @@ module Homebrew
"make output easy to grep."
switch "--skip-style",
description: "Skip running non-RuboCop style checks. Useful if you plan on running "\
- "`brew style` separately. Default unless a formula is specified by name"
+ "`brew style` separately. Enabled by default unless a formula is specified by name."
switch "-D", "--audit-debug",
description: "Enable debugging and profiling of audit methods."
comma_array "--only",
diff --git a/Library/Homebrew/dev-cmd/create.rb b/Library/Homebrew/dev-cmd/create.rb
index ecedb06f264f4985234315009e9cb6b789715433..ea4b8a38a122582f24b9815f615ea44ec8bccd75 100644
--- a/Library/Homebrew/dev-cmd/create.rb
+++ b/Library/Homebrew/dev-cmd/create.rb
@@ -59,7 +59,7 @@ module Homebrew
flag "--tap=",
description: "Generate the new formula within the given tap, specified as <user>`/`<repo>."
switch "-f", "--force",
- description: "Ignore errors for disallowed formula names and named that shadow aliases."
+ description: "Ignore errors for disallowed formula names and names that shadow aliases."
conflicts "--autotools", "--cmake", "--crystal", "--go", "--meson", "--node", "--perl", "--python", "--rust"
named 1
diff --git a/Library/Homebrew/dev-cmd/tap-new.rb b/Library/Homebrew/dev-cmd/tap-new.rb
index 883263d58a28d66e1db3a63c095ff92e0f11d895..fb633405914667cd646bdfc3d809573d4b73876c 100644
--- a/Library/Homebrew/dev-cmd/tap-new.rb
+++ b/Library/Homebrew/dev-cmd/tap-new.rb
@@ -19,11 +19,11 @@ module Homebrew
EOS
switch "--no-git",
- description: "Don't initialize a git repository for the tap."
+ description: "Don't initialize a Git repository for the tap."
flag "--pull-label=",
- description: "Label name for pull requests ready to be pulled (default `pr-pull`)."
+ description: "Label name for pull requests ready to be pulled (default: `pr-pull`)."
flag "--branch=",
- description: "Initialize git repository with the specified branch name (default `main`)."
+ description: "Initialize Git repository with the specified branch name (default: `main`)."
conflicts "--no-git", "--branch"
named 1
diff --git a/Library/Homebrew/env_config.rb b/Library/Homebrew/env_config.rb
index a4e6a4e25fa9289f439fabc942955d16341fb1a9..f135217c91972ad530cc14babb206f1f01baffdc 100644
--- a/Library/Homebrew/env_config.rb
+++ b/Library/Homebrew/env_config.rb
@@ -12,7 +12,7 @@ module Homebrew
ENVS = {
HOMEBREW_ARCH: {
- description: "Linux only: Pass the set value to a type name representing the compiler's `-march` option.",
+ description: "Linux only: Pass this value to a type name representing the compiler's `-march` option.",
default: "native",
},
HOMEBREW_ARTIFACT_DOMAIN: {
@@ -30,8 +30,8 @@ module Homebrew
boolean: true,
},
HOMEBREW_BAT_CONFIG_PATH: {
- description: "Use the `bat` configuration file. For example, `HOMEBREW_BAT=$HOME/.bat/config`.",
- default_text: "$HOME/.bat/config",
+ description: "Use this as the `bat` configuration file.",
+ default_text: "`$HOME/.bat/config`.",
},
HOMEBREW_BINTRAY_KEY: {
description: "Use this API key when accessing the Bintray API (where bottles are stored).",
@@ -47,7 +47,7 @@ module Homebrew
default: HOMEBREW_BOTTLE_DEFAULT_DOMAIN,
},
HOMEBREW_BREW_GIT_REMOTE: {
- description: "Use the specified URL as the Homebrew/brew `git`(1) remote.",
+ description: "Use this URL as the Homebrew/brew `git`(1) remote.",
default: HOMEBREW_BREW_DEFAULT_GIT_REMOTE,
},
HOMEBREW_BROWSER: {
@@ -55,13 +55,13 @@ module Homebrew
default_text: "`$BROWSER` or the OS's default browser.",
},
HOMEBREW_CACHE: {
- description: "Use the specified directory as the download cache.",
+ description: "Use this directory as the download cache.",
default_text: "macOS: `$HOME/Library/Caches/Homebrew`, " \
"Linux: `$XDG_CACHE_HOME/Homebrew` or `$HOME/.cache/Homebrew`.",
default: HOMEBREW_DEFAULT_CACHE,
},
HOMEBREW_CASK_OPTS: {
- description: "Options which should be used for all `cask` commands. All `--*dir` options, " \
+ description: "Append these options to all `cask` commands. All `--*dir` options, " \
"`--language`, `--require-sha`, `--no-quarantine` and `--no-binaries` are supported." \
"\n" \
"For example, you might add something like the following to your " \
@@ -77,7 +77,7 @@ module Homebrew
boolean: true,
},
HOMEBREW_CORE_GIT_REMOTE: {
- description: "Use the specified URL as the Homebrew/homebrew-core `git`(1) remote.",
+ description: "Use this URL as the Homebrew/homebrew-core `git`(1) remote.",
default_text: "macOS: `https://github.com/Homebrew/homebrew-core`, " \
"Linux: `https://github.com/Homebrew/linuxbrew-core`.",
default: HOMEBREW_CORE_DEFAULT_GIT_REMOTE,
@@ -127,7 +127,7 @@ module Homebrew
},
HOMEBREW_FORBIDDEN_LICENSES: {
description: "A space-separated list of licenses. Homebrew will refuse to install a " \
- "formula if that formula or any of its dependencies has a license on this list.",
+ "formula if it or any of its dependencies has a license on this list.",
},
HOMEBREW_FORCE_BREWED_CURL: {
description: "If set, always use a Homebrew-installed `curl`(1) rather than the system version. " \
@@ -166,10 +166,10 @@ module Homebrew
"such as `brew search`. This is deprecated in favour of using `HOMEBREW_GITHUB_API_TOKEN`.",
},
HOMEBREW_GIT_EMAIL: {
- description: "Set the Git author and committer name to this value.",
+ description: "Set the Git author and committer email to this value.",
},
HOMEBREW_GIT_NAME: {
- description: "Set the Git author and committer email to this value.",
+ description: "Set the Git author and committer name to this value.",
},
HOMEBREW_INSTALL_BADGE: {
description: "Print this text before the installation summary of each successful build.",
@@ -177,13 +177,13 @@ module Homebrew
default: "馃嵑",
},
HOMEBREW_LIVECHECK_WATCHLIST: {
- description: "Use this file to get the list of default Formulae to check when no Formula argument " \
- "is passed to `brew livecheck`",
+ description: "Consult this file for the list of formulae to check by default when no formula argument " \
+ "is passed to `brew livecheck`.",
default: "$HOME/.brew_livecheck_watchlist",
},
HOMEBREW_LOGS: {
- description: "Use the specified directory to store log files.",
- default_text: "macOS: `$HOME/Library/Logs/Homebrew`, "\
+ description: "Use this directory to store log files.",
+ default_text: "macOS: `$HOME/Library/Logs/Homebrew`, " \
"Linux: `$XDG_CACHE_HOME/Homebrew/Logs` or `$HOME/.cache/Homebrew/Logs`.",
default: HOMEBREW_DEFAULT_LOGS,
},
@@ -197,7 +197,7 @@ module Homebrew
},
},
HOMEBREW_NO_ANALYTICS: {
- description: "If set, do not send analytics. See: <https://docs.brew.sh/Analytics>.",
+ description: "If set, do not send analytics. For more information, see: <https://docs.brew.sh/Analytics>",
boolean: true,
},
HOMEBREW_NO_AUTO_UPDATE: {
@@ -226,18 +226,18 @@ module Homebrew
},
HOMEBREW_NO_EMOJI: {
description: "If set, do not print `HOMEBREW_INSTALL_BADGE` on a successful build." \
- "\n\n *Note:* Only tries to print emoji on OS X Lion or newer.",
+ "\n\n *Note:* Will only try to print emoji on OS X Lion or newer.",
boolean: true,
},
HOMEBREW_NO_GITHUB_API: {
description: "If set, do not use the GitHub API, e.g. for searches or fetching relevant issues " \
- "on a failed install.",
+ "after a failed install.",
boolean: true,
},
HOMEBREW_NO_INSECURE_REDIRECT: {
description: "If set, forbid redirects from secure HTTPS to insecure HTTP." \
"\n\n *Note:* While ensuring your downloads are fully secure, this is likely to cause " \
- "from-source SourceForge, some GNU & GNOME based formulae to fail to download.",
+ "from-source SourceForge, some GNU & GNOME-hosted formulae to fail to download.",
boolean: true,
},
HOMEBREW_NO_INSTALL_CLEANUP: {
@@ -250,12 +250,12 @@ module Homebrew
boolean: true,
},
HOMEBREW_SKIP_OR_LATER_BOTTLES: {
- description: "If set with `HOMEBREW_DEVELOPER`, do not use bottles from older versions " \
+ description: "If set along with `HOMEBREW_DEVELOPER`, do not use bottles from older versions " \
"of macOS. This is useful in development on new macOS versions.",
boolean: true,
},
HOMEBREW_SORBET_RUNTIME: {
- description: "Enable runtime typechecking using Sorbet.",
+ description: "If set, enable runtime typechecking using Sorbet.",
boolean: true,
},
HOMEBREW_SVN: {
@@ -272,7 +272,7 @@ module Homebrew
default: HOMEBREW_DEFAULT_TEMP,
},
HOMEBREW_UPDATE_REPORT_ONLY_INSTALLED: {
- description: "If set, `brew update` only outputs updates to installed software.",
+ description: "If set, `brew update` only lists updates to installed software.",
boolean: true,
},
HOMEBREW_UPDATE_TO_TAG: {
@@ -310,7 +310,7 @@ module Homebrew
"from proxying by `curl`(1), `git`(1) and `svn`(1) when downloading through Homebrew.",
},
SUDO_ASKPASS: {
- description: "When this variable is set, the `-A` option is passed when calling `sudo`(8)",
+ description: "If set, pass the `-A` option when calling `sudo`(8).",
},
}.freeze