Commit Graph

698 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 3cea8d73d1 maintaining.md: travis 2015-10-02 15:45:34 +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 19a4da0396 doc/releasing.md: general structure fixes 2015-09-18 01:48:57 +01:00
Vítor Galvão f15ec670dd doc/maintaining.md: general structure fixes 2015-09-18 01:48:57 +01:00
Vítor Galvão ec23d1a437 doc/hacking.md: general structure fixes 2015-09-18 01:48:56 +01:00
Vítor Galvão 2fdf5ebf1d doc/cask_token_reference.md: general structure fixes 2015-09-18 01:48:56 +01:00
Vítor Galvão 9d883d5cb7 doc/cask_language_deltas.md: general structure fixes 2015-09-18 01:48:56 +01:00
Vítor Galvão 4c72606867 doc/alternate_cask_taps.md: general structure fixes 2015-09-18 01:48:56 +01:00
Vítor Galvão 5df2c01f77 doc/FAQ.md: general structure fixes 2015-09-18 01:48:56 +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 2615833b15 doc/src/brew-cask.1.md: removed double spacing 2015-09-18 01:48:56 +01:00
Vítor Galvão b66fbf0a82 doc/releasing.md: removed double spacing 2015-09-18 01:48:56 +01:00
Vítor Galvão 4765c219de doc/hacking.md: removed double spacing 2015-09-18 01:48:56 +01:00
Vítor Galvão 8e125fbe83 doc/cask_token_reference.md: removed double spacing 2015-09-18 01:48:56 +01:00
Vítor Galvão 76ac45ceca doc/cask_language_deltas.md: removed double spacing 2015-09-18 01:48:55 +01:00
Vítor Galvão 27faa0f879 doc/FAQ.md: removed double spacing 2015-09-18 01:48:55 +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 1d0936a1c5 maintaining: typographical fixes 2015-09-08 01:30:43 +01:00
Vítor Galvão b9d8913720 hacking: typographical fixes 2015-09-08 01:30:32 +01:00
Vítor Galvão 4b631ee074 cask_token_reference: typographical fixes 2015-09-08 01:30:20 +01:00
Vítor Galvão a1f3a63434 alternate_cask_taps: typographical fixes 2015-09-08 01:30:09 +01:00
Vítor Galvão 04cf75a3d0 man pages: typographical fixes 2015-09-08 01:29:56 +01:00
Vítor Galvão b564f0febc cask_language_reference: typographical fixes 2015-09-08 01:29:45 +01:00
Vítor Galvão 0f418734d7 faq: update to new install policy 2015-09-08 01:28:57 +01:00
Vítor Galvão ce03169abe releasing: typographical fixes 2015-09-08 01:28:45 +01:00
Vítor Galvão 2e1ea357db maintaining.md: add labels section 2015-09-05 14:01:20 +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
Josh Hagins b30085af1e cut v0.56.0 2015-08-04 00:27:56 -04: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 ea7e115c1c cask_language_deltas: add info on new postflight_helpers
set_ownership and set_permissions
2015-08-02 22:45:51 +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
Josh Hagins 118520d5a5 cut v0.55.0 2015-08-02 12:24:32 -04:00
Vítor Galvão 9c4a1fa470 FAQ: remove mention of pre-org tap (no confusions for a long time) 2015-07-26 20:30:19 +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
ndr 2fc9d23239 cut v0.54.1 2015-06-13 19:55:40 +01:00
Vítor Galvão 5fe97c6d12 additions for El Capitan 2015-06-09 16:52:57 +01:00
Paul Hinze a952b87291 cut v0.54.0 2015-05-11 09:56:56 -05:00
Vítor Galvão e07eb157ca Separate caveats mini-dsl documentation into versioned sections 2015-04-20 18:20:08 +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
Tim Sheridan 0c36210dd3 Add dependency installation to test instructions 2015-04-19 12:28:55 +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
Paul Hinze e65c40bb2b cut v0.53.3 2015-02-09 15:43:49 -06:00
Paul Hinze 5df43132cb cut v0.53.2 2015-02-09 09:50:07 -06:00
Paul Hinze 95ccc3dfe5 missed a spot on CHANGELOG 2015-02-08 08:54:53 -06:00
Paul Hinze ca79d4b3df cut v0.53.1 2015-02-08 08:42:14 -06:00
Roland Walker a7516e3c8e Iterate on the new maintainer doc: friendliness
* spellcheck
* move practical paragraph under "Reviewing Incoming Casks"
* add bullet points "Friendliness" and "Supporting each other"
2015-02-07 11:37:51 -05:00
Roland Walker 6366efc44b Merge pull request #9239 from caskroom/stub-maintainers-doc
stub doc for maintainers
2015-02-06 16:53:20 -05:00
Vítor Galvão 83c712741b Merge branch 'strip_launcher_from_names' of https://github.com/rolandwalker/homebrew-cask into rolandwalker-strip_launcher_from_names
Conflicts:
	Casks/googleappengine.rb
	doc/CASK_NAMING_REFERENCE.md
2015-01-29 13:54:06 +00:00
Paul Hinze a7f7e83f00 stub doc for maintainers 2015-01-25 16:47:12 -06:00
ndr 23887c8fdf cut v0.53.0 2015-01-23 10:58:08 +00:00
Vítor Galvão 0ae2edd707 Merge pull request #8840 from vitorgalvao/remove-alfred
Removed alfred command support
2015-01-13 21:27:17 +00:00
Vítor Galvão 078f0b0300 removed alfred support 2015-01-13 17:49:32 +00:00
ndr 57867eef32 Merge pull request #8870 from rolandwalker/remove_release_constants
remove homebrew-fork `MACOS_RELEASE` constants
2015-01-13 17:48:54 +00:00
Roland Walker a401047164 remove homebrew-fork MACOS_RELEASE constants
* contain logic within module Hbc::MacOS
* add release_with_patchlevel method
* allow MACOS_RELEASE and MACOS_RELEASE_WITH_PATCHLEVEL
  environment variables to override the determined release
  values regardless of whether under the test harness
2015-01-13 07:35:27 -05:00
Scott Bronson 29446f2bb2 Note which methods require the caveats block form 2015-01-12 11:00:11 -08:00
ndr d5722ee079 Merge pull request #8751 from vitorgalvao/remove-widget-support
Remove support for widgets
2015-01-11 12:29:00 +00:00
Vítor Galvão 529bd801e4 Removed support for widgets
Closes #2206.
2015-01-08 19:51:15 +00:00
Roland Walker 37be5ead09 v0.52.1 changelog didn't make it into the release
but was published on github
2015-01-07 18:33:19 -05:00
Roland Walker db23f90c3e Merge pull request #8723 from rolandwalker/move_homebrew_path_constants
recast `HOMEBREW_*` path constants as read/write location methods
2015-01-07 18:19:02 -05:00
Roland Walker de5b47f283 doc that brew-cask-cmd.rb can be invoked directly
* simpler and equivalent to being invoked from Homebrew,
  except for some environment variables.
* correct bin subdir to lib
2015-01-07 09:14:17 -05:00
ndr 7c8d878c13 Remove doc/automation.md
Documented an obsolete process based on the deprecated `brew bundle`
command.
2015-01-07 12:26:34 +00:00
Roland Walker 076c5c4882 tweak releasing.md 2015-01-02 19:16:25 -05:00
Roland Walker 4e59f6c55b cut v0.52.0 2015-01-02 19:09:43 -05: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
Roland Walker 61bb650d7f fix broken doc links 2015-01-02 09:55:39 -05:00
Roland Walker 202d6019f8 Move all code under an Hbc:: namespace
* convert existing Cask:: namespace to Hbc::
* move Homebrew-fork code under Hbc::
* move freestanding classes such as Tty and TopologicalHash under Hbc::
* recast HOMEBREW_CASK_ constants as HBC_
* modify our Homebrew Formula for backward compatibility
* devscripts and dev docs
2015-01-02 07:27:03 -05:00
Roland Walker 9cb0b1cfdf expand @ symbols in tokens
refs: #8478
2014-12-29 09:41:47 -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 ae133faf2f Merge pull request #8152 from rolandwalker/ruby_2_0_transition
remove docs and code relevant to Ruby 1.8 compatibility
2014-12-16 21:18:10 -05:00
Roland Walker 50294ef0ce cut v0.51.1 2014-12-16 10:15:50 -05:00
Roland Walker 6c41fe493b remove docs and code relevant to Ruby 1.8 compat 2014-12-16 08:50:33 -05:00
Roland Walker 86556d4a59 cut v0.51.0 2014-12-16 08:15:31 -05:00
Roland Walker 1a238777ee Merge pull request #8089 from rolandwalker/homebrew_separation
Separate the Ruby backend from Homebrew + Require Ruby 2.x
2014-12-16 07:51:37 -05:00
Roland Walker ba12a2aaaa replace brew-cask.rb subcommand with bash shim
The `brew-cask` shim finds and executes `lib/brew-cask-cmd.rb`,
but only if Ruby 2.0+ is found.
2014-12-16 07:23:57 -05:00
Radek Simko 6bce46d2f2 Test options made consistent and documented 2014-12-14 13:16:10 +01:00
Roland Walker 8868e22bbd Merge pull request #8017 from rolandwalker/document_freemium_license
enable `license :freemium`
2014-12-12 09:23:10 -05:00
Roland Walker f7c444d034 document user-maintained BumpTop Tap
closes #7824
2014-12-11 11:27:15 -05:00
Roland Walker d96c17b9db enable `license :freemium` 2014-12-11 09:42:24 -05:00
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 16272f1a42 doc: remove "launcher" terms from end of Cask name 2014-11-25 09:40:08 -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
David Dinh 53cb8beabe Update FAQ with information on uninstall issues 2014-10-28 17:33:06 -07:00
Roland Walker f7258c0e1b cut v0.46.0 2014-10-25 12:15:38 -04:00
Roland Walker 2370400207 chg `checklinks` to internal command `_checklinks`
* `checklinks` is a very simple implementation useful only for development purposes
* it has no test coverage, only one line of documentation
* users regularly experiment with it and break it, especially
 `brew cask checklinks` with no arguments, which tests all Tapped Casks
2014-10-24 09:49:35 -04:00
Roland Walker bad6d6934d Merge pull request #6840 from rolandwalker/doc_stage_vs_install
use "staged" instead of "installed" for Caskroom files in messages
2014-10-23 05:10:39 -04:00
ndr 99e0e1bf01 Merge pull request #6862 from rolandwalker/demote_faq_banner
demote the Tap migration banner in FAQ.md
2014-10-22 10:22:30 +01:00
ndr a97279731a Clarify doc stub for gpg signatures 2014-10-21 15:55:56 +01:00
Roland Walker baa81a8907 basic docs for stub gpg stanza 2014-10-21 08:37:17 -04:00
Roland Walker 3176fbd08c demote the Tap migration banner in FAQ.md 2014-10-21 07:16:09 -04:00
Roland Walker cd63241558 use "staged" instead of "installed" for Caskroom
refs: #6783
2014-10-21 07:13:04 -04:00
Roland Walker a949a3f5a5 Merge pull request #6783 from rolandwalker/rename_destination_path
recast method `destination_path` as `staged_path`
2014-10-20 07:20:59 -04:00
Roland Walker 967aa22793 recast method `destination_path` as `staged_path`
* part of DSL 1.0 review
* `destination_path` was always a bit vague (it refers to
  Cask-specific, version-specific location under
  `/opt/homebrew-cask/Caskroom`)
* here renamed `staged_path` to match upcoming command verb
  `brew cask stage`
* rename also intended to reduce confusion when we implement
  copying as a configurable alternative to symlinking
* transitional `destination_path` methods to remain while
  Casks are converted (this was documented as a part of the
  DSL, and used by 39 Casks in main repo)
* unrelated variables containing "stage" recast for clarity
2014-10-18 12:23:36 -04:00
Roland Walker 8c1c20930a Merge pull request #6736 from rolandwalker/doc_conflicts_with
document `conflicts_with`
2014-10-18 06:40:09 -04:00
Micah Buckley-Farlee 63d33b67c3 Fix module capitalization 2014-10-17 22:06:04 -07:00
Roland Walker b76d0fbb4f cut v0.45.0 2014-10-17 09:10:11 -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 db221ff69e doc: remove needless column from table 2014-10-14 11:34:38 -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 bdadbb78ce Merge pull request #6599 from rolandwalker/cask_instancevar_interpolation
steer away from using `@cask` instance variable in `caveats` interpolation
2014-10-10 18:51:21 -04:00
Roland Walker ba10ad9ded doc: steer away from @cask instance in `caveats`
encourage placements of `caveats` at end of Cask
2014-10-10 08:18:51 -04:00
Roland Walker 41cf7d96f0 docs and tests for new form `container :nested` 2014-10-09 11:34:37 -04:00
Roland Walker 707db75505 standardize Cask (capitalized) when used as noun
* was already done, but inconsistently
* this style follows homebrew Formula
* covers user-facing messages, test titles, comments
* some related minor orthography is included, such
  as the consistent spelling of our project name as
  "homebrew-cask"
* grammar nits
2014-10-08 10:39:51 -04:00
Roland Walker 10c5aa56ab Merge pull request #6535 from rolandwalker/doc_toplevel_variables
doc: clarify that Utils namespace is for variables
2014-10-07 17:52:39 -04:00
Roland Walker d1a32cd592 doc: clarify that Utils namespace is for variables
as well as methods
2014-10-07 11:36:36 -04:00
Roland Walker 41aec6cccd regularlize changelog whitespace 2014-10-07 10:26:35 -04:00
Roland Walker 4db0867307 add release date to changelog
retroactively and in template
2014-10-07 10:19:47 -04:00
Roland Walker 096a13ed73 cut v0.44.0 2014-10-07 08:52:49 -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 f82de749f5 sync `license` doc with `tags`
re: current lack of front-end interface to the relevant Cask data
2014-10-06 11:45:00 -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
Vítor Galvão 8b333bd711 added :target accepted cases, to language reference 2014-10-02 10:54:15 -04:00
Roland Walker 57c3ee501c Merge pull request #6426 from rolandwalker/doc_license_stanza
docs and `create` template for new license stanza
2014-10-01 14:16:24 -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
Vítor Galvão 30ac47c9d4 Clarified how to persist options, in man page 2014-10-01 13:24:31 +01:00
Roland Walker 4b6f5c7695 cut v0.43.1 2014-09-30 10:53:46 -04:00
ndr 9568ac55e2 Merge pull request #6384 from ndr-qef/docs/hacking
Review HACKING docs
2014-09-29 20:27:48 +02:00
Roland Walker 74fc49a1a7 Revert "WIP Review HACKING docs" 2014-09-29 14:08:18 -04:00
ndr 864173b29f Review HACKING docs
Specifically:
- abandon the FAQ layout for improved readability;
- remove sections describing issues which can be easily searched;
- add current priorities.
2014-09-29 20:06:08 +02:00
Roland Walker dabdd2d201 Merge pull request #6342 from ndr-qef/docs/hacking
Review HACKING docs
2014-09-29 14:04:20 -04:00
ndr 38b97a137e Review HACKING docs
Specifically:
- abandon the FAQ layout for improved readability;
- remove sections describing issues which can be easily searched;
- add current priorities.
2014-09-28 17:20:13 +02:00
ndr 8501332abf Merge pull request #6362 from rolandwalker/doc_tables
doc nits: table order, table format, whitespace
2014-09-27 20:20:41 +02:00
Roland Walker a57ac581a6 doc nits: table order, table format, whitespace
make the order of tables match the order of stanzas in
the examples and `brew cask create` template
2014-09-27 13:35:49 -04:00
Roland Walker 019b412713 simplify RELEASING.md a bit 2014-09-27 13:26:56 -04:00
Roland Walker 077a8514fe cut v0.43.0 2014-09-27 13:18:00 -04:00
Roland Walker 0b22bbf3a5 doc followup: missing deprecations 2014-09-18 07:36:38 -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 28217a5b77 cut v0.42.0 2014-09-17 09:45:32 -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 fe0a053dad Merge pull request #6208 from rolandwalker/uninstall_force
add `--force` option for `brew cask uninstall`
2014-09-16 19:33:17 -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 d156cbfcb2 add `--force` option for `brew cask uninstall`
also update some related docs for verbs `install` and `uninstall`
2014-09-16 10:59:44 -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 fbf65f046b Merge pull request #6189 from rolandwalker/doc_zap_user_content
doc don't `zap` user-created content
2014-09-16 07:08:12 -04:00
Roland Walker 9b92081d59 doc don't `zap` user-created content
per discussion in https://github.com/caskroom/homebrew-cask/pull/6174#discussion-diff-17516171
refs: #6174
2014-09-15 09:48:28 -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 ce64b38723 Merge pull request #6155 from rolandwalker/add_zap_stanza
functionality and docs for zap stanza and verb
2014-09-13 12:55:57 -04:00
Roland Walker d2ba4fdf4d cut v0.41.1 2014-09-13 12:49:30 -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 2e5fcfbde0 Merge pull request #6141 from rolandwalker/doc_pkgutil_uninstall
doc: highlight `:pkgutil`
2014-09-11 20:23:16 -04:00
Roland Walker bc10676818 Merge pull request #6139 from rolandwalker/doc_nit_anchor
doc nits re: caveats.  Broken anchor link.
2014-09-11 20:22:54 -04:00
Vítor Galvão e8ac96693e replaced vagrant with unity in examples referencing the pkg 2014-09-11 20:09:24 +01:00
Roland Walker 113f02dd43 doc: highlight `:pkgutil`
As the most-important `uninstall` directive
2014-09-11 11:15:58 -04:00
Roland Walker cfd6bd003e doc nits re: caveats. Broken anchor link. 2014-09-11 10:50:27 -04:00
Roland Walker 719bb998ed cut v0.41.0 2014-09-11 10:08:43 -04:00
Roland Walker 8bbc5e6635 DSL doc: uninstall now available for all Casks
But required for `pkg`-based Casks.  Also contains some general
cleanup in section "Uninstall Stanza Details", which still needs
work.
2014-09-11 09:26:01 -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
ndr 5104f9a3d4 Merge pull request #6094 from rolandwalker/doc_ls_long
document new option brew cask ls -l
2014-09-09 20:44:59 +02:00
Roland Walker 868ed811b7 document new option brew cask ls -l 2014-09-09 07:05:31 -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
Roland Walker 0bc6cc4cf3 Merge pull request #6073 from rolandwalker/releasing_updates_0.40.0
updates to release process after v0.40.0
2014-09-08 17:38:02 -04:00
Roland Walker 28c2c1106a transition: doc preflight/postflight stanzas
a mass change to Casks to come later
2014-09-08 11:47:59 -04:00
Roland Walker 4ecc1b97dc Merge pull request #6072 from rolandwalker/dsl_transition_doc
doc: first changes for DSL 1.0
2014-09-08 11:30:05 -04:00
Roland Walker b93206093a updates to release process after v0.40.0 2014-09-08 11:24:38 -04:00
Roland Walker a38ec50a3b doc: first changes for DSL 1.0
Do not revert this PR after the transition period.  It contains
a README banner which needs to be deleted later, but also a
persistent doc file and an unrelated whitespace nit.
2014-09-08 10:48:39 -04:00
Roland Walker 92e15b4a91 cut v0.40.0 2014-09-08 10:28:31 -04:00
Roland Walker 1b05d18a3b add support for internet_plugin artifact
closes #5909
2014-08-26 11:22:25 -04:00
Roland Walker 615f895a1c updates to release procedure after v0.39.3 2014-08-13 08:26:26 -04:00
Roland Walker 99e75bddfd cut v0.39.3 2014-08-13 07:47:41 -04:00
Roland Walker 906aa4e167 Merge pull request #5750 from rolandwalker/release_process_updates
minor amendments to release process/changelog
2014-08-12 16:09:43 -04:00
Roland Walker 38adf8b021 Merge pull request #5729 from rolandwalker/doc_list_1
document new option `brew cask list -1`
2014-08-12 09:58:45 -04:00
Roland Walker 5faacd885a minor amendments to release process/changelog
based on lessons learned from failed release v0.39.0,
`git push && git push --follow-tags` is smarter because
it reduces the chance of an unreleasable tag being pushed.
(git pushes the tags before it pushes the commits).
2014-08-12 09:00:49 -04:00
Roland Walker b65c4963ea cut v0.39.2 2014-08-12 08:17:12 -04:00
Roland Walker e86e94f6d3 cut v0.39.1 2014-08-12 07:36:38 -04:00
Roland Walker 029907a875 document new option `brew cask list -1`
References: #5699
2014-08-11 10:07:18 -04:00
Roland Walker 7a58fdaeca doc: preferred conditional structure
latest OS version or hardware should be the default case
2014-08-09 12:43:16 -04:00
Roland Walker 99d001afa4 add support for xar containers
references: #5442
2014-08-02 14:51:51 -04:00
Roland Walker 6f34db7dfd doc updated valid values for container_type 2014-08-02 11:19:39 -04:00
Roland Walker 0c609fbfe6 cut v0.38.1 2014-07-31 09:24:45 -04:00
Roland Walker a2eae68b03 Merge pull request #5542 from rolandwalker/remove_migration_banner
Move the Tap Migration banner from README.md to FAQ.md
2014-07-28 17:40:05 -04:00
Roland Walker 219ce8feee doc: changelog glitch 2014-07-28 15:16:54 -04:00
Roland Walker 30296d5ded cut v0.38.0 2014-07-28 15:13:12 -04:00
Roland Walker bfd88bc5af Move the Tap Migration banner from README to FAQ
We have not seen an issue filed on this in some time.
2014-07-28 14:33:00 -04:00
Roland Walker fb13db0e98 fix missing changelog entries for 0.37.1 2014-06-25 20:50:59 -04:00
Roland Walker 29a6a1ec10 Extend subcommand dispatch to include full paths
Covering all cases
- external commands as executables
- external commands as Ruby libraries
- built-in command verbs

This is intended as a development aid.

A side benefit is that an external command can be constructed
to use a `run` method, rather than having to accomplish everything
at `require` time.
2014-06-21 14:51:57 -04:00
Roland Walker cdede4aa24 Merge pull request #4996 from rolandwalker/releasing_tweaks
updates to release process after v0.37.0
2014-06-20 06:00:58 -04:00
Roland Walker bd6ebf85a4 doc: tracker symlinks are in download cache
At least mention tracker symlinks in the docs, since they
are displayed in the feedback messages.

References: #4995
2014-06-19 17:46:17 -04:00
Roland Walker 8e8e6399fd updates to release process after v0.37.0 2014-06-19 16:42:25 -04:00
Roland Walker e61f297f9d cut v0.37.0 2014-06-19 15:38:38 -04:00
Roland Walker 2ffee346df standardize the recommended upgrade command
in both docs and error messages.

Recent bug reports indicate that `cleanup` commands are essential
in some situations.
2014-06-18 15:15:50 -04:00
Roland Walker 6fcf62e6aa Merge pull request #4924 from rolandwalker/suggested_stanza_order
suggested (not enforced) order for Cask stanzas
2014-06-17 05:57:29 -04:00
Roland Walker c02ff61e74 Merge pull request #4926 from rolandwalker/doc_lang_ref_tweaks
doc tweaks to CASK_LANGUAGE_REFERENCE.md
2014-06-17 05:45:54 -04:00
Roland Walker 93617b1286 Merge pull request #4925 from rolandwalker/doc_ruby_interpreter_vsn
doc latest Ruby interpreter situation in HACKING.md
2014-06-16 18:05:15 -04:00
Roland Walker 5b64813420 doc tweaks to CASK_LANGUAGE_REFERENCE.md
- include OS X 10.10
- include the word "specification"
- clarify how to call out of the `caveats` mini-DSL

References: #4921, though `version` is being added to the
`caveats` mini-DSL
2014-06-16 15:32:58 -04:00
Roland Walker 3cb729095d suggested (not enforced) order for Cask stanzas
References: #4914
2014-06-16 13:32:08 -04:00
Roland Walker 2bfa4e554a add `version` helper method to `caveats` mini-DSL
As was already done (for convenience) for `title`.

References: #4921 .
2014-06-16 12:56:31 -04:00
Roland Walker b4761dd4a8 doc latest Ruby interpreter in HACKING.md
- Homebrew recently changed to Ruby 2.0 on some systems
- doc that we inherit the interpreter from Homebrew
2014-06-16 12:48:26 -04:00
Roland Walker d266826669 Merge pull request #4911 from vitorgalvao/cosmetic-changes-alternate-taps-doc
Cosmetic changes to ALTERNATE_CASK_TAPS documentation
2014-06-16 07:42:34 -04:00
Roland Walker e6ce577429 Merge pull request #4913 from radeksimko/x11-doc
Mention x11_required caveat in docs
2014-06-16 07:26:13 -04:00
Radek Simko 55b5f6ceea Mention x11_required caveat in docs 2014-06-15 20:17:31 +01:00
Vítor Galvão ba7d3c08b4 changed footnote syntax in alternate taps doc 2014-06-15 17:58:29 +01:00
Vítor Galvão 8d4b731d21 All bulletpoints now start with a capital letter in alternate taps doc 2014-06-15 17:57:50 +01:00
Roland Walker 266b22d47f Merge pull request #4884 from rolandwalker/doc_upgrade_progress
update HACKING.md re: upgrade verb
2014-06-14 18:16:21 -04:00
Roland Walker 7ec9698091 Merge pull request #4875 from laurent22/patch-1
Added two more questions / answers
2014-06-14 14:30:34 -04:00
Laurent 8a7ca82894 Added two more questions / answers
Added QAs regarding localized versions and auto-updated applications.
2014-06-14 13:57:57 -03:00
Roland Walker 8d123a0cad update HACKING.md re: upgrade verb 2014-06-14 08:37:03 -04:00
Roland Walker 3f4f6580e0 cut v0.36.2 2014-06-14 08:19:00 -04:00
Roland Walker 25d0e65713 put gpsbabel utility function inside namespace
and document the conventions for doing so
2014-06-12 10:52:03 -04:00
Roland Walker 4652e8bbcb cut v0.36.1 2014-06-11 12:47:13 -04:00
Roland Walker 833176d9d9 Merge pull request #4807 from rolandwalker/allow_full_path_troubleshooting
Allow invocation of subcommand with full paths
2014-06-10 18:22:20 -04:00
Roland Walker 231f3cd92a Allow invocation of subcommand with full paths
Full paths to subcommand source and Ruby may be given,
which is helpful in troubleshooting, particularly for
forcing a specific Ruby version.

Example usage:
```bash
$ HOMEBREW_BREW_FILE=/usr/local/bin/brew /System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/bin/ruby /usr/local/Library/brew.rb /usr/local/bin/brew-cask.rb help
```

Previously, this would work, but throw an odd error when
returning to Homebrew.  Fix: we unconditionally do not
return to Homebrew.
2014-06-10 16:36:47 -04:00
Roland Walker b7cf18c139 document signal severity 2014-06-10 10:55:13 -04:00
Roland Walker 4bf7d5bdc6 cut v0.36.0 2014-06-07 18:02:33 -04:00
Roland Walker 979ddc7c54 Merge pull request #4738 from rolandwalker/doc_https_tweaks
doc: separate the HTTPS statement under one heading
2014-06-07 13:38:19 -04:00
Roland Walker cf89f7f7e8 regularize whitespace 2014-06-07 11:43:40 -04:00
Roland Walker 770643a5f7 Separate the HTTPS statement under one heading
also update examples to use HTTPS
2014-06-06 22:15:24 -04:00
Roland Walker e7a01deb4d devscript: add `list_url_attributes_on_file`
Uses OS X extended attributes (via `xattr`) to find the source
of a downloaded file.
2014-06-06 20:53:26 -04:00
Roland Walker 0ef4606e0c retire support for `no_checksum` stanza 2014-06-04 23:26:09 -04:00
Roland Walker d3e2c477ee doc: we now have user-maintained alt Cask Taps 2014-06-03 11:58:57 -04:00
Roland Walker ebc64b8fcf Merge pull request #4608 from rolandwalker/doc_alt_cask_taps
document how to create alternate Cask Taps
2014-06-02 08:41:25 -04:00
Roland Walker b41b364d85 document how to create alternate Cask Taps
closes #3954
2014-06-02 08:40:47 -04:00
Roland Walker 19fb223bae doc: tweak version numbers needed for migration 2014-05-31 10:29:16 -04:00
Roland Walker b38d6a6977 add `:signal` directive for `uninstall`
to send arbitrary Unix signals.  Per discussion in #4328, some
processes are resistant to the `:quit` directive, and can be
made to shut down via a signal.
2014-05-13 13:04:10 -04:00
Roland Walker 1b0ef14e3b update TAP_MIGRATION.md based on recent reports
from IRC and GitHub issues.  Closes #4312
2014-05-12 08:20:38 -04:00
Roland Walker 60ba164c1b Merge pull request #4299 from rolandwalker/expand_plus
expand the `+` symbol in Cask names
2014-05-09 16:26:10 -04:00
Roland Walker e8c73b7b66 expand the `+` symbol in Cask names
closes #4275. references discussion in #4106.
2014-05-09 09:32:47 -04:00
Vítor Galvão 112964ca7f changed mentions of 'brew --prefix' to 'brew --repository' 2014-05-09 01:02:48 +01:00
Roland Walker cfc6ae7a13 Merge pull request #4264 from rolandwalker/retire_sha1
Retire support for `sha1` stanza.
2014-05-08 18:37:00 -04:00
Roland Walker 34df5309d4 Retire support for `sha1` stanza.
We haven't received new submissions using `sha1` for quite
some time.
2014-05-08 12:01:32 -04:00
Kevin Kaland 77d165d938 Improve readability of documentation change.
Markdoooooown!!!!
2014-05-08 15:00:25 +02:00
Roland Walker 635cd7c676 Merge pull request #4257 from rolandwalker/convert_no_checksum_1
transition docs/tests/messages to sha256 :no_check
2014-05-08 08:53:56 -04:00
Roland Walker c436ddc5fd transition docs/tests/messages to sha256 :no_check
`sha256 :no_check` has been supported syntax for a couple of months,
and now is being transitioned to the preferred syntax, replacing
the `no_checksum` stanza (which will still be supported, but
deprecated)
2014-05-08 08:42:44 -04:00
Kevin Kaland 7e47c36e7c Clarify additional URL Stanza parameters. 2014-05-08 14:13:45 +02:00
Roland Walker 89082904c4 cut v0.35.0 2014-05-08 07:48:34 -04:00
Roland Walker 4f82dda065 Merge pull request #4242 from rolandwalker/cat_documentation
update docs and messages for `brew cask cat`
2014-05-07 22:34:07 -04:00
Roland Walker e910467b39 update docs and messages for `brew cask cat` 2014-05-07 10:32:15 -04:00
Roland Walker d36336fa18 doc: "Cask definition file", not "Caskfile"
"Caskfile" is used in `AUTOMATION.md` by analogy to Brewfile
2014-05-07 10:31:29 -04:00
Roland Walker 085b29fa10 Merge pull request #4107 from ndr-qef/patch-1
Document preference for https over http
2014-05-06 09:57:26 -04:00
Roland Walker d37a10ed96 document Tap migration
The change to the main README should be temporary (two weeks?).
2014-05-05 10:30:51 -04:00
Paul Hinze 767be2b4b0 cut v0.34.0 2014-05-04 18:53:58 -05:00
Paul Hinze f54eaf7082 update all references to new caskroom org home
global replace of:
  'phinze/homebrew-cask' -> 'caskroom/homebrew-cask'
  'phinze/cask' -> 'caskroom/cask'
  'phinze/homebrew-testcasks' -> 'caskroom/homebrew-testcasks'

and various other specific places that needed updates

<3 the homebrew-cask community!
2014-05-03 10:29:17 -05:00
ndr 401fb56088 Document preference for https over http 2014-04-29 23:57:53 +02:00
Roland Walker 90bba2cf00 cut v0.33.1 2014-04-29 09:49:12 -04:00
Jean-Christophe GAY 34e62f08bf Use new taps directory structure in documentation
Replace /Library/Taps/phinze-cask/ by /Library/Taps/phinze/homebrew-cask/
2014-04-27 09:43:53 +02:00
Roland Walker 1f69c04cd6 cut v0.33.0 2014-04-26 09:59:40 -04:00
Matti Schneider 1387bded24 Correct `uninstall` stanza documentation
The `pkgutil` option can take strings as parameters
2014-04-21 12:34:53 +02:00
Roland Walker af3fe61ae5 cut v0.32.0 2014-03-29 09:04:25 -04:00
Roland Walker 0652a39eb8 Merge pull request #3700 from rolandwalker/assistive_devices_caveat
add `assistive_devices` to `caveats` DSL
2014-03-28 09:33:00 -04:00
Roland Walker af103f1486 add `zsh_path_helper` to `caveats` DSL
Per discussion in #3597 and Homebrew/homebrew#25719
2014-03-27 09:42:33 -04:00
Roland Walker 9554b58245 add `assistive_devices` to `caveats` DSL
Inspired by #3695
2014-03-27 09:41:20 -04:00
Roland Walker 0938a9d862 cut v0.31.1 2014-03-17 10:11:50 -04:00
Roland Walker 008b96353d cut v0.31.0 2014-03-15 10:30:37 -04:00
Roland Walker 58db20192f Merge pull request #3443 from rolandwalker/cask_namer
devscript: add `cask_namer`
2014-03-10 10:33:23 -04:00
Roland Walker c4f059c1f1 Merge pull request #3422 from pedros/curl-post-download-strategy
add new CurlPostDownloadStrategy
2014-03-10 09:08:50 -04:00
Roland Walker fb8c367fb4 Merge pull request #3441 from rolandwalker/devscript_pkgs_matching_regexp
devscript: add list_pkg_ids_by_regexp
2014-03-08 07:14:30 -05:00
Davor Cubranic a113bb1478 Fix links to other doc pages 2014-03-07 15:14:04 -08:00
Pedro Silva e58f3f89ca add new CurlPostDownloadStrategy
- lib/cask/url.rb: initialize(): add new `:data` attribute to hold post parameters
- lib/cask/download.rb: perform(): dispatch to new class based on `:using => :post`
- lib/cask/download_strategy.rb: Cask::CurlPostDownloadStrategy:
  			extend curl_args with x-www-form-urlencoded data
- doc/CASK_LANGUAGE_REFERENCE.md: HTTP URLs: document new strategy
- test/cask/test_download_strategy.rb: Cask::CurlPostDownloadStrategy: test new strategy
2014-03-07 20:51:35 +01:00
Roland Walker 99ecfc3651 devscript: add `cask_namer`
This script implements naming rules for App-based Casks
as currently documented.  After some real-world testing, this
logic should be merged into `brew cask create`.  This commit adds
`doc/CASK_NAMING_REFERENCE.md`, and reduces `CONTRIBUTING.md` by
422 words.
2014-03-07 13:43:40 -05:00
Roland Walker af009793a1 devscript: add list_pkg_ids_by_regexp
Inspired by @alebcay in #3431 .
2014-03-07 09:58:25 -05:00
Roland Walker bc6306135c Merge pull request #3364 from rolandwalker/doc_demote_faq
demote FAQ.md to doc directory
2014-03-04 19:00:42 -05:00
Roland Walker bf6ce149cf Merge pull request #3217 from rolandwalker/multiple_args_to_pkgutil
accept multiple arguments to uninstall/:pkgutil
2014-03-04 10:30:00 -05:00
ndr 5e879f83d6 Complete example in automation docs 2014-03-04 12:07:50 +01:00
Roland Walker 655f50b064 cut v0.30.1 2014-03-02 10:30:23 -05:00
Roland Walker 8feb7e8495 cut v0.30.0 2014-03-01 12:30:17 -05:00
Roland Walker e37b76edbd regenerate man page for 0.30.0 release 2014-03-01 12:07:16 -05:00
Roland Walker 662b49a463 fix broken merge in man page 2014-03-01 12:05:41 -05:00
Roland Walker f5078b03fb demote FAQ.md to doc directory
This doc currently has very little content.  Also fix link
text for other content in the doc directory.
2014-03-01 08:24:24 -05:00
Roland Walker 8f7036743a Merge pull request #3293 from ndr-qef/doc-automation
Add docs for Caskfiles and automation
2014-03-01 06:23:51 -05:00
ndr 878e1f2619 Add dotfiles section to Caskfile docs 2014-03-01 05:29:07 +01:00
ndr 94170eba2e Add docs for Caskfiles 2014-03-01 05:21:10 +01:00
Roland Walker a25469434d accept multiple arguments to uninstall/:pkgutil
We may as well do so, the previous behavior was a bug:
multiple elements were silently concatenated into a single
regexp.
2014-02-26 07:21:18 -05:00
Roland Walker bf49dc9fa8 ability to specify container type, not detect
Fixes #2997.  Interface is optional DSL stanza `container_type`.
This should only be used in rare instances.  It is needed for the
case of a naked executable which should not be unpacked.
2014-02-25 16:39:12 -05:00
Võ Anh Duy 33a97a1a5f CLI - Fetch
Add `fetch` command to cli like suggestion at the end of #2528
2014-02-26 00:44:22 +07:00
Roland Walker 22e24ea5c5 Merge pull request #3131 from rolandwalker/cmd_aliases
provide command aliases to match Homebrew
2014-02-25 12:29:22 -05:00
Roland Walker 619a82335e Merge pull request #3137 from rolandwalker/doc_contributing_ref_followup
doc: expand CASK_LANGUAGE_REFERENCE, shrink CONTRIBUTING
2014-02-25 06:06:54 -05:00
Roland Walker 45d72b8838 Merge pull request #3079 from rolandwalker/brew_cask_update
make `brew cask update` synonym for `brew update`
2014-02-24 19:08:02 -05:00
Roland Walker de7a8cdcc9 doc: expand CASK_LANGUAGE_REF, shrink CONTRIBUTING
following up on #3094
- rename `THE_CASK_LANGUAGE.md` to `CASK_LANGUAGE_REFERENCE.md`
- expand `CASK_LANGUAGE_REFERENCE.md` to more fully specify the Cask DSL
- add sections: "Casks Are Ruby Classes" and "The Cask Language Is Declarative"
- import content from `FAQ.md` to `CASK_LANGUAGE_REFERENCE.md`, create multiple sections
  listing all stanzas according to category.
- document which stanzas are permitted multiple times
- add previously undocumented `before_install` and `before_uninstall`
- doc that `Hardware::CPU.is_64_bit?` (and 32-bit) are acceptable in conditionals
- doc that `:target` may contain an absolute path (this works more reliably after #3075)
- doc that `uninstall` is optional in the DSL, but required by the community
- link examples
- standardize mixed language on "stanza" over "field"
- further shrink `CONTRIBUTING.md` by deleting rarely used stanzas
  and referencing `CASK_LANGUAGE_REFERENCE.md`
2014-02-24 15:49:37 -05:00
Roland Walker 4fcdab0583 provide command aliases to match Homebrew
fixes #2969
2014-02-24 08:15:52 -05:00
Roland Walker 9dad8600a3 shrink CONTRIBUTING.md to 1/4 its current size
Rationale:
- lengthy CONTRIBUTING.md may itself discourage new Cask authors
- it is doubtful that everyone reads to the end, where there
  are important notes about squashing.

CONTRIBUTING.md reduced from 7947 words to 1927 words.

This was accomplished principally by spinning out "details" sections
into a new reference file `doc/THE_CASK_LANGUAGE.md`, but also by
ruthless re-organization, removal of duplication, and trimming of
phrases. Content remains 99% identical, though a few typos were
caught along the way, and a table of contents was added.
2014-02-22 14:51:55 -05:00
Roland Walker 55e9cfc39d make `brew cask update` synonym for `brew update`
for convenience/typo
2014-02-21 10:23:16 -05:00
Roland Walker b7dcd35dab move HACKING.md and CHANGELOG.md to doc subdir 2014-02-20 19:17:02 -05:00
Roland Walker 2cf12c2c8b doc format nits noticed doing 0.29.2 release 2014-02-19 11:55:34 -05:00
Roland Walker 74fadd0ac8 devscript: add bump_version script for releasing 2014-02-15 10:53:52 -05:00
Roland Walker bd66e1f375 revise RELEASING.md after cutting v0.29.0
and move it into doc subdirectory
2014-02-15 09:51:55 -05:00
Roland Walker 6815a6188f recompile manpage with updates 2014-02-15 07:59:10 -05:00
Roland Walker d6c8a6917d add command `brew cask cleanup`
plus new option --outdated
2014-02-08 14:40:53 -05:00
Roland Walker ceb727b06b add man page brew-cask.1 2014-01-31 12:50:42 -05:00