diff --git a/Library/Homebrew/cmd/deps.rb b/Library/Homebrew/cmd/deps.rb index a90e5d80d9..583e7621f1 100644 --- a/Library/Homebrew/cmd/deps.rb +++ b/Library/Homebrew/cmd/deps.rb @@ -32,7 +32,7 @@ module Homebrew switch "--full-name", description: "List dependencies by their full name." switch "--include-implicit", - description: "Include implicit dependencies used to download and unpack source files" + description: "Include implicit dependencies used to download and unpack source files." switch "--include-build", description: "Include `:build` dependencies for ." switch "--include-optional", diff --git a/Library/Homebrew/cmd/uses.rb b/Library/Homebrew/cmd/uses.rb index 56aaa9d59b..10d5328d45 100644 --- a/Library/Homebrew/cmd/uses.rb +++ b/Library/Homebrew/cmd/uses.rb @@ -38,8 +38,8 @@ module Homebrew description: "Evaluate all available formulae and casks, whether installed or not, to show " \ "their dependents." switch "--include-implicit", - description: "Include formulae that have as an implicit dependency to " \ - "download and unpack source files" + description: "Include formulae that have as an implicit dependency for " \ + "downloading and unpacking source files." switch "--include-build", description: "Include formulae that specify as a `:build` dependency." switch "--include-test", diff --git a/Library/Homebrew/dev-cmd/audit.rb b/Library/Homebrew/dev-cmd/audit.rb index 03d9599e6c..2f0ddaf1ed 100644 --- a/Library/Homebrew/dev-cmd/audit.rb +++ b/Library/Homebrew/dev-cmd/audit.rb @@ -24,9 +24,9 @@ module Homebrew class Audit < AbstractCommand cmd_args do description <<~EOS - Check for Homebrew coding style violations. This should be run before - submitting a new formula or cask. If no | are provided, check all - locally available formulae and casks and skip style checks. Will exit with a + Check or for Homebrew coding style violations. This should be run + before submitting a new formula or cask. If no or are provided, check + all locally available formulae and casks and skip style checks. Will exit with a non-zero status if any errors are found. EOS flag "--os=", @@ -57,11 +57,11 @@ module Homebrew disable: true, hidden: true switch "--[no-]signing", - description: "Audit for signed apps, which are required on ARM" + description: "Audit for app signing, which is required by macOS on ARM." switch "--token-conflicts", description: "Audit for token conflicts." flag "--tap=", - description: "Check the formulae within the given tap, specified as `/`." + description: "Check formulae and casks within the given tap, specified as `/`." switch "--fix", description: "Fix style violations automatically using RuboCop's auto-correct feature." switch "--display-cop-names", diff --git a/Library/Homebrew/dev-cmd/generate-cask-ci-matrix.rb b/Library/Homebrew/dev-cmd/generate-cask-ci-matrix.rb index 8e9406ca03..dfaa9a050e 100644 --- a/Library/Homebrew/dev-cmd/generate-cask-ci-matrix.rb +++ b/Library/Homebrew/dev-cmd/generate-cask-ci-matrix.rb @@ -34,11 +34,11 @@ module Homebrew switch "--cask", "--casks", description: "Treat all named arguments as cask tokens." switch "--skip-install", - description: "Skip installing casks" + description: "Skip installing casks." switch "--new", - description: "Run new cask checks" + description: "Run new cask checks." switch "--syntax-only", - description: "Only run syntax checks" + description: "Only run syntax checks." conflicts "--url", "--cask" conflicts "--syntax-only", "--skip-install" diff --git a/Library/Homebrew/env_config.rb b/Library/Homebrew/env_config.rb index 5a1e68207f..1157ad0780 100644 --- a/Library/Homebrew/env_config.rb +++ b/Library/Homebrew/env_config.rb @@ -43,8 +43,8 @@ module Homebrew "`http://localhost:8080/v2/homebrew/core/gettext/manifests/0.21`", }, HOMEBREW_ARTIFACT_DOMAIN_NO_FALLBACK: { - description: "If `$HOMEBREW_ARTIFACT_DOMAIN` and `$HOMEBREW_ARTIFACT_DOMAIN_NO_FALLBACK` are both set, " \ - "if the request to `$HOMEBREW_ARTIFACT_DOMAIN` fails then it Homebrew will error rather than " \ + description: "When `$HOMEBREW_ARTIFACT_DOMAIN` and `$HOMEBREW_ARTIFACT_DOMAIN_NO_FALLBACK` are both set, " \ + "if the request to `$HOMEBREW_ARTIFACT_DOMAIN` fails then Homebrew will error rather than " \ "trying any other/default URLs.", boolean: true, }, @@ -422,7 +422,7 @@ module Homebrew boolean: true, }, HOMEBREW_NO_VERIFY_ATTESTATIONS: { - description: "If set, Homebrew not verify cryptographic attestations of build provenance for bottles " \ + description: "If set, Homebrew will not verify cryptographic attestations of build provenance for bottles " \ "from homebrew-core.", boolean: true, }, diff --git a/completions/fish/brew.fish b/completions/fish/brew.fish index 6a59be4ac5..2ba60e3296 100644 --- a/completions/fish/brew.fish +++ b/completions/fish/brew.fish @@ -330,7 +330,7 @@ __fish_brew_complete_arg 'analytics' -l quiet -d 'Make some output more quiet' __fish_brew_complete_arg 'analytics' -l verbose -d 'Make some output more verbose' -__fish_brew_complete_cmd 'audit' 'Check formula for Homebrew coding style violations' +__fish_brew_complete_cmd 'audit' 'Check formula or cask for Homebrew coding style violations' __fish_brew_complete_arg 'audit' -l arch -d 'Audit the given CPU architecture. (Pass `all` to audit all architectures.)' __fish_brew_complete_arg 'audit' -l audit-debug -d 'Enable debugging and profiling of audit methods' __fish_brew_complete_arg 'audit' -l cask -d 'Treat all named arguments as casks' @@ -345,16 +345,16 @@ __fish_brew_complete_arg 'audit' -l git -d 'Run additional, slower style checks __fish_brew_complete_arg 'audit' -l help -d 'Show this message' __fish_brew_complete_arg 'audit' -l installed -d 'Only check formulae and casks that are currently installed' __fish_brew_complete_arg 'audit' -l new -d 'Run various additional style checks to determine if a new formula or cask is eligible for Homebrew. This should be used when creating new formulae or casks and implies `--strict` and `--online`' -__fish_brew_complete_arg 'audit' -l no-signing -d 'Audit for signed apps, which are required on ARM' +__fish_brew_complete_arg 'audit' -l no-signing -d 'Audit for app signing, which is required by macOS on ARM' __fish_brew_complete_arg 'audit' -l online -d 'Run additional, slower style checks that require a network connection' __fish_brew_complete_arg 'audit' -l only -d 'Specify a comma-separated method list to only run the methods named `audit_`method' __fish_brew_complete_arg 'audit' -l only-cops -d 'Specify a comma-separated cops list to check for violations of only the listed RuboCop cops' __fish_brew_complete_arg 'audit' -l os -d 'Audit the given operating system. (Pass `all` to audit all operating systems.)' __fish_brew_complete_arg 'audit' -l quiet -d 'Make some output more quiet' -__fish_brew_complete_arg 'audit' -l signing -d 'Audit for signed apps, which are required on ARM' +__fish_brew_complete_arg 'audit' -l signing -d 'Audit for app signing, which is required by macOS on ARM' __fish_brew_complete_arg 'audit' -l skip-style -d 'Skip running non-RuboCop style checks. Useful if you plan on running `brew style` separately. Enabled by default unless a formula is specified by name' __fish_brew_complete_arg 'audit' -l strict -d 'Run additional, stricter style checks' -__fish_brew_complete_arg 'audit' -l tap -d 'Check the formulae within the given tap, specified as user`/`repo' +__fish_brew_complete_arg 'audit' -l tap -d 'Check formulae and casks within the given tap, specified as user`/`repo' __fish_brew_complete_arg 'audit' -l token-conflicts -d 'Audit for token conflicts' __fish_brew_complete_arg 'audit' -l verbose -d 'Make some output more verbose' __fish_brew_complete_arg 'audit; and not __fish_seen_argument -l cask -l casks' -a '(__fish_brew_suggest_formulae_all)' @@ -1817,7 +1817,7 @@ __fish_brew_complete_arg 'uses' -l eval-all -d 'Evaluate all available formulae __fish_brew_complete_arg 'uses' -l formula -d 'Include only formulae' __fish_brew_complete_arg 'uses' -l help -d 'Show this message' __fish_brew_complete_arg 'uses' -l include-build -d 'Include formulae that specify formula as a `:build` dependency' -__fish_brew_complete_arg 'uses' -l include-implicit -d 'Include formulae that have formula as an implicit dependency to download and unpack source files' +__fish_brew_complete_arg 'uses' -l include-implicit -d 'Include formulae that have formula as an implicit dependency for downloading and unpacking source files' __fish_brew_complete_arg 'uses' -l include-optional -d 'Include formulae that specify formula as an `:optional` dependency' __fish_brew_complete_arg 'uses' -l include-test -d 'Include formulae that specify formula as a `:test` dependency' __fish_brew_complete_arg 'uses' -l installed -d 'Only list formulae and casks that are currently installed' diff --git a/completions/zsh/_brew b/completions/zsh/_brew index b2e81f6986..c347b74d97 100644 --- a/completions/zsh/_brew +++ b/completions/zsh/_brew @@ -140,7 +140,7 @@ __brew_internal_commands() { '--repository:Display where Homebrew'\''s Git repository is located' '--version:Print the version numbers of Homebrew, Homebrew/homebrew-core and Homebrew/homebrew-cask (if tapped) to standard output' 'analytics:Control Homebrew'\''s anonymous aggregate user behaviour analytics' - 'audit:Check formula for Homebrew coding style violations' + 'audit:Check formula or cask for Homebrew coding style violations' 'autoremove:Uninstall formulae that were only installed as a dependency of another formula and are now no longer needed' 'bottle:Generate a bottle (binary package) from a formula that was installed with `--build-bottle`' 'bump:Displays out-of-date packages and the latest version available' @@ -458,16 +458,16 @@ _brew_audit() { '--help[Show this message]' \ '(--all)--installed[Only check formulae and casks that are currently installed]' \ '--new[Run various additional style checks to determine if a new formula or cask is eligible for Homebrew. This should be used when creating new formulae or casks and implies `--strict` and `--online`]' \ - '--no-signing[Audit for signed apps, which are required on ARM]' \ + '--no-signing[Audit for app signing, which is required by macOS on ARM]' \ '--online[Run additional, slower style checks that require a network connection]' \ '(--except --only-cops --except-cops)--only[Specify a comma-separated method list to only run the methods named `audit_`method]' \ '(--except-cops --strict --except-cops --only)--only-cops[Specify a comma-separated cops list to check for violations of only the listed RuboCop cops]' \ '--os[Audit the given operating system. (Pass `all` to audit all operating systems.)]' \ '--quiet[Make some output more quiet]' \ - '--signing[Audit for signed apps, which are required on ARM]' \ + '--signing[Audit for app signing, which is required by macOS on ARM]' \ '--skip-style[Skip running non-RuboCop style checks. Useful if you plan on running `brew style` separately. Enabled by default unless a formula is specified by name]' \ '(--only-cops --except-cops)--strict[Run additional, stricter style checks]' \ - '--tap[Check the formulae within the given tap, specified as user`/`repo]' \ + '--tap[Check formulae and casks within the given tap, specified as user`/`repo]' \ '--token-conflicts[Audit for token conflicts]' \ '--verbose[Make some output more verbose]' \ - formula \ @@ -2250,7 +2250,7 @@ _brew_uses() { '--eval-all[Evaluate all available formulae and casks, whether installed or not, to show their dependents]' \ '--help[Show this message]' \ '--include-build[Include formulae that specify formula as a `:build` dependency]' \ - '--include-implicit[Include formulae that have formula as an implicit dependency to download and unpack source files]' \ + '--include-implicit[Include formulae that have formula as an implicit dependency for downloading and unpacking source files]' \ '--include-optional[Include formulae that specify formula as an `:optional` dependency]' \ '--include-test[Include formulae that specify formula as a `:test` dependency]' \ '(--all --missing)--installed[Only list formulae and casks that are currently installed]' \ diff --git a/docs/Manpage.md b/docs/Manpage.md index 6e9bb5a481..ba01e5aa37 100644 --- a/docs/Manpage.md +++ b/docs/Manpage.md @@ -221,7 +221,7 @@ if the installed versions are outdated. `--include-implicit` -: Include implicit dependencies used to download and unpack source files +: Include implicit dependencies used to download and unpack source files. `--include-build` @@ -1479,8 +1479,8 @@ dependency for their stable builds. `--include-implicit` -: Include formulae that have *`formula`* as an implicit dependency to download - and unpack source files +: Include formulae that have *`formula`* as an implicit dependency for + downloading and unpacking source files. `--include-build` @@ -1614,10 +1614,10 @@ Homebrew/homebrew-cask (if tapped) to standard output. ### `audit` \[*`options`*\] \[*`formula`*\|*`cask`* ...\] -Check *`formula`* for Homebrew coding style violations. This should be run -before submitting a new formula or cask. If no *`formula`*\|*`cask`* are -provided, check all locally available formulae and casks and skip style checks. -Will exit with a non-zero status if any errors are found. +Check *`formula`* or *`cask`* for Homebrew coding style violations. This should +be run before submitting a new formula or cask. If no *`formula`* or *`cask`* +are provided, check all locally available formulae and casks and skip style +checks. Will exit with a non-zero status if any errors are found. `--os` @@ -1656,7 +1656,7 @@ Will exit with a non-zero status if any errors are found. `--[no-]signing` -: Audit for signed apps, which are required on ARM +: Audit for app signing, which is required by macOS on ARM. `--token-conflicts` @@ -1664,7 +1664,8 @@ Will exit with a non-zero status if any errors are found. `--tap` -: Check the formulae within the given tap, specified as *`user`*`/`*`repo`*. +: Check formulae and casks within the given tap, specified as + *`user`*`/`*`repo`*. `--fix` @@ -3670,9 +3671,9 @@ command execution e.g. `$(cat file)`. `HOMEBREW_ARTIFACT_DOMAIN_NO_FALLBACK` -: If `$HOMEBREW_ARTIFACT_DOMAIN` and `$HOMEBREW_ARTIFACT_DOMAIN_NO_FALLBACK` are - both set, if the request to `$HOMEBREW_ARTIFACT_DOMAIN` fails then it Homebrew - will error rather than trying any other/default URLs. +: When `$HOMEBREW_ARTIFACT_DOMAIN` and `$HOMEBREW_ARTIFACT_DOMAIN_NO_FALLBACK` + are both set, if the request to `$HOMEBREW_ARTIFACT_DOMAIN` fails then + Homebrew will error rather than trying any other/default URLs. `HOMEBREW_AUTO_UPDATE_SECS` @@ -4124,8 +4125,8 @@ command execution e.g. `$(cat file)`. `HOMEBREW_NO_VERIFY_ATTESTATIONS` -: If set, Homebrew not verify cryptographic attestations of build provenance for - bottles from homebrew-core. +: If set, Homebrew will not verify cryptographic attestations of build + provenance for bottles from homebrew-core. `HOMEBREW_PIP_INDEX_URL` diff --git a/manpages/brew.1 b/manpages/brew.1 index f833b4fcd5..af5aa97b3e 100644 --- a/manpages/brew.1 +++ b/manpages/brew.1 @@ -135,7 +135,7 @@ Show the union of dependencies for multiple \fIformula\fP, instead of the inters List dependencies by their full name\. .TP \fB\-\-include\-implicit\fP -Include implicit dependencies used to download and unpack source files +Include implicit dependencies used to download and unpack source files\. .TP \fB\-\-include\-build\fP Include \fB:build\fP dependencies for \fIformula\fP\&\. @@ -925,7 +925,7 @@ Only list formulae and casks that are not currently installed\. Evaluate all available formulae and casks, whether installed or not, to show their dependents\. .TP \fB\-\-include\-implicit\fP -Include formulae that have \fIformula\fP as an implicit dependency to download and unpack source files +Include formulae that have \fIformula\fP as an implicit dependency for downloading and unpacking source files\. .TP \fB\-\-include\-build\fP Include formulae that specify \fIformula\fP as a \fB:build\fP dependency\. @@ -1014,7 +1014,7 @@ If \fIuser\fP\fB/\fP\fIrepo\fP are provided, display where tap \fIuser\fP\fB/\fP Print the version numbers of Homebrew, Homebrew/homebrew\-core and Homebrew/homebrew\-cask (if tapped) to standard output\. .SH "DEVELOPER COMMANDS" .SS "\fBaudit\fP \fR[\fIoptions\fP] \fR[\fIformula\fP|\fIcask\fP \.\.\.]" -Check \fIformula\fP for Homebrew coding style violations\. This should be run before submitting a new formula or cask\. If no \fIformula\fP|\fIcask\fP are provided, check all locally available formulae and casks and skip style checks\. Will exit with a non\-zero status if any errors are found\. +Check \fIformula\fP or \fIcask\fP for Homebrew coding style violations\. This should be run before submitting a new formula or cask\. If no \fIformula\fP or \fIcask\fP are provided, check all locally available formulae and casks and skip style checks\. Will exit with a non\-zero status if any errors are found\. .TP \fB\-\-os\fP Audit the given operating system\. (Pass \fBall\fP to audit all operating systems\.) @@ -1041,13 +1041,13 @@ Evaluate all available formulae and casks, whether installed or not, to audit th Run various additional style checks to determine if a new formula or cask is eligible for Homebrew\. This should be used when creating new formulae or casks and implies \fB\-\-strict\fP and \fB\-\-online\fP\&\. .TP \fB\-\-[no\-]signing\fP -Audit for signed apps, which are required on ARM +Audit for app signing, which is required by macOS on ARM\. .TP \fB\-\-token\-conflicts\fP Audit for token conflicts\. .TP \fB\-\-tap\fP -Check the formulae within the given tap, specified as \fIuser\fP\fB/\fP\fIrepo\fP\&\. +Check formulae and casks within the given tap, specified as \fIuser\fP\fB/\fP\fIrepo\fP\&\. .TP \fB\-\-fix\fP Fix style violations automatically using RuboCop\[u2019]s auto\-correct feature\. @@ -2352,7 +2352,7 @@ Linux only: Pass this value to a type name representing the compiler\[u2019]s \f Prefix all download URLs, including those for bottles, with this value\. For example, \fBexport HOMEBREW_ARTIFACT_DOMAIN=http://localhost:8080\fP will cause a formula with the URL \fBhttps://example\.com/foo\.tar\.gz\fP to instead download from \fBhttp://localhost:8080/https://example\.com/foo\.tar\.gz\fP\&\. Bottle URLs however, have their domain replaced with this prefix\. This results in e\.g\. \fBhttps://ghcr\.io/v2/homebrew/core/gettext/manifests/0\.21\fP to instead be downloaded from \fBhttp://localhost:8080/v2/homebrew/core/gettext/manifests/0\.21\fP .TP \fBHOMEBREW_ARTIFACT_DOMAIN_NO_FALLBACK\fP -If \fB$HOMEBREW_ARTIFACT_DOMAIN\fP and \fB$HOMEBREW_ARTIFACT_DOMAIN_NO_FALLBACK\fP are both set, if the request to \fB$HOMEBREW_ARTIFACT_DOMAIN\fP fails then it Homebrew will error rather than trying any other/default URLs\. +When \fB$HOMEBREW_ARTIFACT_DOMAIN\fP and \fB$HOMEBREW_ARTIFACT_DOMAIN_NO_FALLBACK\fP are both set, if the request to \fB$HOMEBREW_ARTIFACT_DOMAIN\fP fails then Homebrew will error rather than trying any other/default URLs\. .TP \fBHOMEBREW_AUTO_UPDATE_SECS\fP Run \fBbrew update\fP once every \fB$HOMEBREW_AUTO_UPDATE_SECS\fP seconds before some commands, e\.g\. \fBbrew install\fP, \fBbrew upgrade\fP and \fBbrew tap\fP\&\. Alternatively, disable auto\-update entirely with \fB$HOMEBREW_NO_AUTO_UPDATE\fP\&\. @@ -2694,7 +2694,7 @@ If set, \fBbrew install\fP \fIformula|cask\fP will not upgrade \fIformula|cask\f If set, \fBbrew update\fP will not show the list of newly added formulae/casks\. .TP \fBHOMEBREW_NO_VERIFY_ATTESTATIONS\fP -If set, Homebrew not verify cryptographic attestations of build provenance for bottles from homebrew\-core\. +If set, Homebrew will not verify cryptographic attestations of build provenance for bottles from homebrew\-core\. .TP \fBHOMEBREW_PIP_INDEX_URL\fP If set, \fBbrew install\fP \fIformula\fP will use this URL to download PyPI package resources\.