Commit graph

240 commits

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