rename delta file and update transition docs
requires #6074 (may show merge conflict)
This commit is contained in:
Roland Walker
parent
7cc02b2ac3
commit
58a4c1092d
15
README.md
15
README.md
|
|
@ -1,22 +1,27 @@
|
|||
# NOTICE: The Cask syntax is changing! (8 Sep 2014)
|
||||
|
||||
There will be a period of transition while we update the Cask DSL to use
|
||||
new forms described in #4688.
|
||||
new forms described in [#4688](https://github.com/caskroom/homebrew-cask/issues/4688).
|
||||
|
||||
End users should not notice a difference — but see below about upgrading
|
||||
on errors. Cask authors will need to adjust to the new DSL forms.
|
||||
|
||||
The Cask DSL 1.0 will be documented in [CASK_LANGUAGE_REFERENCE.md](doc/CASK_LANGUAGE_REFERENCE.md)
|
||||
and [cask_language_delta_1.0.md](doc/cask_language_delta_1.0.md).
|
||||
and [cask_language_deltas.md](doc/cask_language_deltas.md).
|
||||
|
||||
Code to support most of the new DSL forms has been in release for several
|
||||
weeks; most users are already running forward compatible code<sup>1</sup>.
|
||||
|
||||
The transition officially begins with version 0.40.0, released today, 8
|
||||
Sep 2014. Cask definitions will also be changing. If you experience an
|
||||
error when running Homebrew-cask, please run
|
||||
The transition officially begins with version 0.40.0, released 8 Sep 2014.
|
||||
Cask definition files will also be changing. If you experience an error
|
||||
when running Homebrew-cask, please run
|
||||
|
||||
```bash
|
||||
$ brew update && brew upgrade brew-cask && brew cleanup && brew cask cleanup
|
||||
```
|
||||
|
||||
to get the latest code.
|
||||
|
||||
<sup>1</sup> forward compatibility began with [v0.38.0](https://github.com/caskroom/homebrew-cask/releases/tag/v0.38.0), released 28 Jul 2014
|
||||
|
||||
---------------------------------------
|
||||
|
|
|
|||
|
|
@ -567,8 +567,9 @@ This should be used sparingly: any method which is needed by two or more
|
|||
Casks should instead be rolled into the core. Care must also be taken
|
||||
that such methods be very efficient.
|
||||
|
||||
|
||||
## Revisions to the Cask DSL
|
||||
|
||||
The Cask DSL is being revised and stabilized. Changes are tracked in [cask_language_delta_1.0.md](cask_language_delta_1.0.md).
|
||||
The Cask DSL is being revised and stabilized. Changes are tracked in [cask_language_deltas.md](cask_language_deltas.md).
|
||||
|
||||
# <3 THANK YOU TO ALL CONTRIBUTORS! <3
|
||||
|
|
|
|||
|
|
@ -1,26 +0,0 @@
|
|||
# Cask Language Delta 1.0
|
||||
|
||||
This document lists changes to the Cask language from the pre-existing
|
||||
(unversioned) conventions to the Cask DSL 1.0 standard.
|
||||
|
||||
* [Name Changes](#name-changes)
|
||||
* [References](#references)
|
||||
|
||||
## Name Changes
|
||||
|
||||
| old stanza name | new stanza name
|
||||
| --------------------|---------
|
||||
| `before_install` | `preflight`
|
||||
| `after_install` | `postflight`
|
||||
| `before_uninstall` | `uninstall_preflight`
|
||||
| `after_uninstall` | `uninstall_postflight`
|
||||
|
||||
## References
|
||||
|
||||
* [DSL 1.0 Transition Notice](https://github.com/caskroom/homebrew-cask/issues/5890)
|
||||
* [DSL 1.0 Roadmap](https://github.com/caskroom/homebrew-cask/issues/4688)
|
||||
* [DSL 1.1 Roadmap](https://github.com/caskroom/homebrew-cask/issues/5586)
|
||||
* [DSL 2.0 Roadmap](https://github.com/caskroom/homebrew-cask/issues/5592)
|
||||
* [`brew cask upgrade` Roadmap](https://github.com/caskroom/homebrew-cask/issues/4678)
|
||||
|
||||
# <3 THANK YOU TO ALL CONTRIBUTORS! <3
|
||||
|
|
@ -0,0 +1,61 @@
|
|||
# Cask Language Deltas
|
||||
|
||||
This document summarizes revisions to the Cask Domain-Specific Language (DSL).
|
||||
|
||||
* [Cask DSL 1.0](#cask-dsl-10)
|
||||
* [References](#references)
|
||||
|
||||
|
||||
## Cask DSL 1.0
|
||||
|
||||
These are deltas from the pre-existing (unversioned) conventions to the
|
||||
Cask DSL 1.0 specification.
|
||||
|
||||
* [This Document Is Incomplete](#this-document-is-incomplete)
|
||||
* [Removals (1.0)](#removals-10)
|
||||
* [Additions (1.0)](#additions-10)
|
||||
* [Renames (1.0)](#renames-10)
|
||||
* [All Supported Stanzas (1.0)](#all-supported-stanzas-10)
|
||||
|
||||
|
||||
## This Document Is Incomplete
|
||||
|
||||
**This document still being written. It is not yet a complete reference.
|
||||
This notice will be removed for the final form.**
|
||||
|
||||
|
||||
## Removals (1.0)
|
||||
|
||||
**Stub!**
|
||||
|
||||
|
||||
## Additions (1.0)
|
||||
|
||||
**Stub!**
|
||||
|
||||
|
||||
## Renames (1.0)
|
||||
|
||||
| old stanza name | new stanza name
|
||||
| -------------------|----------------
|
||||
| `before_install` | `preflight`
|
||||
| `after_install` | `postflight`
|
||||
| `before_uninstall` | `uninstall_preflight`
|
||||
| `after_uninstall` | `uninstall_postflight`
|
||||
|
||||
|
||||
## All Supported Stanzas (1.0)
|
||||
|
||||
**Stub!**
|
||||
|
||||
|
||||
## References
|
||||
|
||||
* [DSL 1.0 transition notice](https://github.com/caskroom/homebrew-cask/issues/5890)
|
||||
* [DSL 1.0 roadmap](https://github.com/caskroom/homebrew-cask/issues/4688)
|
||||
* [DSL 1.1 roadmap](https://github.com/caskroom/homebrew-cask/issues/5586)
|
||||
* [DSL 2.0 roadmap](https://github.com/caskroom/homebrew-cask/issues/5592)
|
||||
* [`brew cask upgrade` roadmap](https://github.com/caskroom/homebrew-cask/issues/4678)
|
||||
* [Full specification](CASK_LANGUAGE_REFERENCE.md)
|
||||
|
||||
# <3 THANK YOU TO ALL CONTRIBUTORS! <3
|
||||
Loading…
Reference in New Issue