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.

Sign up for GitHub

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

until release: document name stanza #7806

Merged
merged 1 commit into from
Dec 9, 2014
Merged

until release: document name stanza #7806

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 6 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ cask :v1 => 'alfred' do
sha256 'a32565cdb1673f4071593d4cc9e1c26bc884218b62fef8abc450daa47ba8fa92'

url 'https://cachefly.alfredapp.com/Alfred_2.3_264.zip'
name 'Alfred'
homepage 'http://www.alfredapp.com/'
license :commercial

Expand All @@ -54,6 +55,8 @@ cask :v1 => 'unity' do
sha256 '6fb72bfacf78df072559dd9a024a9d47e49b5717c8f17d53f05e2fc74a721876'

url 'http://netstorage.unity3d.com/unity/unity-4.5.4.dmg'
name 'Unity'
name 'Unity3D'
homepage 'http://unity3d.com/unity/'
license :commercial

Expand All @@ -71,6 +74,7 @@ cask :v1 => 'firefox' do
sha256 :no_check

url 'https://download.mozilla.org/?product=firefox-latest&os=osx&lang=en-US'
name 'Firefox'
homepage 'https://www.mozilla.org/en-US/firefox/'
license :mpl

Expand Down Expand Up @@ -118,6 +122,7 @@ cask :v1 => 'my-new-cask' do
sha256 ''

url ''
name ''
homepage ''
license :unknown

Expand All @@ -134,6 +139,7 @@ Fill in the following stanzas for your Cask:
| `version` | application version; give the value `:latest` if an unversioned download is available
| `sha256` | SHA-256 checksum of the file downloaded from `url`, calculated by the command `shasum -a 256 <file>`. Can be suppressed for unversioned downloads by using the special value `:no_check`. (see also [Checksum Stanza Details](doc/CASK_LANGUAGE_REFERENCE.md#checksum-stanza-details))
| `url` | URL to the `.dmg`/`.zip`/`.tgz` file that contains the application (see also [URL Stanza Details](doc/CASK_LANGUAGE_REFERENCE.md#url-stanza-details))
| `name` | the full and proper name defined by the vendor, and any useful alternate names (see also [Name Stanza Details](doc/CASK_LANGUAGE_REFERENCE.md#name-stanza-details))
| `homepage` | application homepage; used for the `brew cask home` command
| `license` | a symbol identifying the license for the application. Valid category licenses include `:oss`, `:closed`, and `:unknown`. It is OK to leave as `:unknown`. (see also [License Stanza Details](doc/CASK_LANGUAGE_REFERENCE.md#license-stanza-details))
| `app` | relative path to an `.app` bundle that should be linked into the `~/Applications` folder on installation (see also [App Stanza Details](doc/CASK_LANGUAGE_REFERENCE.md#app-stanza-details))
Expand Down
16 changes: 15 additions & 1 deletion doc/CASK_LANGUAGE_REFERENCE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Cask Domain-Specific Language (DSL) which are not needed in most cases.
* [Optional Stanzas](#optional-stanzas)
* [Conditional Statements](#conditional-statements)
* [Header Line Details](#header-line-details)
* [Name Stanza Details](#name-stanza-details)
* [Caveats Stanza Details](#caveats-stanza-details)
* [Checksum Stanza Details](#checksum-stanza-details)
* [URL Stanza Details](#url-stanza-details)
Expand Down Expand Up @@ -41,6 +42,7 @@ cask :v1 => 'alfred' do
sha256 'a32565cdb1673f4071593d4cc9e1c26bc884218b62fef8abc450daa47ba8fa92'

url 'https://cachefly.alfredapp.com/Alfred_2.3_264.zip'
name 'Alfred'
homepage 'http://www.alfredapp.com/'
license :commercial

Expand Down Expand Up @@ -105,6 +107,7 @@ Each Cask must declare one or more *artifacts* (i.e. something to install)

| name | multiple occurrences allowed? | value |
| ---------------------- |------------------------------ | ----------- |
| `name` | yes | a string providing the full and proper name defined by the vendor (see also [Name Stanza Details](#name-stanza-details))
| `uninstall` | yes | procedures to uninstall a Cask. Optional unless the `pkg` stanza is used. (see also [Uninstall Stanza Details](#uninstall-stanza-details))
| `zap` | yes | additional procedures for a more complete uninstall, including user files and shared resources. (see also [Zap Stanza Details](#zap-stanza-details))
| `appcast` | no | a URL providing an appcast feed to find updates for this Cask. (see also [Appcast Stanza Details](#appcast-stanza-details))
Expand Down Expand Up @@ -192,6 +195,17 @@ in the process of being removed. The Travis bot will catch any errors
during the transition.


## Name Stanza Details

`name` stanza accepts a UTF-8 string defining the full name of the software.

If there are useful alternate names, `name` can be repeated multiple times.
(Or, equivalently, an array value may be given.)

When multiple names are given, the first should follow the canonical
branding as defined by the vendor.


## Caveats Stanza Details

### Caveats as a String
Expand Down Expand Up @@ -386,7 +400,6 @@ using the information stored in the `tags` stanza.

| key | meaning
| ------------- | -----------------------------
| `:name` | the full name of 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))


Expand Down Expand Up @@ -971,6 +984,7 @@ cask :v1 => 'myapp' do
end
end

name 'MyApp'
version '1.0'
sha256 'a32565cdb1673f4071593d4cc9e1c26bc884218b62fef8abc450daa47ba8fa92'
license :unknown
Expand Down
1 change: 1 addition & 0 deletions doc/cask_language_deltas.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ features which are available for the current Cask.
* [`gpg`](CASK_LANGUAGE_REFERENCE.md#gpg-stanza-details) *stub: not yet functional.*
* [`installer :script`](CASK_LANGUAGE_REFERENCE.md#installer-script)
* [`license`](CASK_LANGUAGE_REFERENCE.md#license-stanza-details)
* [`name`](CASK_LANGUAGE_REFERENCE.md#name-stanza-details)
* [`postflight plist_set`](CASK_LANGUAGE_REFERENCE.md#postflight-stanza-details)
* [`postflight suppress_move_to_applications`](CASK_LANGUAGE_REFERENCE.md#postflight-stanza-details)
* [`stage_only`](CASK_LANGUAGE_REFERENCE.md#at-least-one-artifact-stanza-is-also-required)
Expand Down
4 changes: 2 additions & 2 deletions doc/cask_token_reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ The token itself should be

Details of software names and brands will inevitably be lost in the
conversion to a minimal token. To capture the vendor's full name for a
distribution, use [`tags :name`](CASK_LANGUAGE_REFERENCE.md#tags-stanza-details) within a Cask.
`tags :name` accepts an unrestricted UTF-8 string.
distribution, use the [`name`](CASK_LANGUAGE_REFERENCE.md#name-stanza-details) within a Cask.
`name` accepts an unrestricted UTF-8 string.

## Finding the Simplified Name of the Vendor's Distribution

Expand Down