Commit graph

140 commits

Author SHA1 Message Date
Roland Walker
41cf7d96f0 docs and tests for new form container :nested 2014-10-09 11:34:37 -04:00
Roland Walker
0320569e87 generalize section on Dropbox URLs
and explain why they should be avoided
2014-10-09 07:50:51 -04:00
Roland Walker
309980bb86 doc re: fosshub and dropbox URLs
* fosshub URLs are blocked (per email correspondence)
  all similar providers cannot be used in Casks.
* shorten dropbox text
2014-10-08 09:26:55 -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
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
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
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
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
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
8491b10186 Merge pull request #6150 from vitorgalvao/change-vagrant-examples
replaced vagrant with unity in examples referencing the pkg
2014-09-11 20:24:26 +01:00
Vítor Galvão
be96758d83 Changed Firefox to Firefox.app in CONTRIBUTING, for consistency with other examples. 2014-09-11 20:15:06 +01:00
Vítor Galvão
e8ac96693e replaced vagrant with unity in examples referencing the pkg 2014-09-11 20:09:24 +01:00
Trey Harris
46a9b82283 CONTRIBUTING.md: Adding unversioned Cask info
The docs seemed to suggest that if versioned downloads were available,
to prefer them over unversioned ones. Since that's incorrect presently,
I attempted to correct that (see #6126 for more details).
2014-09-11 15:05:07 -04:00
Roland Walker
cfd6bd003e doc nits re: caveats. Broken anchor link. 2014-09-11 10:50:27 -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
Martin madsen
e4e47b3f5d Fix markdown link in CONTRIBUTING.md
Added a missing closing parentheses.
2014-07-29 14:02:08 +02:00
Radek Simko
cec19153ff Typos and facts about how to use 2FA fixed 2014-07-13 23:26:34 +01:00
Alex Barclay
54da9567bf Add push cask info for github 2 factor auth 2014-07-09 16:21:40 -05:00
ndr
797344bc18 Docs: admit unstable releases in main repo 2014-07-03 22:27:50 +02:00
Roland Walker
3cb729095d suggested (not enforced) order for Cask stanzas
References: #4914
2014-06-16 13:32:08 -04:00
Vítor Galvão
9e96d5afda Document policy on trial versions
Pinging @rolandwalker to sign off on the wording.
2014-06-09 00:30:45 +01: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
Radek Simko
d2efc5e520 Note about Dropbox URLs added 2014-06-07 17:02:37 +01: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
Vítor Galvão
112964ca7f changed mentions of 'brew --prefix' to 'brew --repository' 2014-05-09 01:02:48 +01: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
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
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
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
0c576a6012 doc: prepend vendor names to disambiguate
note as well that Casks which differ only by placement
of hyphens are somewhat ambiguous and to be avoided.
2014-03-04 08:37:25 -05:00
Roland Walker
83b8431b1d Merge pull request #3285 from rolandwalker/doc_cask_name_drop_version
doc: drop version numbers from end of Cask names
2014-03-01 06:48:39 -05:00
Roland Walker
c0f434c76d doc: drop version numbers from end of Cask names 2014-02-28 11:41:33 -05:00
Roland Walker
2375c10504 doc: tweaks to CONTRIBUTING.md
- subheads so we can link directly to CONTRIBUTING.md#cask-stanzas
- clarification on naming `pkg` Casks
- fix repetitive language
2014-02-28 09:14:58 -05:00
Roland Walker
30dab022e7 Drop generic terms from ends of Canonical name 2014-02-27 08:33:23 -05:00
Roland Walker
dd88c5efcb Merge pull request #3175 from rolandwalker/doc_cask_name_drop_characters
drop non-alpnanumeric chars from Canonical Name
2014-02-27 08:05:26 -05:00
Roland Walker
b5f8fd0ca3 doc that vendor/upstream URLs are preferred
(unfortunately adding words to CONTRIBUTING.md again)
2014-02-26 06:42:56 -05:00
Roland Walker
8d8493b26e drop non-alpnanumeric chars from Canonical Name
following up on #2659, further steps toward an algorithmic
derivation of Canonical Name from App Name.

Also add two rules about hyphens which are implied and already
followed by every Cask.
2014-02-25 08:37:31 -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
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
Paul Hinze
73d0273b98 Merge pull request #3067 from rolandwalker/organize_docs
move HACKING.md and CHANGELOG.md to doc subdir
2014-02-21 15:35:58 -06:00
Caleb Xu
beab539ca3 Added clause about cases with no available stable versions 2014-02-20 21:42:29 -05:00
Roland Walker
b7dcd35dab move HACKING.md and CHANGELOG.md to doc subdir 2014-02-20 19:17:02 -05:00
Caleb Xu
6c6f07c8bf Added ## Finding a Home For Your Cask
Explains the alternate `caskroom` repositories and what belongs there.
2014-02-19 16:53:05 -05:00
Roland Walker
763bbfbc2e Merge pull request #2659 from rolandwalker/cask_naming_1
doc: Canonical name == App bundle name
2014-02-19 09:52:46 -05:00
Roland Walker
fbcbcd21be Merge pull request #2761 from rolandwalker/private_eye_followups
sleep during uninstall, allow `:must_succeed`
2014-02-15 07:44:33 -05:00
Roland Walker
b023953def document Subversion URLs
lightly re-org the URL Details section
2014-02-14 21:26:53 -05:00
Roland Walker
45ed67c64f add :allow_untrusted modifier on install 2014-02-11 14:40:16 -05:00
Roland Walker
273a9d95b3 devscript: add command list_payload_in_pkg 2014-02-10 10:47:12 -05:00
Roland Walker
de78b0f359 sleep during uninstall, allow :must_succeed
on script directives. followups from #1802. amend private-eye Cask.
2014-02-08 16:15:15 -05:00