Commit Graph

137 Commits

Author SHA1 Message Date
Vítor Galvão c3db9441cc CASK_LANGUAGE_REFERENCE.md: update flight table with new preflight additions 2015-10-02 16:29:25 +01:00
Vítor Galvão 4aa72a74fb CASK_LANGUAGE_REFERENCE.md: parse.rb link to specific revision and line 2015-09-19 15:58:42 +01:00
Vítor Galvão a1137418df doc/CASK_LANGUAGE_REFERENCE.md: general structure fixes 2015-09-18 01:48:56 +01:00
Vítor Galvão 2b8ec532fc doc/CASK_LANGUAGE_REFERENCE.md: removed double spacing 2015-09-18 01:48:55 +01:00
Vítor Galvão b564f0febc cask_language_reference: typographical fixes 2015-09-08 01:29:45 +01:00
Vítor Galvão c30a2e2863 CASK_LANGUAGE_REFERENCE.md: fix wrong link to #flight-stanzas-details 2015-09-03 15:42:10 +01:00
Geoffrey Oxberry e585d9402e Add documentation on when to comment re: URL.
Add documentation on when to comment re: differences in hostnames
between `url` and `homepage` stanzas, as a reference for when pull
requests come in that delete these comments.
2015-08-07 22:03:09 +01:00
Vítor Galvão 76ffb6ab48 update docs to allow tilde expansion in uninstall :delete 2015-08-03 18:55:46 +01:00
Vítor Galvão 55c3101806 unify reference to *flight stanzas details in docs 2015-08-02 22:45:52 +01:00
Vítor Galvão 0c086939dd cask_language_reference: add info on new postflight_helpers
set_ownership and set_permissions
2015-08-02 22:45:51 +01:00
Michael 7971e7341e Update example cask in Language Reference Doc 2015-07-03 02:44:02 +08:00
scribblemaniac 913712c163 Additions for El Capitan and < Tiger 2015-07-02 17:57:07 +01:00
Andrew 0ad03b7218 Merge pull request #11672 from vitorgalvao/elcapitan
additions for El Capitan
2015-06-23 14:21:37 +02:00
Sean Smith ca84e18483 Documentation: URL supports tar.bz2 files
Given that `tar` on MacOS X supports tar.bz2 files, updating docs to
reflect that homebrew-cask inherits that support. Closes #11309 due
to lack of proper xz support in MacOS X.
2015-06-20 00:43:14 -04:00
Vítor Galvão 5fe97c6d12 additions for El Capitan 2015-06-09 16:52:57 +01:00
Vítor Galvão 230a116be8 added free_license caveat 2015-04-20 18:20:07 +01:00
Vítor Galvão e8549d3b17 added discontinued caveat 2015-04-20 02:12:59 +01:00
Radek Simko c1f24d5bad Merge pull request #10291 from radeksimko/uninstall-sudo
Allow :sudo in uninstall stanza (:script + :early_script)
2015-04-16 16:16:45 +01:00
Vítor Galvão 29213d5172 cask_language_reference: link :target examples to specific lines and revisions
This makes reasoning faster to spot, and protects in the even those ever change.
2015-04-05 19:47:15 +01:00
Radek Simko 64c682afa3 Allow :sudo in uninstall stanza (:script + :early_script) 2015-03-29 22:16:51 +01:00
Scott Bronson 29446f2bb2 Note which methods require the caveats block form 2015-01-12 11:00:11 -08:00
Vítor Galvão 529bd801e4 Removed support for widgets
Closes #2206.
2015-01-08 19:51:15 +00:00
ndr 9ce8c1e112 Merge pull request #8590 from rolandwalker/doc_depends_on_cask
document depends_on :cask
2015-01-02 15:13:40 +00:00
Roland Walker ca8799919c document depends_on :cask 2015-01-02 09:59:35 -05:00
Roland Walker 3171f4caa0 use inclusive conditionals in examples 2015-01-02 09:57:31 -05:00
Vítor Galvão 7aa3df119a cask_language_reference.md: make clear licenses should never take into
account the vendor's business model.

Closes #8169.
2014-12-18 02:44:29 +00:00
Roland Walker 1413bea1c0 `sha256 :no_check` overrides `version <string>`
This behavior was traditionally present, and is now recovered
by removing the audit test added in #4743.  The doc is clarified
but did not require major change.

closes: #6356
refs: #8179
2014-12-17 08:21:51 -05:00
Roland Walker d96c17b9db enable `license :freemium` 2014-12-11 09:42:24 -05:00
Roland Walker be1bf6dfac document `name` stanza
and undocument obsolete `tags :name`
2014-12-09 18:53:34 -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 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 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 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
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 a38419de4a remove legacy docs from CASK_LANGUAGE_REFERENCE.md 2014-11-22 11:18:47 -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