mirrors/brew
1
0
Fork 0
mirror of https://github.com/Homebrew/brew.git synced 2025-07-14 16:09:03 +08:00
Code Issues Packages Projects Releases Wiki Activity

Cleanup command descriptions

Browse Source 
Don't have a period within first full sentence of the description
This commit is contained in:
Rylan Polster 2021-01-24 01:59:02 -05:00
parent a308c6da73
commit 7f23b55c5e
No known key found for this signature in database
GPG Key ID: 46A744940CFF4D64
8 changed files with 22 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Library/Homebrew/cmd/--repository.rb
View File

@ -12,7 +12,7 @@ module Homebrew
def __repository_args def __repository_args
Homebrew::CLI::Parser.new do Homebrew::CLI::Parser.new do
description <<~EOS description <<~EOS
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. If <user>`/`<repo> are provided, display where tap <user>`/`<repo>'s directory is located.
EOS EOS

4
Library/Homebrew/cmd/uses.rb
View File

@ -21,8 +21,8 @@ module Homebrew
def uses_args def uses_args
Homebrew::CLI::Parser.new do Homebrew::CLI::Parser.new do
description <<~EOS description <<~EOS
Show formulae and casks that specify <formula> as a dependency (i.e. show dependents 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 <formula>. When given multiple formula arguments, show the intersection
of formulae that use <formula>. By default, `uses` shows all formulae and casks that 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. specify <formula> as a required or recommended dependency for their stable builds.
EOS EOS

3
Library/Homebrew/dev-cmd/extract.rb
View File

@ -86,7 +86,8 @@ module Homebrew
usage_banner "`extract` [<--version>`=`] [<--force>] <formula> <tap>" usage_banner "`extract` [<--version>`=`] [<--force>] <formula> <tap>"
description <<~EOS description <<~EOS
Look through repository history to find the most recent version of <formula> and 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 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 a formula from a tap that is not `homebrew/core` use its fully-qualified form of
<user>`/`<repo>`/`<formula>. <user>`/`<repo>`/`<formula>.

2
Library/Homebrew/dev-cmd/prof.rb
View File

@ -12,7 +12,7 @@ module Homebrew
def prof_args def prof_args
Homebrew::CLI::Parser.new do Homebrew::CLI::Parser.new do
description <<~EOS 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 EOS
switch "--stackprof", switch "--stackprof",
description: "Use `stackprof` instead of `ruby-prof` (the default)." description: "Use `stackprof` instead of `ruby-prof` (the default)."

2
Library/Homebrew/dev-cmd/ruby.rb
View File

@ -13,7 +13,7 @@ module Homebrew
Homebrew::CLI::Parser.new do Homebrew::CLI::Parser.new do
usage_banner "`ruby` [<options>] (`-e` <text>|<file>)" usage_banner "`ruby` [<options>] (`-e` <text>|<file>)"
description <<~EOS 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`. `brew ruby -e "puts :gcc.f.deps"` or `brew ruby script.rb`.
EOS EOS
flag "-r=", flag "-r=",

2
Library/Homebrew/dev-cmd/sh.rb
View File

@ -14,7 +14,7 @@ module Homebrew
def sh_args def sh_args
Homebrew::CLI::Parser.new do Homebrew::CLI::Parser.new do
description <<~EOS 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` build logic to help your `./configure && make && make install`
and even your `gem install` succeed. Especially handy if you run Homebrew 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` in an Xcode-only configuration since it adds tools like `make` to your `PATH`

15
docs/Manpage.md
View File

@ -659,8 +659,8 @@ upgraded formulae or, every 30 days, for all formulae.
### `uses` [*`options`*] *`formula`* [...] ### `uses` [*`options`*] *`formula`* [...]
Show formulae and casks that specify *`formula`* as a dependency (i.e. show dependents 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 *`formula`*. When given multiple formula arguments, show the intersection
of formulae that use *`formula`*. By default, `uses` shows all formulae and casks that 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. specify *`formula`* as a required or recommended dependency for their stable builds.
@ -739,7 +739,7 @@ is or would be installed.
### `--repository`, `--repo` [*`tap`* ...] ### `--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. 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`* ### `extract` [*`--version`*`=`] [*`--force`*] *`formula`* *`tap`*
Look through repository history to find the most recent version of *`formula`* and 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 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 a formula from a tap that is not `homebrew/core` use its fully-qualified form of
*`user`*`/`*`repo`*`/`*`formula`*. *`user`*`/`*`repo`*`/`*`formula`*.
@ -1203,7 +1204,7 @@ Apply the bottle commit and publish bottles to Bintray or GitHub Releases.
### `prof` [*`--stackprof`*] [*`command`* ...] ### `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`: * `--stackprof`:
Use `stackprof` instead of `ruby-prof` (the default). Use `stackprof` instead of `ruby-prof` (the default).
@ -1243,7 +1244,7 @@ Installs, configures and runs Homebrew's `rubocop`.
### `ruby` [*`options`*] (`-e` *`text`*|*`file`*) ### `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`. `brew ruby -e "puts :gcc.f.deps"` or `brew ruby script.rb`.
* `-r`: * `-r`:
@ -1253,7 +1254,7 @@ Run a Ruby instance with Homebrew's libraries loaded, e.g.
### `sh` [*`--env`*`=`] [*`--cmd`*`=`] [*`file`*] ### `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` build logic to help your `./configure && make && make install`
and even your `gem install` succeed. Especially handy if you run Homebrew 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` in an Xcode-only configuration since it adds tools like `make` to your `PATH`

12
manpages/brew.1
View File

@ -896,7 +896,7 @@ Skip installing cask dependencies\.
Also include casks with \fBauto_updates true\fR or \fBversion :latest\fR\. Also include casks with \fBauto_updates true\fR or \fBversion :latest\fR\.
. .
.SS "\fBuses\fR [\fIoptions\fR] \fIformula\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 .TP
\fB\-\-recursive\fR \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\. List files in Homebrew\'s prefix not installed by Homebrew\.
. .
.SS "\fB\-\-repository\fR, \fB\-\-repo\fR [\fItap\fR \.\.\.]" .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 .P
If \fIuser\fR\fB/\fR\fIrepo\fR are provided, display where tap \fIuser\fR\fB/\fR\fIrepo\fR\'s directory is located\. 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\. Treat all named arguments as casks\.
. .
.SS "\fBextract\fR [\fI\-\-version\fR\fB=\fR] [\fI\-\-force\fR] \fIformula\fR \fItap\fR" .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 .TP
\fB\-\-version\fR \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\. 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 \.\.\.]" .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 .TP
\fB\-\-stackprof\fR \fB\-\-stackprof\fR
@ -1717,7 +1717,7 @@ Print as a Markdown list\.
Installs, configures and runs Homebrew\'s \fBrubocop\fR\. Installs, configures and runs Homebrew\'s \fBrubocop\fR\.
. .
.SS "\fBruby\fR [\fIoptions\fR] (\fB\-e\fR \fItext\fR|\fIfile\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 .TP
\fB\-r\fR \fB\-r\fR
@ -1728,7 +1728,7 @@ Load a library using \fBrequire\fR\.
Execute the given text string as a script\. Execute the given text string as a script\.
. .
.SS "\fBsh\fR [\fI\-\-env\fR\fB=\fR] [\fI\-\-cmd\fR\fB=\fR] [\fIfile\fR]" .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 .TP
\fB\-\-env\fR \fB\-\-env\fR