Commit Graph

209 Commits

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