From 7f23b55c5e207a498fb2e5ca0f629d0685e38ea3 Mon Sep 17 00:00:00 2001 From: Rylan Polster Date: Sun, 24 Jan 2021 01:59:02 -0500 Subject: [PATCH] Cleanup command descriptions Don't have a period within first full sentence of the description --- Library/Homebrew/cmd/--repository.rb | 2 +- Library/Homebrew/cmd/uses.rb | 4 ++-- Library/Homebrew/dev-cmd/extract.rb | 3 ++- Library/Homebrew/dev-cmd/prof.rb | 2 +- Library/Homebrew/dev-cmd/ruby.rb | 2 +- Library/Homebrew/dev-cmd/sh.rb | 2 +- docs/Manpage.md | 15 ++++++++------- manpages/brew.1 | 12 ++++++------ 8 files changed, 22 insertions(+), 20 deletions(-) diff --git a/Library/Homebrew/cmd/--repository.rb b/Library/Homebrew/cmd/--repository.rb index 77cea97d6c..c72c0510fe 100644 --- a/Library/Homebrew/cmd/--repository.rb +++ b/Library/Homebrew/cmd/--repository.rb @@ -12,7 +12,7 @@ module Homebrew def __repository_args Homebrew::CLI::Parser.new do description <<~EOS - Display where Homebrew's `.git` directory is located. + Display where Homebrew's git repository is located. If `/` are provided, display where tap `/`'s directory is located. EOS diff --git a/Library/Homebrew/cmd/uses.rb b/Library/Homebrew/cmd/uses.rb index 9902709b89..e8ca9d4006 100644 --- a/Library/Homebrew/cmd/uses.rb +++ b/Library/Homebrew/cmd/uses.rb @@ -21,8 +21,8 @@ module Homebrew def uses_args Homebrew::CLI::Parser.new do description <<~EOS - Show formulae and casks that specify as a dependency (i.e. show dependents - of ). When given multiple formula arguments, show the intersection + Show formulae and casks that specify as a dependency. That is, show dependents + of . When given multiple formula arguments, show the intersection of formulae that use . By default, `uses` shows all formulae and casks that specify as a required or recommended dependency for their stable builds. EOS diff --git a/Library/Homebrew/dev-cmd/extract.rb b/Library/Homebrew/dev-cmd/extract.rb index a2f695282d..abc3073b63 100644 --- a/Library/Homebrew/dev-cmd/extract.rb +++ b/Library/Homebrew/dev-cmd/extract.rb @@ -86,7 +86,8 @@ module Homebrew usage_banner "`extract` [<--version>`=`] [<--force>] " description <<~EOS Look through repository history to find the most recent version of and - create a copy in `/Formula/``@``.rb`. If the tap is not + create a copy in . Specifically, the command will create the new + formula file at `/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 its fully-qualified form of `/``/`. diff --git a/Library/Homebrew/dev-cmd/prof.rb b/Library/Homebrew/dev-cmd/prof.rb index 1689215b0c..e8073ed1ba 100644 --- a/Library/Homebrew/dev-cmd/prof.rb +++ b/Library/Homebrew/dev-cmd/prof.rb @@ -12,7 +12,7 @@ module Homebrew def prof_args Homebrew::CLI::Parser.new do description <<~EOS - Run Homebrew with a Ruby profiler, e.g. `brew prof readall`. + Run Homebrew with a Ruby profiler. For example, `brew prof readall`. EOS switch "--stackprof", description: "Use `stackprof` instead of `ruby-prof` (the default)." diff --git a/Library/Homebrew/dev-cmd/ruby.rb b/Library/Homebrew/dev-cmd/ruby.rb index 9abf025742..77395db575 100644 --- a/Library/Homebrew/dev-cmd/ruby.rb +++ b/Library/Homebrew/dev-cmd/ruby.rb @@ -13,7 +13,7 @@ module Homebrew Homebrew::CLI::Parser.new do usage_banner "`ruby` [] (`-e` |)" description <<~EOS - Run a Ruby instance with Homebrew's libraries loaded, e.g. + Run a Ruby instance with Homebrew's libraries loaded. For example, `brew ruby -e "puts :gcc.f.deps"` or `brew ruby script.rb`. EOS flag "-r=", diff --git a/Library/Homebrew/dev-cmd/sh.rb b/Library/Homebrew/dev-cmd/sh.rb index 6a693eff4f..c7d35cc761 100644 --- a/Library/Homebrew/dev-cmd/sh.rb +++ b/Library/Homebrew/dev-cmd/sh.rb @@ -14,7 +14,7 @@ module Homebrew def sh_args Homebrew::CLI::Parser.new do description <<~EOS - Homebrew build environment that uses years-battle-hardened + Homebrew's build environment. This environment uses years-battle-hardened build logic to help your `./configure && make && make install` and 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` diff --git a/docs/Manpage.md b/docs/Manpage.md index 981bed2b63..2b6f532481 100644 --- a/docs/Manpage.md +++ b/docs/Manpage.md @@ -659,8 +659,8 @@ upgraded formulae or, every 30 days, for all formulae. ### `uses` [*`options`*] *`formula`* [...] -Show formulae and casks that specify *`formula`* as a dependency (i.e. show dependents -of *`formula`*). When given multiple formula arguments, show the intersection +Show formulae and casks that specify *`formula`* as a dependency. That is, show dependents +of *`formula`*. When given multiple formula arguments, show the intersection of formulae that use *`formula`*. By default, `uses` shows all formulae and casks that specify *`formula`* as a required or recommended dependency for their stable builds. @@ -739,7 +739,7 @@ is or would be installed. ### `--repository`, `--repo` [*`tap`* ...] -Display where Homebrew's `.git` directory is located. +Display where Homebrew's git repository is located. If *`user`*`/`*`repo`* are provided, display where tap *`user`*`/`*`repo`*'s directory is located. @@ -1022,7 +1022,8 @@ or open the Homebrew repository for editing if no formula is provided. ### `extract` [*`--version`*`=`] [*`--force`*] *`formula`* *`tap`* Look through repository history to find the most recent version of *`formula`* and -create a copy in *`tap`*`/Formula/`*`formula`*`@`*`version`*`.rb`. If the tap is not +create a copy in *`tap`*. Specifically, the command will create the new +formula file at *`tap`*`/Formula/`*`formula`*`@`*`version`*`.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 its fully-qualified form of *`user`*`/`*`repo`*`/`*`formula`*. @@ -1203,7 +1204,7 @@ Apply the bottle commit and publish bottles to Bintray or GitHub Releases. ### `prof` [*`--stackprof`*] [*`command`* ...] -Run Homebrew with a Ruby profiler, e.g. `brew prof readall`. +Run Homebrew with a Ruby profiler. For example, `brew prof readall`. * `--stackprof`: Use `stackprof` instead of `ruby-prof` (the default). @@ -1243,7 +1244,7 @@ Installs, configures and runs Homebrew's `rubocop`. ### `ruby` [*`options`*] (`-e` *`text`*|*`file`*) -Run a Ruby instance with Homebrew's libraries loaded, e.g. +Run a Ruby instance with Homebrew's libraries loaded. For example, `brew ruby -e "puts :gcc.f.deps"` or `brew ruby script.rb`. * `-r`: @@ -1253,7 +1254,7 @@ Run a Ruby instance with Homebrew's libraries loaded, e.g. ### `sh` [*`--env`*`=`] [*`--cmd`*`=`] [*`file`*] -Homebrew build environment that uses years-battle-hardened +Homebrew's build environment. This environment uses years-battle-hardened build logic to help your `./configure && make && make install` and 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` diff --git a/manpages/brew.1 b/manpages/brew.1 index 62fcdc31a8..e4f4e145fd 100644 --- a/manpages/brew.1 +++ b/manpages/brew.1 @@ -896,7 +896,7 @@ Skip installing cask dependencies\. Also include casks with \fBauto_updates true\fR or \fBversion :latest\fR\. . .SS "\fBuses\fR [\fIoptions\fR] \fIformula\fR [\.\.\.]" -Show formulae and casks that specify \fIformula\fR as a dependency (i\.e\. show dependents of \fIformula\fR)\. When given multiple formula arguments, show the intersection of formulae that use \fIformula\fR\. By default, \fBuses\fR shows all formulae and casks that specify \fIformula\fR as a required or recommended dependency for their stable builds\. +Show formulae and casks that specify \fIformula\fR as a dependency\. That is, show dependents of \fIformula\fR\. When given multiple formula arguments, show the intersection of formulae that use \fIformula\fR\. By default, \fBuses\fR shows all formulae and casks that specify \fIformula\fR as a required or recommended dependency for their stable builds\. . .TP \fB\-\-recursive\fR @@ -1000,7 +1000,7 @@ If \fIformula\fR is provided, display the location in the Cellar where \fIformul List files in Homebrew\'s prefix not installed by Homebrew\. . .SS "\fB\-\-repository\fR, \fB\-\-repo\fR [\fItap\fR \.\.\.]" -Display where Homebrew\'s \fB\.git\fR directory is located\. +Display where Homebrew\'s git repository is located\. . .P If \fIuser\fR\fB/\fR\fIrepo\fR are provided, display where tap \fIuser\fR\fB/\fR\fIrepo\fR\'s directory is located\. @@ -1418,7 +1418,7 @@ Treat all named arguments as formulae\. Treat all named arguments as casks\. . .SS "\fBextract\fR [\fI\-\-version\fR\fB=\fR] [\fI\-\-force\fR] \fIformula\fR \fItap\fR" -Look through repository history to find the most recent version of \fIformula\fR and create a copy in \fItap\fR\fB/Formula/\fR\fIformula\fR\fB@\fR\fIversion\fR\fB\.rb\fR\. 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 \fBhomebrew/core\fR use its fully\-qualified form of \fIuser\fR\fB/\fR\fIrepo\fR\fB/\fR\fIformula\fR\. +Look through repository history to find the most recent version of \fIformula\fR and create a copy in \fItap\fR\. Specifically, the command will create the new formula file at \fItap\fR\fB/Formula/\fR\fIformula\fR\fB@\fR\fIversion\fR\fB\.rb\fR\. 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 \fBhomebrew/core\fR use its fully\-qualified form of \fIuser\fR\fB/\fR\fIrepo\fR\fB/\fR\fIformula\fR\. . .TP \fB\-\-version\fR @@ -1680,7 +1680,7 @@ Upload to the specified Bintray organisation (default: \fBhomebrew\fR)\. Use the specified \fIURL\fR as the root of the bottle\'s URL instead of Homebrew\'s default\. . .SS "\fBprof\fR [\fI\-\-stackprof\fR] [\fIcommand\fR \.\.\.]" -Run Homebrew with a Ruby profiler, e\.g\. \fBbrew prof readall\fR\. +Run Homebrew with a Ruby profiler\. For example, \fBbrew prof readall\fR\. . .TP \fB\-\-stackprof\fR @@ -1717,7 +1717,7 @@ Print as a Markdown list\. Installs, configures and runs Homebrew\'s \fBrubocop\fR\. . .SS "\fBruby\fR [\fIoptions\fR] (\fB\-e\fR \fItext\fR|\fIfile\fR)" -Run a Ruby instance with Homebrew\'s libraries loaded, e\.g\. \fBbrew ruby \-e "puts :gcc\.f\.deps"\fR or \fBbrew ruby script\.rb\fR\. +Run a Ruby instance with Homebrew\'s libraries loaded\. For example, \fBbrew ruby \-e "puts :gcc\.f\.deps"\fR or \fBbrew ruby script\.rb\fR\. . .TP \fB\-r\fR @@ -1728,7 +1728,7 @@ Load a library using \fBrequire\fR\. Execute the given text string as a script\. . .SS "\fBsh\fR [\fI\-\-env\fR\fB=\fR] [\fI\-\-cmd\fR\fB=\fR] [\fIfile\fR]" -Homebrew build environment that uses years\-battle\-hardened build logic to help your \fB\./configure && make && make install\fR and even your \fBgem install\fR succeed\. Especially handy if you run Homebrew in an Xcode\-only configuration since it adds tools like \fBmake\fR to your \fBPATH\fR which build systems would not find otherwise\. +Homebrew\'s build environment\. This environment uses years\-battle\-hardened build logic to help your \fB\./configure && make && make install\fR and even your \fBgem install\fR succeed\. Especially handy if you run Homebrew in an Xcode\-only configuration since it adds tools like \fBmake\fR to your \fBPATH\fR which build systems would not find otherwise\. . .TP \fB\-\-env\fR