document depends_on :cask

This commit is contained in:
Roland Walker 2015-01-02 07:32:59 -05:00
parent e83b90d4d7
commit ca8799919c
2 changed files with 11 additions and 2 deletions

View File

@ -573,6 +573,16 @@ installer :script => 'Adobe AIR Installer.app/Contents/MacOS/Adobe AIR Installer
`depends_on` is used to declare dependencies and requirements for a Cask.
`depends_on` is not consulted until `install` is attempted.
### Depends_on :cask
The value should be another Cask token, needed by the current Cask.
Example use: [`SSHFS`](https://github.com/caskroom/homebrew-cask/blob/master/Casks/sshfs.rb) depends on OSXFUSE.
```ruby
depends_on :cask => 'osxfuse'
```
### Depends_on :formula
The value should name a Homebrew Formula needed by the Cask.
@ -668,7 +678,7 @@ depends_on :arch => :x86_64
| key | description |
| ---------- | ----------- |
| `:formula` | a Homebrew Formula
| `:cask` | *stub - not yet functional*
| `:cask` | a Cask token
| `:macos` | a symbol, string, array, or comparison expression defining OS X release requirements.
| `:arch` | a symbol or array defining hardware requirements.
| `:x11` | a Boolean indicating a dependency on X11.

View File

@ -46,7 +46,6 @@ features which are available for the current Cask.
* [`appcast`](CASK_LANGUAGE_REFERENCE.md#appcast-stanza-details)
* [`artifact`](CASK_LANGUAGE_REFERENCE.md#at-least-one-artifact-stanza-is-also-required)
* [`depends_on :cask`](CASK_LANGUAGE_REFERENCE.md#depends_on-stanza-details)
* *stub* - not yet functional
* [`depends_on :java`](CASK_LANGUAGE_REFERENCE.md#depends_on-stanza-details)
* *stub* - not yet functional
* [`conflicts_with`](CASK_LANGUAGE_REFERENCE.md#conflicts_with-stanza-details)