Commit Graph

493 Commits

Author SHA1 Message Date
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