admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity

Improve command descriptions

Browse Source 
Co-Authored-By: Jonathan Chang <me@jonathanchang.org>
Co-Authored-By: Eric Knibbe <3324775+EricFromCanada@users.noreply.github.com>
This commit is contained in:
Rylan Polster 2021-01-24 12:38:32 -05:00
parent 6cf5d1aa17
commit 67e03a0675
No known key found for this signature in database
GPG Key ID: 46A744940CFF4D64
5 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -21,7 +21,7 @@ module Homebrew
def uses_args
Homebrew::CLI::Parser.new do
description <<~EOS
Show formulae and casks that specify <formula> as a dependency. That is, 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 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.

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

@ -14,7 +14,7 @@ module Homebrew
def sh_args
Homebrew::CLI::Parser.new do
description <<~EOS
Homebrew's build environment. This environment uses years-battle-hardened
Enter an interactive shell for Homebrew's build environment. Use 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`

4
completions/zsh/_brew
View File

@ -180,7 +180,7 @@ __brew_internal_commands() {
'rubocop:Installs, configures and runs Homebrew'\''s `rubocop`'
'ruby:Run a Ruby instance with Homebrew'\''s libraries loaded'
'search:Perform a substring search of cask tokens and formula names for text'
'sh:Homebrew'\''s build environment'
'sh:Enter an interactive shell for Homebrew'\''s build environment'
'shellenv:Print export statements'
'sponsors:Print a Markdown summary of Homebrew'\''s GitHub Sponsors, suitable for pasting into a README'
'style:Check formulae or files for conformance to Homebrew style guidelines'
@ -204,7 +204,7 @@ __brew_internal_commands() {
'update-reset:Fetch and reset Homebrew and all tap repositories (or any specified repository) using `git`(1) to their latest `origin/master`'
'update-test:Run a test of `brew update` with a new repository clone'
'upgrade:Upgrade outdated casks and outdated, unpinned formulae using the same options they were originally installed with, plus any appended brew formula options'
'uses:Show formulae and casks that specify formula as a dependency'
'uses:Show formulae and casks that specify formula as a dependency; that is, show dependents of formula'
'vendor-gems:Install and commit Homebrew'\''s vendored gems'
'vendor-install:Install Homebrew'\''s portable Ruby'
)

4
docs/Manpage.md
View File

@ -659,7 +659,7 @@ upgraded formulae or, every 30 days, for all formulae.
### `uses` [*`options`*] *`formula`* [...]
Show formulae and casks that specify *`formula`* as a dependency. That is, 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 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.
@ -1254,7 +1254,7 @@ Run a Ruby instance with Homebrew's libraries loaded. For example,
### `sh` [*`--env`*`=`] [*`--cmd`*`=`] [*`file`*]
Homebrew's build environment. This environment uses years-battle-hardened
Enter an interactive shell for Homebrew's build environment. Use 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`

4
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\.
.
.SS "\fBuses\fR [\fIoptions\fR] \fIformula\fR [\.\.\.]"
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\.
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
@ -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\'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\.
Enter an interactive shell for Homebrew\'s build environment\. Use 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