Commit Graph

44 Commits

Author SHA1 Message Date
Vítor Galvão 529bd801e4 Removed support for widgets
Closes #2206.
2015-01-08 19:51:15 +00:00
Roland Walker ca8799919c document depends_on :cask 2015-01-02 09:59:35 -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 510b1ba7fc doc: remove "incomplete" banner on deltas doc 2014-12-09 11:01:27 -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 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 5348260520 DSL: add depends_on :x11 2014-12-06 11:20:15 -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 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 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 850e8cf3c0 remove support for legacy form `destination_path`
replaced by `staged_path`
2014-11-21 09:47:13 -05: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
Roland Walker 7c9cec2f4e use new header form in docs 2014-11-13 11:30:55 -05:00
Roland Walker baa81a8907 basic docs for stub gpg stanza 2014-10-21 08:37:17 -04:00
Roland Walker 7cfab7119e document `conflicts_with`
Only a stub now, but defined into DSL 1.0
2014-10-17 08:36:10 -04:00
Roland Walker 633a2ef0f1 Merge pull request #6660 from rolandwalker/installer_stanza
DSL: add `installer` stanza
2014-10-15 22:58:28 -04:00
Roland Walker 012a9f5a7b document `appcast` stanza
The :latest_version key stays undocumented, as it is not
clear yet whether it is useful
2014-10-15 09:28:29 -04:00
Roland Walker 42770516f7 dsl: add `installer :manual`
a toplevel artifact, intended to replace `manual_installer`,
which is currently implemented within the `caveats` mini-DSL
2014-10-14 11:34:44 -04:00
Roland Walker 68fdb25129 recast install_script to installer :script
* document installer :script.  install_script was never documented
2014-10-14 11:34:32 -04:00
Roland Walker 41cf7d96f0 docs and tests for new form `container :nested` 2014-10-09 11:34:37 -04:00
Roland Walker 6996acfba5 Merge pull request #6507 from rolandwalker/doc_uninstall_trash
Document `uninstall :trash`
2014-10-06 17:44:17 -04:00
Roland Walker f947a13cc5 document `tags` stanza 2014-10-06 11:44:25 -04:00
Roland Walker 8eaab9384e incidental Markdown formatting 2014-10-06 11:25:28 -04:00
Roland Walker a91673f0a3 document `uninstall :trash` 2014-10-06 11:25:17 -04:00
Roland Walker e3f10f82b8 doc and tests for `container :type`
includes some minor tweaks/re-ordering in docs
2014-10-03 10:40:54 -04:00
Roland Walker f1604e4efb docs and create template for new license stanza
some :closed licenses in the code are left undocumented for
now, and should not be used.
2014-10-01 11:18:13 -04:00
Roland Walker 568365194d Merge pull request #6227 from rolandwalker/doc_uninstall_delete
doc/tests switchover to `uninstall :delete`
2014-09-18 06:25:59 -04:00
Roland Walker 0b4ad8714b doc/tests switchover to `uninstall :delete`
from `uninstall :files`
2014-09-17 10:41:10 -04:00
Roland Walker d9fe7a9c17 Merge pull request #6225 from rolandwalker/add_artifact_stanza
DSL: add `artifact` stanza
2014-09-17 09:35:53 -04:00
Roland Walker f7018e0106 DSL: add `artifact` stanza
Keeping the `link` stanza in the DSL is a mistake: it will be
confusing when combined with the ability to install by copying.

This PR retires `link` completely, and adds a generic artifact
stanza called `artifact`.  (`link` is removed from the docs, but
will still work for compatibility during transition.)

This only affects one current Cask (dwarf-fortress.rb), and that
Cask may be changed to use `suite` in the future.
2014-09-17 09:09:53 -04:00
Roland Walker 6d82c9770e change docs/tests to use version :latest
Instead of version 'latest' (value as string).  The string
value is still permitted during a transitional period.
2014-09-17 07:22:33 -04:00
Roland Walker edb28f57b1 document new suite stanza
* includes other doc nits
* link to `sketchup.rb` will not work until the Casks are also changed
2014-09-16 11:19:08 -04:00
Roland Walker 1ddec7128d add uninstall :rmdir
per discussion at https://github.com/caskroom/homebrew-cask/pull/6174#discussion-diff-17516171
refs: #6174

This PR is large because of some test-suite refactoring.
2014-09-16 09:48:32 -04:00
Roland Walker 5ae6e2f773 doc new `app` stanza and update tests to use it
Replacing `link` for almost all cases.

The `link` stanza can still appear in error messages, because
under the hood, `app` is still implemented as a pure synonym
for the `link` artifact.  That will change automatically when
we factor into separate artifacts.
2014-09-13 13:03:46 -04:00
Roland Walker 3b7d459993 Merge pull request #6163 from rolandwalker/doc_pkg_nit
restore `pkg` to cask_language_deltas.md
2014-09-13 12:58:31 -04:00
Roland Walker 00921dd513 functionality and docs for zap stanza
* `zap` was previously supported as a noop for forward-compatibility
* Also adds restrictions against relative paths in `uninstall :files`
* Also documents safety conventions for `uninstall :files`
2014-09-13 10:21:17 -04:00
Roland Walker 35671e5900 restore `pkg` to cask_language_deltas.md
was deleted due to merge error in #6138
2014-09-13 10:09:16 -04:00
Roland Walker dfcbd7154e docs, error msgs, tests for depends_on :formula
replacing depends_on_formula in DSL
2014-09-11 20:33:39 -04:00
Roland Walker ab4f52a781 docs and error messages for new DSL stanza `pkg`
transition from `install` to `pkg`
2014-09-10 10:54:06 -04:00
Roland Walker 58a4c1092d rename delta file and update transition docs
requires #6074 (may show merge conflict)
2014-09-08 20:37:42 -04:00