Skip to content

Commit

Permalink
Attempt clearer language for fetch and resources
Browse files Browse the repository at this point in the history
  • Loading branch information
Amorymeltzer committed Jan 5, 2016
1 parent b283972 commit cc589ca
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 10 deletions.
4 changes: 2 additions & 2 deletions USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,12 +67,12 @@ Note that `uninstall --force` is currently imperfect. See the man page for more

* `info` — displays information about the given Cask
* `list` — with no args, lists installed Casks; given installed Casks, lists staged files
* `fetch` — downloads Cask resources to local cache (with `--force`, re-download even if already cached)
* `fetch` — downloads remote application files for the given Cask to the local cache (with `--force`, re-download even if already cached)
* `doctor` — checks for configuration issues
* `cleanup` — cleans up cached downloads (with `--outdated`, only cleans old downloads)
* `home` — opens the homepage of the given Cask; or with no arguments, the homebrew-cask project page
* `update` — a synonym for `brew update`
* `zap` — try to remove *all* files associated with a Cask (including resources which may be shared with other applications)
* `zap` — try to remove *all* files associated with a Cask (may include resources shared with other applications)

The following commands are for Cask authors:

Expand Down
2 changes: 1 addition & 1 deletion doc/CASK_LANGUAGE_REFERENCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -833,7 +833,7 @@ The following methods may be called to perform standard tasks:

### Zap Stanza Purpose

The `zap` stanza describes a more complete uninstallation of resources associated with a Cask. The `zap` procedures will never be performed by default, but only if the user invokes the `zap` verb:
The `zap` stanza describes a more complete uninstallation of files associated with a Cask. The `zap` procedures will never be performed by default, but only if the user invokes the `zap` verb:

```bash
$ brew cask zap td-toolbelt # also removes org.ruby-lang.installer
Expand Down
7 changes: 4 additions & 3 deletions doc/src/brew-cask.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,9 @@ names, and other aspects of this manual are still subject to change.
Open the given Cask definition file for editing.

* `fetch` [--force] <token> [ <token> ... ]:
Fetch remote resources for the given Cask to the local cache. With
`--force`, force re-download even if the resources are already cached.
Download remote application files for the given Cask to the local
cache. With `--force`, force re-download even if the files are already
cached.

* `home` or `homepage` [<token>]:
Display the homepage associated with a given Cask in a browser.
Expand Down Expand Up @@ -123,7 +124,7 @@ names, and other aspects of this manual are still subject to change.
files. `zap` actions are variable, depending on the level of detail
defined by the Cask author.

**`zap` may remove resources which are shared between applications.**
**`zap` may remove files which are shared between applications.**

## OPTIONS

Expand Down
4 changes: 2 additions & 2 deletions lib/hbc/cli/fetch.rb
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ def self.run(*args)
force = args.include? '--force'

cask_tokens.each do |cask_token|
ohai "Fetching resources for Cask #{cask_token}"
ohai "Downloading external files for Cask #{cask_token}"
cask = Hbc.load(cask_token)
downloaded_path = Hbc::Download.new(cask, force).perform
Hbc::Verify.all(cask, downloaded_path)
Expand All @@ -14,6 +14,6 @@ def self.run(*args)
end

def self.help
"downloads Cask resources to local cache"
"downloads remote application files to local cache"
end
end
4 changes: 2 additions & 2 deletions man/man1/brew-cask.1
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Open the given Cask definition file for editing\.
.
.TP
\fBfetch\fR [\-\-force] \fItoken\fR [ \fItoken\fR \.\.\. ]
Fetch remote resources for the given Cask to the local cache\. With \fB\-\-force\fR, force re\-download even if the resources are already cached\.
Download remote application files for the given Cask to the local cache\. With \fB\-\-force\fR, force re\-download even if the files are already cached\.
.
.TP
\fBhome\fR or \fBhomepage\fR [\fItoken\fR]
Expand Down Expand Up @@ -123,7 +123,7 @@ Removes all staged versions of the Cask distribution found under \fB/opt/homebre
If the Cask definition contains a \fBzap\fR stanza, performs additional \fBzap\fR actions as defined there, such as removing local preference files\. \fBzap\fR actions are variable, depending on the level of detail defined by the Cask author\.
.
.IP
\fB\fBzap\fR may remove resources which are shared between applications\.\fR
\fB\fBzap\fR may remove files which are shared between applications\.\fR
.
.SH "OPTIONS"
To make these options persistent, see the ENVIRONMENT section, below\.
Expand Down

0 comments on commit cc589ca

Please sign in to comment.