Commit Graph

257 Commits

Author SHA1 Message Date
Roland Walker 2c3119da03 cut v0.50.0 2014-12-09 19:56:19 -05:00
Roland Walker be1bf6dfac document `name` stanza
and undocument obsolete `tags :name`
2014-12-09 18:53:34 -05:00
Roland Walker 6482a7885b Merge pull request #7941 from rolandwalker/remove_unfinished_banner
doc: remove "incomplete" banner on deltas doc
2014-12-09 18:51:41 -05:00
Roland Walker 5f2d454d96 Merge pull request #7937 from rolandwalker/doc_macos_release
DSL: document `MacOS.release`
2014-12-09 18:51:04 -05:00
Roland Walker 6c14671fb8 Merge pull request #7938 from rolandwalker/doc_postflight_minidsl
document the `postflight` mini-DSL
2014-12-09 18:49:47 -05:00
Roland Walker 510b1ba7fc doc: remove "incomplete" banner on deltas doc 2014-12-09 11:01:27 -05:00
Roland Walker 72b8262eb0 dos: remove stray mention of assistive_devices
this method has been obsoleted
2014-12-09 09:21:39 -05:00
Roland Walker f5d27730e2 document the `postflight` mini-DSL
some portions are bumped to DSL 1.1
2014-12-09 09:20:13 -05:00
Roland Walker 78c3efed71 DSL: document `MacOS.release` 2014-12-09 08:44:49 -05:00
Roland Walker 82826b2687 DSL: add `accessibility_access` stanza
* accepts a Boolean value
* replaces the never-documented `postflight` methods `enable_accessibility_access` /
 `disable_accessibility_access` (`remove_accessibility_access`)
* declarative: unlike the `postflight` approach, does not have to be
  invoked in two places
* de-document obsolete form `caveats` / `assistive_devices`
* bump Travis seed to avoid false test failures
2014-12-08 19:17:19 -05:00
Roland Walker 09bed7a53b Merge pull request #7845 from rolandwalker/depends_on_x11
DSL: add `depends_on :x11`, permit multiple `depends_on` stanzas
2014-12-08 05:40:45 -05:00
Roland Walker 5348260520 DSL: add depends_on :x11 2014-12-06 11:20:15 -05:00
Roland Walker e581347939 allow multiple depends_on stanzas + refactor
also:
* disallow combining depends_on :macos comparison expressions
* ohai message when depends_on is present
* explicit accessors for :cask and :formula
* simplify some logic and flatten nested conditionals
* reflow incidental doc
2014-12-06 11:06:30 -05:00
Roland Walker a870869f9a Merge pull request #7822 from rolandwalker/allow_leading_numbers
Remove constraint that Cask tokens cannot start with digits
2014-12-06 09:00:04 -05:00
Roland Walker 2a09a970cd Merge pull request #7819 from rolandwalker/depends_on_followup
followups on `depends_on` `:macos`/`:arch`
2014-12-06 07:55:13 -05:00
Roland Walker cb5a40f787 remove constraint that tokens can't start w/ digit
Class names are now completely hidden from the user.  This
commit works by adding a prefix to all Cask class names, which
is considered to be an ugly transitional hack on the way to
representing individual Casks as instances.
2014-12-05 11:54:56 -05:00
Roland Walker d14231a568 trivial tweak to token recipe
part of syncing font token docs with the main repo
2014-12-05 11:40:52 -05:00
Roland Walker 037ece852b followups on `depends_on` `:macos`/`:arch`
* always coerce `:macos` value to array; simplify code
 * remove warning comments about unset values
 * doc explicitly that requirements are covered as well as dependencies
 * doc that `depends_on` is not consulted until `install` time
 * in docs and code, say "release" instead of "version" for the :macos release
   * todo: provide our own variable styled "release" to use in Casks, instead of Homebrew's `MacOS.Version`
 * doc that symbols are preferred for `:macos` over strings in Casks (interally, all are converted to idential `Gem::Version` objects)
 * doc: remove `os_version_only` from `cask_language_deltas.md`
 * doc: improve internal links
 * doc: recast OS X release symbol list as table
 * doc: (incidental) regularize orthography of Formula and Cask
2014-12-05 09:55:47 -05:00
Roland Walker 7f5e5124f6 DSL: `depends_on :arch` functionality/tests/doc
* fill in functionality for the `depends_on :arch` stub
* de-document `caveats` method `arch_only`
2014-12-04 14:29:27 -05:00
Roland Walker ba911b9165 Merge pull request #7741 from rolandwalker/reduce_doc_shouting
uncapitalize several doc files
2014-12-03 08:46:39 -05:00
Roland Walker 52fdbcd671 cut v0.49.0 2014-12-02 13:04:59 -05:00
Roland Walker 6736f795f6 uncapitalize several doc files
* `alternate_cask_taps.md`
* `automation.md`
* `hacking.md`
* `releasing.md`
2014-12-02 12:20:13 -05:00
Roland Walker c59a5fcb80 DSL: `depends_on :macos` functionality/tests/doc
* Fill in the functionality for the `depends_on :macos` stub
* de-document `caveats` method `os_version_only`
* clean up some related docs re: version strings
* add `depends_on_test.rb`
* clarify some related `depends_on :formula` doc, tests, and code
* formatting in test Casks
2014-12-02 12:04:27 -05:00
Roland Walker a335d3b06d unify and recast "Cask name" & "title" as "token"
* "Canonical App Name" becomes "Simplified App Name"
* devscript `cask_namer` renamed to `generate_cask_token`
* doc file `CASK_NAMING_REFERENCE.md` renamed to `cask_token_reference.md`
* DSL uses `"#{token}"` for interpolation instead of `"#{title}"`
* documentation text
* backend code (variables, method, class names)
* error message text
* tests
* code comments
* Cask comments
* emphasize `tags :name`
* doc: use "vendor" consistently instead of "developer"
* doc: many man page argument descriptions were incorrect
* incidental clarifications

Many backend variables similar to `cask_name` or `cask` have
been standardized to `cask_token`, `token`, etc, resolving a long-
standing ambiguity in which variables named `cask` might contain
a Cask instance or a string token.

In many places the docs could be shortened from "Cask name" to
simply "token", which is desirable because we use the term "Cask"
in too many contexts.
2014-12-01 11:00:23 -05:00
Roland Walker e6fde53149 doc: update CASK_NAMING_REFERENCE.md
* add Purpose section
* clarify suffix-string removal in particular
* add Converting to ASCII section
* other clarifications
* broken links
* quoting/formatting
2014-11-28 10:50:15 -05:00
ndr b6814d925d Merge pull request #7608 from rolandwalker/remove_mac_todotxt
Rename todotxtmac.rb to todotxt.rb
2014-11-25 15:45:42 +00:00
ndr 65eed9d071 Merge pull request #7605 from rolandwalker/cocoa_framework_in_name
devscript + doc: "cocoa" is a framework to remove from the end of Cask names
2014-11-25 14:55:52 +00:00
Roland Walker 475e92baaf improve doc re: removing "mac" from Cask names 2014-11-25 09:54:11 -05:00
Roland Walker a1495a4729 "cocoa" is a framework to remove from Cask names 2014-11-25 09:22:34 -05:00
ndr 163e52aa85 Merge pull request #7582 from rolandwalker/move_stage_only
doc: move `stage_only` to the artifacts section
2014-11-25 14:04:47 +00:00
Roland Walker 518117f921 doc nit: consistency of case in table cells
with some trivial changes for shorter wording
2014-11-25 08:24:07 -05:00
Roland Walker 133dd96621 doc: move `stage_only` to the artifacts section
* `stage_only` is a pseudo-artifact
* satisfies the doc that "At Least One Artifact Stanza Is Also Required"
2014-11-25 08:17:31 -05:00
Roland Walker a773c1e6c6 fill in `cask_language_deltas.md`
Almost finalized. Todo: review of `caveats` mini-DSL
for removals.
2014-11-24 10:34:20 -05:00
Roland Walker 367e0f2880 Merge pull request #7529 from rolandwalker/remove_tap_migration
Remove automatic tap migration code and docs
2014-11-22 20:03:27 -05:00
Roland Walker a38419de4a remove legacy docs from CASK_LANGUAGE_REFERENCE.md 2014-11-22 11:18:47 -05:00
Roland Walker 06db039419 remove docs re: Tap migration
replace with a single FAQ entry describing manual untap/tap
2014-11-22 10:33:17 -05:00
Roland Walker 850e8cf3c0 remove support for legacy form `destination_path`
replaced by `staged_path`
2014-11-21 09:47:13 -05:00
Roland Walker e1c773e8d8 cut v0.48.0 2014-11-20 07:55:15 -05:00
Roland Walker b02c921812 Merge pull request #7428 from rolandwalker/remove_caveats_manual_installer
DSL: remove `manual_installer` from `caveats` mini-DSL
2014-11-18 19:48:23 -05:00
Roland Walker 2fcf5b4b95 DSL: remove `manual_installer` from `caveats`
obsoleted by new form `installer :manual`.

Also remove missed obsolete documentation item.
2014-11-18 07:54:55 -05:00
ndr a21dbc85aa Merge pull request #7365 from rolandwalker/add_stage_only
DSL: add stanza `stage_only` (new spelling of `caskroom_only`)
2014-11-18 12:27:54 +00:00
Roland Walker 88b2e92015 DSL: add stanza `stage_only` (new `caskroom_only`)
`caskroom_only` was never documented.  Its original purpose was
obsoleted in #4865, and its use has been recently been reduced to
two Casks.

This PR
* continues the rationalization of naming by changing `caskroom_only`
  to `stage_only`. "stage" is the verb for "make a copy under the
  caskroom directory"
* documents `stage_only`
* adds tests for `stage_only`
* validates the argument to `stage_only`
* gives sensible output in `brew cask info` for `stage_only` Casks
* enforces that `stage_only` cannot coexist with any activatable
  artifacts

`caskroom_only` is still supported for backward compatibility,
but should be removed before 0.50.0.
2014-11-18 07:13:15 -05:00
Vítor Galvão 5ac9fd3a1a back to using sketchup (updated to 2015) in suite example in language reference 2014-11-17 17:53:33 +00:00
Vítor Galvão ecb1bafaab changed suite example to chemdoodle, is language reference docs 2014-11-17 16:20:18 +00:00
Roland Walker 6d8c622e24 doc: license values are always categories 2014-11-14 08:47:39 -05:00
Roland Walker 7c9cec2f4e use new header form in docs 2014-11-13 11:30:55 -05:00
Roland Walker f20e9472dc changelog nit 2014-11-12 11:46:10 -05:00
Roland Walker 3262c5a5e5 cut v0.47.0 2014-11-12 11:42:54 -05:00
Lee Hanxue b65d1dbad7 Fix broken links to Cask formulas 2014-11-11 12:44:08 +08:00
Vítor Galvão ca68a054f2 updated referer example cask, in CASK_LANGUAGE_REFERENCE
The previous one didn’t use the feature anymore.
2014-11-05 19:59:25 +00:00