Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document tags stanza #6509

Merged
merged 4 commits into from
Oct 6, 2014
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Casks/google-chrome.rb
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ class GoogleChrome < Cask
url 'https://dl.google.com/chrome/mac/stable/GGRO/googlechrome.dmg'
homepage 'https://www.google.com/chrome/'
license :unknown
tags :vendor => 'Google'

app 'Google Chrome.app'
end
1 change: 1 addition & 0 deletions Casks/smlnj.rb
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ class Smlnj < Cask
url "http://smlnj.cs.uchicago.edu/dist/working/#{version}/smlnj-x86-#{version}.pkg"
homepage 'http://www.smlnj.org/'
license :unknown
tags :name => 'Standard ML New Jersey'

pkg "smlnj-x86-#{version}.pkg"
uninstall :pkgutil => 'org.smlnj.x86.pkg'
Expand Down
24 changes: 24 additions & 0 deletions doc/CASK_LANGUAGE_REFERENCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Cask Domain-Specific Language (DSL) which are not needed in most cases.
* [Caveats Stanza Details](#caveats-stanza-details)
* [Checksum Stanza Details](#checksum-stanza-details)
* [URL Stanza Details](#url-stanza-details)
* [Tags Stanza Details](#tags-stanza-details)
* [License Stanza Details](#license-stanza-details)
* [App Stanza Details](#app-stanza-details)
* [Suite Stanza Details](#suite-stanza-details)
Expand Down Expand Up @@ -109,6 +110,7 @@ Each Cask must declare one or more *artifacts* (i.e. something to install)
| `uninstall_preflight` | yes | a Ruby block containing preflight uninstall operations (needed only in very rare cases)
| `uninstall_postflight` | yes | a Ruby block containing postflight uninstall operations
| `container :type =>` | no | a symbol to override container-type autodetect. may be one of: `:air`, `:bz2`, `:cab`, `:dmg`, `:generic_unar`, `:gzip`, `:otf`, `:pkg`, `:rar`, `:seven_zip`, `:sit`, `:tar`, `:ttf`, `:xar`, `:zip`, `:naked`. (example [parse.rb](../Casks/parse.rb))
| `tags` | no | a list of key-value pairs for Cask annotation. Not free-form. (see also [Tags Stanza Details](#tags-stanza-details))


## Legacy Stanzas
Expand Down Expand Up @@ -320,6 +322,9 @@ license. The `license` stanza is intended as an aid to search/filtering of
Casks. For detailed information, the user must rely on the vendor's
homepage.

Note that `brew cask search` and `brew cask list` are not yet capable of
using the information stored in the `license` stanza.

### Valid Category Licenses

If a Cask does not quite fit one of the specific license types, use one of
Expand Down Expand Up @@ -357,6 +362,25 @@ the general categories. `:unknown` is perfectly fine if you are unsure.
| `:x11` | `:oss` | X Consortium License | <http://www.xfree86.org/3.3.6/COPYRIGHT2.html>


## Tags Stanza Details

The `tags` stanza is not free-form. The key-value pairs are limited to a list
of valid keys. All `tags` keys accept string values.

The `tags` stanza is intended as an aid to search/filtering of Casks. For
detailed information, the user must rely on the vendor's homepage.

Note that `brew cask search` and `brew cask list` are not yet capable of
using the information stored in the `tags` stanza.

### Valid Tag Keys

| key | meaning
| ------------- | -----------------------------
| `:name` | Alternate name for the Cask. (example [smlnj.rb](../Casks/smlnj.rb))
| `:vendor` | The full-text official name of the producer of the software: an author or corporate name, as appropriate. As the value is intended as a search target, commonly shared abbreviations such as `Dr.` or `Inc.` should be omitted. (example [google-chrome.rb](../Casks/google-chrome.rb))


## App Stanza Details

In the simple case of a string argument to `app`, a symlink is created in
Expand Down
1 change: 1 addition & 0 deletions doc/cask_language_deltas.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ This notice will be removed for the final form.**
* stub - not yet functional
* `license`
* `suite`
* `tags`
* `uninstall :rmdir`
* `zap`

Expand Down