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

basic docs for stub gpg stanza #6868

Merged
merged 3 commits into from
Oct 22, 2014
Merged

basic docs for stub gpg stanza #6868

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
baa81a8
basic docs for stub gpg stanza
rolandwalker Oct 21, 2014
a972797
Clarify doc stub for gpg signatures
Oct 21, 2014
82a788c
Merge pull request #6 from ndr-qef/docs/gpg
rolandwalker Oct 21, 2014
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
18 changes: 18 additions & 0 deletions doc/CASK_LANGUAGE_REFERENCE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ Cask Domain-Specific Language (DSL) which are not needed in most cases.
* [Appcast Stanza Details](#appcast-stanza-details)
* [Tags Stanza Details](#tags-stanza-details)
* [License Stanza Details](#license-stanza-details)
* [GPG Stanza Details](#gpg-stanza-details)
* [App Stanza Details](#app-stanza-details)
* [Suite Stanza Details](#suite-stanza-details)
* [Pkg Stanza Details](#pkg-stanza-details)
Expand Down Expand Up @@ -117,6 +118,7 @@ Each Cask must declare one or more *artifacts* (i.e. something to install)
| `container :nested =>` | no | relative path to an inner container that must be extracted before moving on with the installation; this allows us to support dmg inside tar, zip inside dmg, etc.
| `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))
| `gpg` | no | *stub: not yet functional.* (see also [GPG Stanza Details](#gpg-stanza-details))


## Legacy Stanzas
Expand Down Expand Up @@ -390,6 +392,22 @@ using the information stored in the `tags` stanza.
| `: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))


## GPG Stanza Details

**This is a stub for upcoming functionality, and is not fully documented**.

The `gpg` stanza contains signature information for GPG-signed distributions.
The form is

```ruby
gpg <signature>, <parameter> => <value>
```

where `<parameter>` is one of `:key_id` or `:key_url`, and `<signature>` points
to the detached signature of the distribution. Commonly, the signature
follows the `url` value. Example: [libreoffice.rb](../Casks/libreoffice.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
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ This notice will be removed for the final form.**
* *stub* - not yet functional
* `conflicts_with`
* *stub* - not yet functional
* `gpg`
* `installer :script`
* `license`
* `suite`
Expand Down