From 8a8359cdd4a056cf76892d682dd7f9dc062559db Mon Sep 17 00:00:00 2001 From: EricFromCanada Date: Tue, 20 Aug 2019 00:04:14 -0400 Subject: [PATCH] manpages: sentence rewording for readability Use active voice when applicable, better verbs & adjectives, preposition usage, proper tense, etc. --- Library/Homebrew/cmd/--env.rb | 4 ++-- Library/Homebrew/cmd/--version.rb | 2 +- Library/Homebrew/cmd/analytics.rb | 2 +- Library/Homebrew/cmd/cleanup.rb | 4 ++-- Library/Homebrew/cmd/command.rb | 2 +- Library/Homebrew/cmd/commands.rb | 2 +- Library/Homebrew/cmd/deps.rb | 4 ++-- Library/Homebrew/cmd/desc.rb | 6 +++--- Library/Homebrew/cmd/diy.rb | 4 ++-- Library/Homebrew/cmd/doctor.rb | 2 +- Library/Homebrew/cmd/fetch.rb | 4 ++-- Library/Homebrew/cmd/gist-logs.rb | 11 +++++------ Library/Homebrew/cmd/home.rb | 4 ++-- Library/Homebrew/cmd/info.rb | 6 +++--- Library/Homebrew/cmd/install.rb | 20 ++++++++++---------- Library/Homebrew/cmd/link.rb | 8 ++++---- Library/Homebrew/cmd/list.rb | 12 ++++++------ Library/Homebrew/cmd/log.rb | 6 +++--- Library/Homebrew/cmd/migrate.rb | 2 +- Library/Homebrew/cmd/missing.rb | 9 ++++----- Library/Homebrew/cmd/options.rb | 4 ++-- Library/Homebrew/cmd/outdated.rb | 12 +++++------- Library/Homebrew/cmd/readall.rb | 2 +- Library/Homebrew/cmd/reinstall.rb | 7 ++++--- Library/Homebrew/cmd/search.rb | 6 +++--- Library/Homebrew/cmd/sh.rb | 2 +- Library/Homebrew/cmd/shellenv.sh | 7 +++---- Library/Homebrew/cmd/tap-info.rb | 7 ++++--- Library/Homebrew/cmd/tap.rb | 2 +- Library/Homebrew/cmd/unlink.rb | 6 +++--- Library/Homebrew/cmd/update.sh | 2 +- Library/Homebrew/cmd/upgrade.rb | 15 +++++++-------- Library/Homebrew/cmd/uses.rb | 12 ++++-------- Library/Homebrew/dev-cmd/audit.rb | 4 ++-- Library/Homebrew/dev-cmd/bottle.rb | 2 +- Library/Homebrew/dev-cmd/bump-formula-pr.rb | 11 +++++------ Library/Homebrew/dev-cmd/bump-revision.rb | 2 +- Library/Homebrew/dev-cmd/create.rb | 8 ++++---- Library/Homebrew/dev-cmd/extract.rb | 5 +++-- Library/Homebrew/dev-cmd/linkage.rb | 4 ++-- Library/Homebrew/dev-cmd/man.rb | 2 +- Library/Homebrew/dev-cmd/pull.rb | 10 +++++----- Library/Homebrew/dev-cmd/ruby.rb | 2 +- Library/Homebrew/dev-cmd/test.rb | 2 +- Library/Homebrew/dev-cmd/tests.rb | 2 +- Library/Homebrew/dev-cmd/update-test.rb | 4 ++-- Library/Homebrew/manpages/brew.1.md.erb | 14 +++++++------- 47 files changed, 131 insertions(+), 139 deletions(-) diff --git a/Library/Homebrew/cmd/--env.rb b/Library/Homebrew/cmd/--env.rb index 399a2da0e4..a96ddf6dda 100644 --- a/Library/Homebrew/cmd/--env.rb +++ b/Library/Homebrew/cmd/--env.rb @@ -13,7 +13,7 @@ module Homebrew usage_banner <<~EOS `--env` [] - Show a summary of the Homebrew build environment as a plain list. + Summarize Homebrew's build environment as a plain list. If the command's output is sent through a pipe and no shell is specified, the list is formatted for export to `bash`(1) unless `--plain` is passed. @@ -22,7 +22,7 @@ module Homebrew description: "Generate a list of environment variables for the specified shell, " \ "or `--shell=auto` to detect the current shell." switch "--plain", - description: "Plain output even when piped." + description: "Generate plain output even when piped." end end diff --git a/Library/Homebrew/cmd/--version.rb b/Library/Homebrew/cmd/--version.rb index e5f5453c47..45666abbda 100644 --- a/Library/Homebrew/cmd/--version.rb +++ b/Library/Homebrew/cmd/--version.rb @@ -11,7 +11,7 @@ module Homebrew `--version` Print the version numbers of Homebrew, Homebrew/homebrew-core and Homebrew/homebrew-cask - (if tapped) to standard output and exit. + (if tapped) to standard output. EOS end end diff --git a/Library/Homebrew/cmd/analytics.rb b/Library/Homebrew/cmd/analytics.rb index 4256e8aca6..9aa663980e 100644 --- a/Library/Homebrew/cmd/analytics.rb +++ b/Library/Homebrew/cmd/analytics.rb @@ -12,7 +12,7 @@ module Homebrew If `on` or `off` is passed, turn Homebrew's analytics on or off respectively. - If `state` is passed, display anonymous user behaviour analytics state. + If `state` is passed, display the current anonymous user behaviour analytics state. Read more at . If `regenerate-uuid` is passed, regenerate the UUID used in Homebrew's analytics. diff --git a/Library/Homebrew/cmd/cleanup.rb b/Library/Homebrew/cmd/cleanup.rb index afead9e23f..4a0837b82f 100644 --- a/Library/Homebrew/cmd/cleanup.rb +++ b/Library/Homebrew/cmd/cleanup.rb @@ -11,9 +11,9 @@ module Homebrew usage_banner <<~EOS `cleanup` [] [|] - Remove stale lock files and outdated downloads for formulae and casks, + Remove stale lock files and outdated downloads for all formulae and casks, and remove old versions of installed formulae. If arguments are specified, - only do this for the specified formulae and casks. + only do this for the given formulae and casks. EOS flag "--prune=", description: "Remove all cache files older than specified ." diff --git a/Library/Homebrew/cmd/command.rb b/Library/Homebrew/cmd/command.rb index 0968eeda22..291690ebe5 100644 --- a/Library/Homebrew/cmd/command.rb +++ b/Library/Homebrew/cmd/command.rb @@ -11,7 +11,7 @@ module Homebrew usage_banner <<~EOS `command` - Display the path to the file which is used when invoking `brew` . + Display the path to the file being used when invoking `brew` . EOS switch :verbose switch :debug diff --git a/Library/Homebrew/cmd/commands.rb b/Library/Homebrew/cmd/commands.rb index a396fc3d47..03e5a4f3d0 100644 --- a/Library/Homebrew/cmd/commands.rb +++ b/Library/Homebrew/cmd/commands.rb @@ -16,7 +16,7 @@ module Homebrew description: "List only the names of commands without category headers." switch "--include-aliases", depends_on: "--quiet", - description: "Include the aliases of internal commands." + description: "Include aliases of internal commands." switch :verbose switch :debug end diff --git a/Library/Homebrew/cmd/deps.rb b/Library/Homebrew/cmd/deps.rb index 19b4cffb32..bc16d264bd 100644 --- a/Library/Homebrew/cmd/deps.rb +++ b/Library/Homebrew/cmd/deps.rb @@ -17,7 +17,7 @@ module Homebrew show the intersection of dependencies for each formula. EOS switch "-n", - description: "Show dependencies in topological order." + description: "Sort dependencies in topological order." switch "--1", description: "Only show dependencies one level down, instead of recursing." switch "--union", @@ -47,7 +47,7 @@ module Homebrew description: "List dependencies for all available formulae." switch "--for-each", description: "Switch into the mode used by the `--all` option, but only list dependencies "\ - "for the specified , one formula per line. This is used for "\ + "for each provided , one formula per line. This is used for "\ "debugging the `--installed`/`--all` display mode." switch :verbose switch :debug diff --git a/Library/Homebrew/cmd/desc.rb b/Library/Homebrew/cmd/desc.rb index 03952a2352..3512712047 100644 --- a/Library/Homebrew/cmd/desc.rb +++ b/Library/Homebrew/cmd/desc.rb @@ -20,13 +20,13 @@ module Homebrew first search, making that search slower than subsequent ones. EOS flag "-s", "--search=", - description: "Search both name and description for provided . If is flanked by "\ + description: "Search both names and descriptions for . If is flanked by "\ "slashes, it is interpreted as a regular expression." flag "-n", "--name=", - description: "Search just the names for provided . If is flanked by slashes, it is "\ + description: "Search just names for . If is flanked by slashes, it is "\ "interpreted as a regular expression." flag "-d", "--description=", - description: "Search just the descriptions for provided . If is flanked by slashes, "\ + description: "Search just descriptions for . If is flanked by slashes, "\ "it is interpreted as a regular expression." switch :verbose conflicts "--search=", "--name=", "--description=" diff --git a/Library/Homebrew/cmd/diy.rb b/Library/Homebrew/cmd/diy.rb index ec8dc9c6ac..70f8e63668 100644 --- a/Library/Homebrew/cmd/diy.rb +++ b/Library/Homebrew/cmd/diy.rb @@ -16,9 +16,9 @@ module Homebrew the Cellar and then link it into Homebrew's prefix with `brew link`. EOS flag "--name=", - description: "Explicitly set the provided of the package being installed." + description: "Explicitly set the of the package being installed." flag "--version=", - description: "Explicitly set the provided of the package being installed." + description: "Explicitly set the of the package being installed." switch :verbose switch :debug end diff --git a/Library/Homebrew/cmd/doctor.rb b/Library/Homebrew/cmd/doctor.rb index 8b3a30e65e..bcb718b2cc 100644 --- a/Library/Homebrew/cmd/doctor.rb +++ b/Library/Homebrew/cmd/doctor.rb @@ -11,7 +11,7 @@ module Homebrew usage_banner <<~EOS `doctor` [] - Check your system for potential problems. Doctor exits with a non-zero status + Check your system for potential problems. Will exit with a non-zero status if any potential problems are found. Please note that these warnings are just used to help the Homebrew maintainers with debugging if you file an issue. If everything you use Homebrew for is working fine: please don't worry or file diff --git a/Library/Homebrew/cmd/fetch.rb b/Library/Homebrew/cmd/fetch.rb index 324b08becd..e9159f504d 100644 --- a/Library/Homebrew/cmd/fetch.rb +++ b/Library/Homebrew/cmd/fetch.rb @@ -25,10 +25,10 @@ module Homebrew description: "Do a verbose VCS checkout, if the URL represents a VCS. This is useful for "\ "seeing if an existing VCS cache has been updated." switch "--retry", - description: "Retry if a download fails or re-download if the checksum of a previously cached "\ + description: "Retry if downloading fails or re-download if the checksum of a previously cached "\ "version no longer matches." switch "--deps", - description: "Download dependencies for any listed ." + description: "Also download dependencies for any listed ." switch "-s", "--build-from-source", description: "Download source packages rather than a bottle." switch "--build-bottle", diff --git a/Library/Homebrew/cmd/gist-logs.rb b/Library/Homebrew/cmd/gist-logs.rb index efac55a959..cd88d5f4f7 100644 --- a/Library/Homebrew/cmd/gist-logs.rb +++ b/Library/Homebrew/cmd/gist-logs.rb @@ -15,18 +15,17 @@ module Homebrew usage_banner <<~EOS `gist-logs` [] - Upload logs for a failed build of to a new Gist. - - If no logs are found, an error message is presented. + Upload logs for a failed build of to a new Gist. Presents an + error message if no logs are found. EOS switch "--with-hostname", description: "Include the hostname in the Gist." switch "-n", "--new-issue", - description: "Automatically create a new issue in the appropriate GitHub repository as "\ - "well as creating the Gist." + description: "Automatically create a new issue in the appropriate GitHub repository "\ + "after creating the Gist." switch "-p", "--private", description: "The Gist will be marked private and will not appear in listings but will "\ - "be accessible with the link." + "be accessible with its link." switch :verbose switch :debug end diff --git a/Library/Homebrew/cmd/home.rb b/Library/Homebrew/cmd/home.rb index eb81019d1a..8746c0feed 100644 --- a/Library/Homebrew/cmd/home.rb +++ b/Library/Homebrew/cmd/home.rb @@ -10,8 +10,8 @@ module Homebrew usage_banner <<~EOS `home` [] - Open 's homepage in a browser. If no formula is provided, - open Homebrew's own homepage in a browser. + Open 's homepage in a browser, or open Homebrew's own homepage + if no formula is provided. EOS switch :debug end diff --git a/Library/Homebrew/cmd/info.rb b/Library/Homebrew/cmd/info.rb index 811e73d20d..01e3ca5416 100644 --- a/Library/Homebrew/cmd/info.rb +++ b/Library/Homebrew/cmd/info.rb @@ -19,10 +19,10 @@ module Homebrew Display brief statistics for your Homebrew installation. - If is specified, show summary of information about . + If is provided, show summary of information about . EOS switch "--analytics", - description: "Display global Homebrew analytics data or, if specified, installation and "\ + description: "List global Homebrew analytics data or, if specified, installation and "\ "build error data for (provided neither `HOMEBREW_NO_ANALYTICS` "\ "nor `HOMEBREW_NO_GITHUB_API` are set)." flag "--days", @@ -35,7 +35,7 @@ module Homebrew "The value for must be `install`, `install-on-request`, "\ "`cask-install`, `build-error` or `os-version`. The default is `install`." switch "--github", - description: "Open a browser to the GitHub source page for . "\ + description: "Open the GitHub source page for in a browser. "\ "To view formula history locally: `brew log -p` " flag "--json", description: "Print a JSON representation of . Currently the default and only accepted "\ diff --git a/Library/Homebrew/cmd/install.rb b/Library/Homebrew/cmd/install.rb index 8cb87fd3c2..8c61e87d64 100644 --- a/Library/Homebrew/cmd/install.rb +++ b/Library/Homebrew/cmd/install.rb @@ -20,7 +20,7 @@ module Homebrew Install . Additional options specific to may be appended to the command. - Unless `HOMEBREW_NO_INSTALL_CLEANUP` is set, `brew cleanup` will be run for the + Unless `HOMEBREW_NO_INSTALL_CLEANUP` is set, `brew cleanup` will then be run for the installed formulae or, every 30 days, for all formulae. EOS switch :debug, @@ -37,16 +37,16 @@ module Homebrew "using this flag." switch "--only-dependencies", description: "Install the dependencies with specified options but do not install the "\ - "specified formula." + "formula itself." flag "--cc=", - description: "Attempt to compile using provided . should be the "\ - "name of the compiler's executable, for instance `gcc-7` for GCC 7. "\ - "In order to use LLVM's clang, use `llvm_clang`. To specify the "\ - "Apple-provided clang, use `clang`. This option will only accept "\ + description: "Attempt to compile using the specified , which should be the "\ + "name of the compiler's executable, e.g. `gcc-7` for GCC 7. "\ + "In order to use LLVM's clang, specify `llvm_clang`. To use the "\ + "Apple-provided clang, specify `clang`. This option will only accept "\ "compilers that are provided by Homebrew or bundled with macOS. "\ "Please do not file issues if you encounter errors while using this option." switch "-s", "--build-from-source", - description: "Compile the specified from source even if a bottle is provided. "\ + description: "Compile from source even if a bottle is provided. "\ "Dependencies will still be installed from bottles if they are available." switch "--force-bottle", description: "Install from a bottle if it exists for the current or newest version of "\ @@ -59,16 +59,16 @@ module Homebrew description: "If defines it, install the HEAD version, aka. master, trunk, unstable." switch "--fetch-HEAD", description: "Fetch the upstream repository to detect if the HEAD installation of the "\ - "formula is outdated. Otherwise, the repository's HEAD will be checked for "\ + "formula is outdated. Otherwise, the repository's HEAD will only be checked for "\ "updates when a new stable or development version has been released." switch "--keep-tmp", - description: "Don't delete the temporary files created during installation." + description: "Retain the temporary files created during installation." switch "--build-bottle", description: "Prepare the formula for eventual bottling during installation, skipping any "\ "post-install steps." flag "--bottle-arch=", depends_on: "--build-bottle", - description: "Optimise bottles for the given architecture rather than the oldest "\ + description: "Optimise bottles for the specified architecture rather than the oldest "\ "architecture supported by the version of macOS the bottles are built on." switch :force, description: "Install without checking for previously installed keg-only or "\ diff --git a/Library/Homebrew/cmd/link.rb b/Library/Homebrew/cmd/link.rb index 0e9890563d..4b45ca98ac 100644 --- a/Library/Homebrew/cmd/link.rb +++ b/Library/Homebrew/cmd/link.rb @@ -12,15 +12,15 @@ module Homebrew usage_banner <<~EOS `link`, `ln` [] - Symlink all of 's installed files into the Homebrew prefix. This + Symlink all of 's installed files into Homebrew's prefix. This is done automatically when you install formulae but can be useful for DIY installations. EOS switch "--overwrite", - description: "Delete files already existing in the prefix while linking." + description: "Delete files that already exist in the prefix while linking." switch "-n", "--dry-run", - description: "List all files which would be linked or deleted by "\ - "`brew link --overwrite`, but will not actually link or delete any files." + description: "List files which would be linked or deleted by "\ + "`brew link --overwrite` without actually linking or deleting any files." switch :force, description: "Allow keg-only formulae to be linked." switch :verbose diff --git a/Library/Homebrew/cmd/list.rb b/Library/Homebrew/cmd/list.rb index a923f08ef7..cde69c3ad5 100644 --- a/Library/Homebrew/cmd/list.rb +++ b/Library/Homebrew/cmd/list.rb @@ -21,27 +21,27 @@ module Homebrew "passed, other options (i.e. `-1`, `-l`, `-r` and `-t`) are passed to `ls`(1) "\ "which produces the actual output." switch "--unbrewed", - description: "List all files in the Homebrew prefix not installed by Homebrew." + description: "List files in Homebrew's prefix not installed by Homebrew." switch "--versions", description: "Show the version number for installed formulae, or only the specified "\ - "formulae if are given." + "formulae if are provided." switch "--multiple", depends_on: "--versions", description: "Only show formulae with multiple versions installed." switch "--pinned", description: "Show the versions of pinned formulae, or only the specified (pinned) "\ - "formulae if are given. See also `pin`, `unpin`." + "formulae if are provided. See also `pin`, `unpin`." # passed through to ls switch "-1", description: "Force output to be one entry per line. " \ "This is the default when output is not to a terminal." switch "-l", description: "List in long format. If the output is to a terminal, "\ - "a total sum for all the file sizes is output on a line before the long listing." + "a total sum for all the file sizes is printed before the long listing." switch "-r", - description: "Reverse the order of the sort to get the oldest entries first." + description: "Reverse the order of the sort to list the oldest entries first." switch "-t", - description: "Sort by time modified (most recently modified first)." + description: "Sort by time modified, listing most recently modified first." switch :verbose switch :debug end diff --git a/Library/Homebrew/cmd/log.rb b/Library/Homebrew/cmd/log.rb index f7feffd717..58c70ec8b0 100644 --- a/Library/Homebrew/cmd/log.rb +++ b/Library/Homebrew/cmd/log.rb @@ -15,11 +15,11 @@ module Homebrew if no formula is provided. EOS switch "-p", "-u", "--patch", - description: "Also output patch from commit." + description: "Also print patch from commit." switch "--stat", - description: "Also output diffstat from commit." + description: "Also print diffstat from commit." switch "--oneline", - description: "Output only one line per commit." + description: "Print only one line per commit." flag "-1", "--max-count", description: "Print only one or a specified number of commits." end diff --git a/Library/Homebrew/cmd/migrate.rb b/Library/Homebrew/cmd/migrate.rb index 7ef015e885..d15b999830 100644 --- a/Library/Homebrew/cmd/migrate.rb +++ b/Library/Homebrew/cmd/migrate.rb @@ -15,7 +15,7 @@ module Homebrew packages. EOS switch :force, - description: "Treat installed and passed as if they are from "\ + description: "Treat installed and provided as if they are from "\ "the same taps and migrate them anyway." switch :verbose switch :debug diff --git a/Library/Homebrew/cmd/missing.rb b/Library/Homebrew/cmd/missing.rb index 6bf68e1434..e89fac4c58 100644 --- a/Library/Homebrew/cmd/missing.rb +++ b/Library/Homebrew/cmd/missing.rb @@ -13,13 +13,12 @@ module Homebrew usage_banner <<~EOS `missing` [] [] - Check the given for missing dependencies. If no are - given, check all installed brews. - - `missing` exits with a non-zero status if any formulae are missing dependencies. + Check the given kegs for missing dependencies. If no are + provided, check all kegs. Will exit with a non-zero status if any kegs are found + to be missing dependencies. EOS comma_array "--hide", - description: "Act as if none of the provided are installed. should be "\ + description: "Act as if none of the specified are installed. should be "\ "a comma-separated list of formulae." switch :verbose switch :debug diff --git a/Library/Homebrew/cmd/options.rb b/Library/Homebrew/cmd/options.rb index 1efaf3fb3a..99948ef6f7 100644 --- a/Library/Homebrew/cmd/options.rb +++ b/Library/Homebrew/cmd/options.rb @@ -12,12 +12,12 @@ module Homebrew usage_banner <<~EOS `options` [] [] - Display install options specific to . + Show install options specific to . EOS switch "--compact", description: "Show all options on a single line separated by spaces." switch "--installed", - description: "Show options for all installed formulae." + description: "Show options for formulae that are currently installed." switch "--all", description: "Show options for all available formulae." switch :debug diff --git a/Library/Homebrew/cmd/outdated.rb b/Library/Homebrew/cmd/outdated.rb index 57613fb472..7043769b9f 100644 --- a/Library/Homebrew/cmd/outdated.rb +++ b/Library/Homebrew/cmd/outdated.rb @@ -12,22 +12,20 @@ module Homebrew usage_banner <<~EOS `outdated` [] - List formulae that have an updated version available. - - By default, version information is displayed in interactive shells, and - suppressed otherwise. + List installed formulae that have an updated version available. By default, version + information is displayed in interactive shells, and suppressed otherwise. EOS switch :quiet, - description: "List only the names of outdated brews (takes precedence over `--verbose`)." + description: "List only the names of outdated kegs (takes precedence over `--verbose`)." switch :verbose, - description: "Display detailed version information." + description: "Include detailed version information." flag "--json", description: "Print output in JSON format. Currently the default and only accepted "\ "value for is `v1`. See the docs for examples of using the JSON "\ "output: " switch "--fetch-HEAD", description: "Fetch the upstream repository to detect if the HEAD installation of the "\ - "formula is outdated. Otherwise, the repository's HEAD will be checked for "\ + "formula is outdated. Otherwise, the repository's HEAD will only be checked for "\ "updates when a new stable or development version has been released." switch :debug conflicts "--quiet", "--verbose", "--json" diff --git a/Library/Homebrew/cmd/readall.rb b/Library/Homebrew/cmd/readall.rb index 24dd837e56..1cfe6d2f32 100644 --- a/Library/Homebrew/cmd/readall.rb +++ b/Library/Homebrew/cmd/readall.rb @@ -11,7 +11,7 @@ module Homebrew usage_banner <<~EOS `readall` [] [] - Import all formulae from specified (defaults to all installed taps). + Import all formulae from the specified , or from all installed taps if none is provided. This can be useful for debugging issues across all formulae when making significant changes to `formula.rb`, testing the performance of loading all formulae or to determine if any current formulae have Ruby issues. diff --git a/Library/Homebrew/cmd/reinstall.rb b/Library/Homebrew/cmd/reinstall.rb index e3a3acc606..126cb7242a 100644 --- a/Library/Homebrew/cmd/reinstall.rb +++ b/Library/Homebrew/cmd/reinstall.rb @@ -15,9 +15,10 @@ module Homebrew usage_banner <<~EOS `reinstall` [] - Uninstall and then install (with existing and any appended install options). + Uninstall and then install using the same options it was originally + installed with, plus any appended brew formula options. - Unless `HOMEBREW_NO_INSTALL_CLEANUP` is set, `brew cleanup` will be run for the + Unless `HOMEBREW_NO_INSTALL_CLEANUP` is set, `brew cleanup` will then be run for the reinstalled formulae or, every 30 days, for all formulae. EOS switch :debug, @@ -29,7 +30,7 @@ module Homebrew description: "Install from a bottle if it exists for the current or newest version of "\ "macOS, even if it would not normally be used for installation." switch "--keep-tmp", - description: "Don't delete the temporary files created during installation." + description: "Retain the temporary files created during installation." switch :force, description: "Install without checking for previously installed keg-only or "\ "non-migrated versions." diff --git a/Library/Homebrew/cmd/search.rb b/Library/Homebrew/cmd/search.rb index 932493783a..f8c15dcc3c 100644 --- a/Library/Homebrew/cmd/search.rb +++ b/Library/Homebrew/cmd/search.rb @@ -30,14 +30,14 @@ module Homebrew `search` [] [|`/``/`] Perform a substring search of cask tokens and formula names for . If - is surrounded with slashes, then it is interpreted as a regular expression. + is flanked by slashes, it is interpreted as a regular expression. The search for is extended online to `homebrew/core` and `homebrew/cask`. - If no is passed, display all locally available formulae (including tapped ones). + If no is provided, list all locally available formulae (including tapped ones). No online search is performed. EOS switch "--casks", - description: "Display all locally available casks (including tapped ones). "\ + description: "List all locally available casks (including tapped ones). "\ "No online search is performed." switch "--desc", description: "Search for formulae with a description matching and casks with "\ diff --git a/Library/Homebrew/cmd/sh.rb b/Library/Homebrew/cmd/sh.rb index 9f48359fe0..3a082c86cc 100644 --- a/Library/Homebrew/cmd/sh.rb +++ b/Library/Homebrew/cmd/sh.rb @@ -16,7 +16,7 @@ module Homebrew Homebrew build logic to help your `./configure && make && make install` or even your `gem install` succeed. Especially handy if you run Homebrew in an Xcode-only configuration since it adds tools like `make` to your `PATH` - which otherwise build systems would not find. + which build systems would not find otherwise. EOS flag "--env=", description: "Use the standard `PATH` instead of superenv's when `std` is passed." diff --git a/Library/Homebrew/cmd/shellenv.sh b/Library/Homebrew/cmd/shellenv.sh index cd2b141d67..8639092cd8 100644 --- a/Library/Homebrew/cmd/shellenv.sh +++ b/Library/Homebrew/cmd/shellenv.sh @@ -1,10 +1,9 @@ #: * `shellenv` #: -#: Prints export statements - run them in a shell and this installation of Homebrew will be included into your `PATH`, `MANPATH` and `INFOPATH`. +#: Print export statements. When run in a shell, this installation of Homebrew will be added to your `PATH`, `MANPATH`, and `INFOPATH`. #: -#: `HOMEBREW_PREFIX`, `HOMEBREW_CELLAR` and `HOMEBREW_REPOSITORY` are also exported to save multiple queries of those variables. -#: -#: Consider adding evaluating the output in your dotfiles (e.g. `~/.profile`) with `eval $(brew shellenv)` +#: The variables `HOMEBREW_PREFIX`, `HOMEBREW_CELLAR` and `HOMEBREW_REPOSITORY` are also exported to avoid querying them multiple times. +#: Consider adding evaluation of this command's output to your dotfiles (e.g. `~/.profile`) with: `eval $(brew shellenv)` homebrew-shellenv() { case "$SHELL" in diff --git a/Library/Homebrew/cmd/tap-info.rb b/Library/Homebrew/cmd/tap-info.rb index 0bce38fd95..1b0d9a212d 100644 --- a/Library/Homebrew/cmd/tap-info.rb +++ b/Library/Homebrew/cmd/tap-info.rb @@ -10,11 +10,12 @@ module Homebrew usage_banner <<~EOS `tap-info` [] [] - Display detailed information about one or more provided . - Display a brief summary of all installed taps if no are passed. + Show detailed information about one or more s. + + If no names are provided, display brief statistics for all installed taps. EOS switch "--installed", - description: "Display information on all installed taps." + description: "Show information on each installed tap." flag "--json", description: "Print a JSON representation of . Currently the default and only accepted "\ "value for is `v1`. See the docs for examples of using the JSON "\ diff --git a/Library/Homebrew/cmd/tap.rb b/Library/Homebrew/cmd/tap.rb index c9a2046be8..9a938f10a9 100644 --- a/Library/Homebrew/cmd/tap.rb +++ b/Library/Homebrew/cmd/tap.rb @@ -12,7 +12,7 @@ module Homebrew Tap a formula repository. - List all installed taps when no arguments are passed. + If no arguments are provided, list all installed taps. With unspecified, tap a formula repository from GitHub using HTTPS. Since so many taps are hosted on GitHub, this command is a shortcut for diff --git a/Library/Homebrew/cmd/unlink.rb b/Library/Homebrew/cmd/unlink.rb index e5f60dd060..2e16ead6cb 100644 --- a/Library/Homebrew/cmd/unlink.rb +++ b/Library/Homebrew/cmd/unlink.rb @@ -11,13 +11,13 @@ module Homebrew usage_banner <<~EOS `unlink` [] - Remove symlinks for from the Homebrew prefix. This can be useful + Remove symlinks for from Homebrew's prefix. This can be useful for temporarily disabling a formula: `brew unlink` `&&` `&& brew link` EOS switch "-n", "--dry-run", - description: "List all files which would be unlinked, but will not actually unlink or "\ - "delete any files." + description: "List files which would be unlinked without actually unlinking or "\ + "deleting any files." switch :verbose switch :debug end diff --git a/Library/Homebrew/cmd/update.sh b/Library/Homebrew/cmd/update.sh index d855d3ec0e..802572fedc 100644 --- a/Library/Homebrew/cmd/update.sh +++ b/Library/Homebrew/cmd/update.sh @@ -2,7 +2,7 @@ #: #: Fetch the newest version of Homebrew and all formulae from GitHub using `git`(1) and perform any necessary migrations. #: -#: --merge `git merge` is used to include updates (rather than `git rebase`). +#: --merge Use `git merge` to apply updates (rather than `git rebase`). #: -f, --force Always do a slower, full update check (even if unnecessary). #: -v, --verbose Print the directories checked and `git` operations performed. #: -d, --debug Display a trace of all shell commands as they are executed. diff --git a/Library/Homebrew/cmd/upgrade.rb b/Library/Homebrew/cmd/upgrade.rb index b53cc784bf..ae432c7b57 100644 --- a/Library/Homebrew/cmd/upgrade.rb +++ b/Library/Homebrew/cmd/upgrade.rb @@ -16,12 +16,11 @@ module Homebrew usage_banner <<~EOS `upgrade` [] [] - Upgrade outdated, unpinned formulae (with existing and any appended brew formula options). + Upgrade outdated, unpinned formulae using the same options they were originally + installed with, plus any appended brew formula options. If are specified, + upgrade only the given kegs (unless they are pinned; see `pin`, `unpin`). - If are given, upgrade only the specified brews (unless they - are pinned; see `pin`, `unpin`). - - Unless `HOMEBREW_NO_INSTALL_CLEANUP` is set, `brew cleanup` will be run for the + Unless `HOMEBREW_NO_INSTALL_CLEANUP` is set, `brew cleanup` will then be run for the upgraded formulae or, every 30 days, for all formulae. EOS switch :debug, @@ -34,12 +33,12 @@ module Homebrew "macOS, even if it would not normally be used for installation." switch "--fetch-HEAD", description: "Fetch the upstream repository to detect if the HEAD installation of the "\ - "formula is outdated. Otherwise, the repository's HEAD will be checked for "\ + "formula is outdated. Otherwise, the repository's HEAD will only be checked for "\ "updates when a new stable or development version has been released." switch "--ignore-pinned", - description: "Set a 0 exit code even if pinned formulae are not upgraded." + description: "Set a successful exit status even if pinned formulae are not upgraded." switch "--keep-tmp", - description: "Don't delete the temporary files created during installation." + description: "Retain the temporary files created during installation." switch :force, description: "Install without checking for previously installed keg-only or "\ "non-migrated versions." diff --git a/Library/Homebrew/cmd/uses.rb b/Library/Homebrew/cmd/uses.rb index cf1edeef5f..687bc03c62 100644 --- a/Library/Homebrew/cmd/uses.rb +++ b/Library/Homebrew/cmd/uses.rb @@ -15,19 +15,15 @@ module Homebrew usage_banner <<~EOS `uses` [] - Show the formulae that specify as a dependency. When given - multiple formula arguments, show the intersection of formulae that use - . - + Show formulae that specify as a dependency. When given multiple + formula arguments, show the intersection of formulae that use . By default, `uses` shows all formulae that specify as a required - or recommended dependency. - - By default, `uses` shows usage of by stable builds. + or recommended dependency for their stable builds. EOS switch "--recursive", description: "Resolve more than one level of dependencies." switch "--installed", - description: "Only list installed formulae." + description: "Only list formulae that are currently installed." switch "--include-build", description: "Include all formulae that specify as `:build` type dependency." switch "--include-test", diff --git a/Library/Homebrew/dev-cmd/audit.rb b/Library/Homebrew/dev-cmd/audit.rb index 7729f752a1..538bc807ec 100644 --- a/Library/Homebrew/dev-cmd/audit.rb +++ b/Library/Homebrew/dev-cmd/audit.rb @@ -21,9 +21,9 @@ module Homebrew `audit` [] [] Check for Homebrew coding style violations. This should be run before - submitting a new formula. Will exit with a non-zero status if any errors are + submitting a new formula. If no are provided, check all locally + available formulae. Will exit with a non-zero status if any errors are found, which can be useful for implementing pre-commit hooks. - If no are provided, all of them are checked. EOS switch "--strict", description: "Run additional style checks, including RuboCop style checks." diff --git a/Library/Homebrew/dev-cmd/bottle.rb b/Library/Homebrew/dev-cmd/bottle.rb index a02e741f58..6b82aa8c1b 100644 --- a/Library/Homebrew/dev-cmd/bottle.rb +++ b/Library/Homebrew/dev-cmd/bottle.rb @@ -72,7 +72,7 @@ module Homebrew "`brew bottle --json` ." switch "--write", depends_on: "--merge", - description: "Write the changes to the formula file. A new commit will be generated unless "\ + description: "Write changes to the formula file. A new commit will be generated unless "\ "`--no-commit` is passed." switch "--no-commit", depends_on: "--write", diff --git a/Library/Homebrew/dev-cmd/bump-formula-pr.rb b/Library/Homebrew/dev-cmd/bump-formula-pr.rb index d79b69e4a8..f9302b96dd 100644 --- a/Library/Homebrew/dev-cmd/bump-formula-pr.rb +++ b/Library/Homebrew/dev-cmd/bump-formula-pr.rb @@ -22,8 +22,7 @@ module Homebrew *Note:* this command cannot be used to transition a formula from a URL-and-SHA-256 style specification into a tag-and-revision style specification, - nor vice versa. It must use whichever style specification the preexisting - formula already uses. + nor vice versa. It must use whichever style specification the formula already uses. EOS switch "--devel", description: "Bump the development rather than stable version. The development spec must already exist." @@ -40,13 +39,13 @@ module Homebrew switch "--no-browse", description: "Print the pull request URL instead of opening in a browser." flag "--mirror=", - description: "Use the provided as a mirror URL." + description: "Use the specified as a mirror URL." flag "--version=", - description: "Use the provided to override the value parsed from the URL or tag. Note "\ + description: "Use the specified to override the value parsed from the URL or tag. Note "\ "that `--version=0` can be used to delete an existing version override from a "\ "formula if it has become redundant." flag "--message=", - description: "Append the provided to the default PR message." + description: "Append to the default pull request message." flag "--url=", description: "Specify the for the new download. If a is specified, the "\ "checksum of the new download should also be specified." @@ -57,7 +56,7 @@ module Homebrew description: "Specify the new git commit for the formula." flag "--revision=", required_for: "--tag=", - description: "Specify the new git commit corresponding to a specified ." + description: "Specify the new git commit corresponding to the specified ." switch :force switch :quiet switch :verbose diff --git a/Library/Homebrew/dev-cmd/bump-revision.rb b/Library/Homebrew/dev-cmd/bump-revision.rb index 73c0d06655..af34df763a 100644 --- a/Library/Homebrew/dev-cmd/bump-revision.rb +++ b/Library/Homebrew/dev-cmd/bump-revision.rb @@ -17,7 +17,7 @@ module Homebrew switch "-n", "--dry-run", description: "Print what would be done rather than doing it." flag "--message=", - description: "Append the provided to the default commit message." + description: "Append to the default commit message." switch :force switch :quiet switch :verbose diff --git a/Library/Homebrew/dev-cmd/create.rb b/Library/Homebrew/dev-cmd/create.rb index e395530aeb..b65ff8ad3b 100644 --- a/Library/Homebrew/dev-cmd/create.rb +++ b/Library/Homebrew/dev-cmd/create.rb @@ -26,17 +26,17 @@ module Homebrew switch "--meson", description: "Create a basic template for a Meson-style build." switch "--no-fetch", - description: "Homebrew will not download to the cache and will thus not add the SHA-256 "\ + description: "Homebrew will not download to the cache and will thus not add its SHA-256 "\ "to the formula for you, nor will it check the GitHub API for GitHub projects "\ "(to fill out its description and homepage)." switch "--HEAD", description: "Indicate that points to the package's repository rather than a file." flag "--set-name=", - description: "Set the name of the new formula to the provided ." + description: "Explicitly set the of the new formula." flag "--set-version=", - description: "Set the version of the new formula to the provided ." + description: "Explicitly set the of the new formula." flag "--tap=", - description: "Generate the new formula in the provided tap, specified as `/`." + description: "Generate the new formula within the given tap, specified as `/`." switch :force switch :verbose switch :debug diff --git a/Library/Homebrew/dev-cmd/extract.rb b/Library/Homebrew/dev-cmd/extract.rb index 8c2457a864..f1a5c39c8c 100644 --- a/Library/Homebrew/dev-cmd/extract.rb +++ b/Library/Homebrew/dev-cmd/extract.rb @@ -84,10 +84,11 @@ module Homebrew Look through repository history to find the most recent version of and create a copy in `/Formula/``@``.rb`. If the tap is not installed yet, attempt to install/clone the tap before continuing. To extract - a formula from a tap that is not `homebrew/core` use `/``/`. + a formula from a tap that is not `homebrew/core` use its fully-qualified form of + `/``/`. EOS flag "--version=", - description: "Extract the provided of instead of the most recent." + description: "Extract the specified of instead of the most recent." switch :force switch :debug end diff --git a/Library/Homebrew/dev-cmd/linkage.rb b/Library/Homebrew/dev-cmd/linkage.rb index 3f5bd51d46..cce1eb8bdb 100644 --- a/Library/Homebrew/dev-cmd/linkage.rb +++ b/Library/Homebrew/dev-cmd/linkage.rb @@ -13,10 +13,10 @@ module Homebrew `linkage` [] [] Check the library links from the given kegs. If no are - specified, check all kegs. Raises an error if run on uninstalled formulae. + provided, check all kegs. Raises an error if run on uninstalled formulae. EOS switch "--test", - description: "Display only missing libraries and exit with a non-zero status if any missing "\ + description: "Show only missing libraries and exit with a non-zero status if any missing "\ "libraries are found." switch "--reverse", description: "For every library that a keg references, print its dylib path followed by the "\ diff --git a/Library/Homebrew/dev-cmd/man.rb b/Library/Homebrew/dev-cmd/man.rb index e9cf8a1a4f..ae280179e6 100644 --- a/Library/Homebrew/dev-cmd/man.rb +++ b/Library/Homebrew/dev-cmd/man.rb @@ -25,7 +25,7 @@ module Homebrew EOS switch "--fail-if-changed", description: "Return a failing status code if changes are detected in the manpage outputs. This "\ - "can be used for CI to be notified when the manpages are out of date. Additionally, "\ + "can be used to notify CI when the manpages are out of date. Additionally, "\ "the date used in new manpages will match those in the existing manpages (to allow "\ "comparison without factoring in the date)." switch "--link", diff --git a/Library/Homebrew/dev-cmd/pull.rb b/Library/Homebrew/dev-cmd/pull.rb index aa316f11aa..bf80f74f88 100644 --- a/Library/Homebrew/dev-cmd/pull.rb +++ b/Library/Homebrew/dev-cmd/pull.rb @@ -32,10 +32,10 @@ module Homebrew `pull` [] Get a patch from a GitHub commit or pull request and apply it to Homebrew. - Optionally, publish updated bottles for the formulae changed by the patch. + Optionally, publish updated bottles for any formulae changed by the patch. - Each may be the number of a PR in `homebrew/core`, the URL of a PR - on GitHub, the URL of a commit on GitHub or a "https://jenkins.brew.sh/job/..." testing job URL. + Each may be the number of a pull request in `homebrew/core`, the URL of any pull request + or commit on GitHub or a "https://jenkins.brew.sh/job/..." testing job URL. EOS switch "--bottle", description: "Handle bottles, pulling the bottle-update commit and publishing files on Bintray." @@ -57,9 +57,9 @@ module Homebrew switch "--warn-on-publish-failure", description: "Do not exit if there's a failure publishing bottles on Bintray." flag "--bintray-org=", - description: "Publish bottles at the provided Bintray ." + description: "Publish bottles to the specified Bintray ." flag "--test-bot-user=", - description: "Pull the bottle block commit from the provided on GitHub." + description: "Pull the bottle block commit from the specified on GitHub." switch :verbose switch :debug end diff --git a/Library/Homebrew/dev-cmd/ruby.rb b/Library/Homebrew/dev-cmd/ruby.rb index 532ef3c4bd..5cfe6ea0d7 100644 --- a/Library/Homebrew/dev-cmd/ruby.rb +++ b/Library/Homebrew/dev-cmd/ruby.rb @@ -14,7 +14,7 @@ module Homebrew `brew ruby -e "puts :gcc.f.deps"` or `brew ruby script.rb`. EOS switch "-e", - description: "Execute the provided string argument as a script." + description: "Execute the given text string as a script." switch :verbose switch :debug end diff --git a/Library/Homebrew/dev-cmd/test.rb b/Library/Homebrew/dev-cmd/test.rb index 5e2721d034..1d5ad41103 100644 --- a/Library/Homebrew/dev-cmd/test.rb +++ b/Library/Homebrew/dev-cmd/test.rb @@ -24,7 +24,7 @@ module Homebrew switch "--HEAD", description: "Test the head version of a formula." switch "--keep-tmp", - description: "Keep the temporary files created for the test." + description: "Retain the temporary files created for the test." switch :verbose switch :debug conflicts "--devel", "--HEAD" diff --git a/Library/Homebrew/dev-cmd/tests.rb b/Library/Homebrew/dev-cmd/tests.rb index d918ca2a82..96ceaef489 100644 --- a/Library/Homebrew/dev-cmd/tests.rb +++ b/Library/Homebrew/dev-cmd/tests.rb @@ -26,7 +26,7 @@ module Homebrew description: "Run only `_spec.rb`. Appending `:` will start at a "\ "specific line." flag "--seed=", - description: "Randomise tests with the provided instead of a random seed." + description: "Randomise tests with the specified instead of a random seed." switch :verbose switch :debug end diff --git a/Library/Homebrew/dev-cmd/update-test.rb b/Library/Homebrew/dev-cmd/update-test.rb index a79da2da21..99b2ebd03f 100644 --- a/Library/Homebrew/dev-cmd/update-test.rb +++ b/Library/Homebrew/dev-cmd/update-test.rb @@ -18,9 +18,9 @@ module Homebrew switch "--keep-tmp", description: "Retain the temporary directory containing the new repository clone." flag "--commit=", - description: "Use provided as the start commit." + description: "Use the specified as the start commit." flag "--before=", - description: "Use the commit at provided as the start commit." + description: "Use the commit at the specified as the start commit." switch :verbose switch :debug end diff --git a/Library/Homebrew/manpages/brew.1.md.erb b/Library/Homebrew/manpages/brew.1.md.erb index 4cb93b32ff..f5d5e3373f 100644 --- a/Library/Homebrew/manpages/brew.1.md.erb +++ b/Library/Homebrew/manpages/brew.1.md.erb @@ -27,7 +27,7 @@ didn't include with macOS. For the full command list, see the [COMMANDS](#commands) section. With `--verbose` or `--debug`, many commands print extra debugging information. Note that -these flags should only appear after a command. +these options should only appear after a command. ### `install` : @@ -47,9 +47,9 @@ List all installed formulae. ### `search` (|`/``/`): Perform a substring search of cask tokens and formula names for . If -is surrounded with slashes, then it is interpreted as a regular expression. +is flanked by slashes, it is interpreted as a regular expression. The search for is extended online to `homebrew/core` and `homebrew/cask`. -If no search term is given, all locally available formulae are listed. +If no search term is provided, all locally available formulae are listed. ## COMMANDS @@ -112,12 +112,12 @@ can take several different forms: * An arbitrary file or URL: Homebrew can install formulae via URL, e.g. `https://raw.githubusercontent.com/Homebrew/homebrew-core/master/Formula/git.rb`, - or from a local path. It could point to either a formula file or a bottle. + or from a local path. It can point to either a formula file or a bottle. In the case of a URL, the downloaded file will be cached for later use. ## ENVIRONMENT -Note that environment variables must have a value set to be detected. For example, +Note that environment variables must have a value set to be detected. For example, run `export HOMEBREW_NO_INSECURE_REDIRECT=1` rather than just `export HOMEBREW_NO_INSECURE_REDIRECT`. @@ -159,8 +159,8 @@ Note that environment variables must have a value set to be detected. For exampl *Default:* `~/Library/Caches/Homebrew`. * `HOMEBREW_CURLRC`: - If set, Homebrew will not pass `-q` when invoking `curl`(1) (which disables - the use of `curlrc`). + If set, Homebrew will not pass `-q` when invoking `curl`(1), which disables + the use of `curlrc`. * `HOMEBREW_CURL_VERBOSE`: If set, Homebrew will pass `--verbose` when invoking `curl`(1).