Commit graph

187 commits

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