Commit Graph

302 Commits

Author SHA1 Message Date
Roland Walker cdede4aa24 Merge pull request #4996 from rolandwalker/releasing_tweaks
updates to release process after v0.37.0
2014-06-20 06:00:58 -04:00
Roland Walker bd6ebf85a4 doc: tracker symlinks are in download cache
At least mention tracker symlinks in the docs, since they
are displayed in the feedback messages.

References: #4995
2014-06-19 17:46:17 -04:00
Roland Walker 8e8e6399fd updates to release process after v0.37.0 2014-06-19 16:42:25 -04:00
Roland Walker e61f297f9d cut v0.37.0 2014-06-19 15:38:38 -04:00
Roland Walker 2ffee346df standardize the recommended upgrade command
in both docs and error messages.

Recent bug reports indicate that `cleanup` commands are essential
in some situations.
2014-06-18 15:15:50 -04:00
Roland Walker 6fcf62e6aa Merge pull request #4924 from rolandwalker/suggested_stanza_order
suggested (not enforced) order for Cask stanzas
2014-06-17 05:57:29 -04:00
Roland Walker c02ff61e74 Merge pull request #4926 from rolandwalker/doc_lang_ref_tweaks
doc tweaks to CASK_LANGUAGE_REFERENCE.md
2014-06-17 05:45:54 -04:00
Roland Walker 93617b1286 Merge pull request #4925 from rolandwalker/doc_ruby_interpreter_vsn
doc latest Ruby interpreter situation in HACKING.md
2014-06-16 18:05:15 -04:00
Roland Walker 5b64813420 doc tweaks to CASK_LANGUAGE_REFERENCE.md
- include OS X 10.10
- include the word "specification"
- clarify how to call out of the `caveats` mini-DSL

References: #4921, though `version` is being added to the
`caveats` mini-DSL
2014-06-16 15:32:58 -04:00
Roland Walker 3cb729095d suggested (not enforced) order for Cask stanzas
References: #4914
2014-06-16 13:32:08 -04:00
Roland Walker 2bfa4e554a add `version` helper method to `caveats` mini-DSL
As was already done (for convenience) for `title`.

References: #4921 .
2014-06-16 12:56:31 -04:00
Roland Walker b4761dd4a8 doc latest Ruby interpreter in HACKING.md
- Homebrew recently changed to Ruby 2.0 on some systems
- doc that we inherit the interpreter from Homebrew
2014-06-16 12:48:26 -04:00
Roland Walker d266826669 Merge pull request #4911 from vitorgalvao/cosmetic-changes-alternate-taps-doc
Cosmetic changes to ALTERNATE_CASK_TAPS documentation
2014-06-16 07:42:34 -04:00
Roland Walker e6ce577429 Merge pull request #4913 from radeksimko/x11-doc
Mention x11_required caveat in docs
2014-06-16 07:26:13 -04:00
Radek Simko 55b5f6ceea Mention x11_required caveat in docs 2014-06-15 20:17:31 +01:00
Vítor Galvão ba7d3c08b4 changed footnote syntax in alternate taps doc 2014-06-15 17:58:29 +01:00
Vítor Galvão 8d4b731d21 All bulletpoints now start with a capital letter in alternate taps doc 2014-06-15 17:57:50 +01:00
Roland Walker 266b22d47f Merge pull request #4884 from rolandwalker/doc_upgrade_progress
update HACKING.md re: upgrade verb
2014-06-14 18:16:21 -04:00
Roland Walker 7ec9698091 Merge pull request #4875 from laurent22/patch-1
Added two more questions / answers
2014-06-14 14:30:34 -04:00
Laurent 8a7ca82894 Added two more questions / answers
Added QAs regarding localized versions and auto-updated applications.
2014-06-14 13:57:57 -03:00
Roland Walker 8d123a0cad update HACKING.md re: upgrade verb 2014-06-14 08:37:03 -04:00
Roland Walker 3f4f6580e0 cut v0.36.2 2014-06-14 08:19:00 -04:00
Roland Walker 25d0e65713 put gpsbabel utility function inside namespace
and document the conventions for doing so
2014-06-12 10:52:03 -04:00
Roland Walker 4652e8bbcb cut v0.36.1 2014-06-11 12:47:13 -04:00
Roland Walker 833176d9d9 Merge pull request #4807 from rolandwalker/allow_full_path_troubleshooting
Allow invocation of subcommand with full paths
2014-06-10 18:22:20 -04:00
Roland Walker 231f3cd92a Allow invocation of subcommand with full paths
Full paths to subcommand source and Ruby may be given,
which is helpful in troubleshooting, particularly for
forcing a specific Ruby version.

Example usage:
```bash
$ HOMEBREW_BREW_FILE=/usr/local/bin/brew /System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/bin/ruby /usr/local/Library/brew.rb /usr/local/bin/brew-cask.rb help
```

Previously, this would work, but throw an odd error when
returning to Homebrew.  Fix: we unconditionally do not
return to Homebrew.
2014-06-10 16:36:47 -04:00
Roland Walker b7cf18c139 document signal severity 2014-06-10 10:55:13 -04:00
Roland Walker 4bf7d5bdc6 cut v0.36.0 2014-06-07 18:02:33 -04: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
Roland Walker cf89f7f7e8 regularize whitespace 2014-06-07 11:43:40 -04: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
Roland Walker e7a01deb4d devscript: add `list_url_attributes_on_file`
Uses OS X extended attributes (via `xattr`) to find the source
of a downloaded file.
2014-06-06 20:53:26 -04:00
Roland Walker 0ef4606e0c retire support for `no_checksum` stanza 2014-06-04 23:26:09 -04:00
Roland Walker d3e2c477ee doc: we now have user-maintained alt Cask Taps 2014-06-03 11:58:57 -04:00
Roland Walker ebc64b8fcf Merge pull request #4608 from rolandwalker/doc_alt_cask_taps
document how to create alternate Cask Taps
2014-06-02 08:41:25 -04:00
Roland Walker b41b364d85 document how to create alternate Cask Taps
closes #3954
2014-06-02 08:40:47 -04:00
Roland Walker 19fb223bae doc: tweak version numbers needed for migration 2014-05-31 10:29:16 -04:00
Roland Walker b38d6a6977 add `:signal` directive for `uninstall`
to send arbitrary Unix signals.  Per discussion in #4328, some
processes are resistant to the `:quit` directive, and can be
made to shut down via a signal.
2014-05-13 13:04:10 -04:00
Roland Walker 1b0ef14e3b update TAP_MIGRATION.md based on recent reports
from IRC and GitHub issues.  Closes #4312
2014-05-12 08:20:38 -04:00
Roland Walker 60ba164c1b Merge pull request #4299 from rolandwalker/expand_plus
expand the `+` symbol in Cask names
2014-05-09 16:26:10 -04:00
Roland Walker e8c73b7b66 expand the `+` symbol in Cask names
closes #4275. references discussion in #4106.
2014-05-09 09:32:47 -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 cfc6ae7a13 Merge pull request #4264 from rolandwalker/retire_sha1
Retire support for `sha1` stanza.
2014-05-08 18:37:00 -04:00
Roland Walker 34df5309d4 Retire support for `sha1` stanza.
We haven't received new submissions using `sha1` for quite
some time.
2014-05-08 12:01:32 -04:00
Kevin Kaland 77d165d938 Improve readability of documentation change.
Markdoooooown!!!!
2014-05-08 15:00:25 +02:00
Roland Walker 635cd7c676 Merge pull request #4257 from rolandwalker/convert_no_checksum_1
transition docs/tests/messages to sha256 :no_check
2014-05-08 08:53:56 -04: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
Kevin Kaland 7e47c36e7c Clarify additional URL Stanza parameters. 2014-05-08 14:13:45 +02:00
Roland Walker 89082904c4 cut v0.35.0 2014-05-08 07:48:34 -04:00
Roland Walker 4f82dda065 Merge pull request #4242 from rolandwalker/cat_documentation
update docs and messages for `brew cask cat`
2014-05-07 22:34:07 -04:00
Roland Walker e910467b39 update docs and messages for `brew cask cat` 2014-05-07 10:32:15 -04:00
Roland Walker d36336fa18 doc: "Cask definition file", not "Caskfile"
"Caskfile" is used in `AUTOMATION.md` by analogy to Brewfile
2014-05-07 10:31:29 -04:00
Roland Walker 085b29fa10 Merge pull request #4107 from ndr-qef/patch-1
Document preference for https over http
2014-05-06 09:57:26 -04:00
Roland Walker d37a10ed96 document Tap migration
The change to the main README should be temporary (two weeks?).
2014-05-05 10:30:51 -04:00
Paul Hinze 767be2b4b0 cut v0.34.0 2014-05-04 18:53:58 -05: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
ndr 401fb56088 Document preference for https over http 2014-04-29 23:57:53 +02:00
Roland Walker 90bba2cf00 cut v0.33.1 2014-04-29 09:49:12 -04: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 1f69c04cd6 cut v0.33.0 2014-04-26 09:59:40 -04:00
Matti Schneider 1387bded24 Correct `uninstall` stanza documentation
The `pkgutil` option can take strings as parameters
2014-04-21 12:34:53 +02:00
Roland Walker af3fe61ae5 cut v0.32.0 2014-03-29 09:04:25 -04:00
Roland Walker 0652a39eb8 Merge pull request #3700 from rolandwalker/assistive_devices_caveat
add `assistive_devices` to `caveats` DSL
2014-03-28 09:33:00 -04:00
Roland Walker af103f1486 add `zsh_path_helper` to `caveats` DSL
Per discussion in #3597 and Homebrew/homebrew#25719
2014-03-27 09:42:33 -04:00
Roland Walker 9554b58245 add `assistive_devices` to `caveats` DSL
Inspired by #3695
2014-03-27 09:41:20 -04:00
Roland Walker 0938a9d862 cut v0.31.1 2014-03-17 10:11:50 -04:00
Roland Walker 008b96353d cut v0.31.0 2014-03-15 10:30:37 -04:00
Roland Walker 58db20192f Merge pull request #3443 from rolandwalker/cask_namer
devscript: add `cask_namer`
2014-03-10 10:33:23 -04:00
Roland Walker c4f059c1f1 Merge pull request #3422 from pedros/curl-post-download-strategy
add new CurlPostDownloadStrategy
2014-03-10 09:08:50 -04:00
Roland Walker fb8c367fb4 Merge pull request #3441 from rolandwalker/devscript_pkgs_matching_regexp
devscript: add list_pkg_ids_by_regexp
2014-03-08 07:14:30 -05:00
Davor Cubranic a113bb1478 Fix links to other doc pages 2014-03-07 15:14:04 -08:00
Pedro Silva e58f3f89ca add new CurlPostDownloadStrategy
- lib/cask/url.rb: initialize(): add new `:data` attribute to hold post parameters
- lib/cask/download.rb: perform(): dispatch to new class based on `:using => :post`
- lib/cask/download_strategy.rb: Cask::CurlPostDownloadStrategy:
  			extend curl_args with x-www-form-urlencoded data
- doc/CASK_LANGUAGE_REFERENCE.md: HTTP URLs: document new strategy
- test/cask/test_download_strategy.rb: Cask::CurlPostDownloadStrategy: test new strategy
2014-03-07 20:51:35 +01: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 af009793a1 devscript: add list_pkg_ids_by_regexp
Inspired by @alebcay in #3431 .
2014-03-07 09:58:25 -05:00
Roland Walker bc6306135c Merge pull request #3364 from rolandwalker/doc_demote_faq
demote FAQ.md to doc directory
2014-03-04 19:00:42 -05:00
Roland Walker bf6ce149cf Merge pull request #3217 from rolandwalker/multiple_args_to_pkgutil
accept multiple arguments to uninstall/:pkgutil
2014-03-04 10:30:00 -05:00
ndr 5e879f83d6 Complete example in automation docs 2014-03-04 12:07:50 +01:00
Roland Walker 655f50b064 cut v0.30.1 2014-03-02 10:30:23 -05:00
Roland Walker 8feb7e8495 cut v0.30.0 2014-03-01 12:30:17 -05:00
Roland Walker e37b76edbd regenerate man page for 0.30.0 release 2014-03-01 12:07:16 -05:00
Roland Walker 662b49a463 fix broken merge in man page 2014-03-01 12:05:41 -05:00
Roland Walker f5078b03fb demote FAQ.md to doc directory
This doc currently has very little content.  Also fix link
text for other content in the doc directory.
2014-03-01 08:24:24 -05:00
Roland Walker 8f7036743a Merge pull request #3293 from ndr-qef/doc-automation
Add docs for Caskfiles and automation
2014-03-01 06:23:51 -05:00
ndr 878e1f2619 Add dotfiles section to Caskfile docs 2014-03-01 05:29:07 +01:00
ndr 94170eba2e Add docs for Caskfiles 2014-03-01 05:21:10 +01:00
Roland Walker a25469434d accept multiple arguments to uninstall/:pkgutil
We may as well do so, the previous behavior was a bug:
multiple elements were silently concatenated into a single
regexp.
2014-02-26 07:21:18 -05:00
Roland Walker bf49dc9fa8 ability to specify container type, not detect
Fixes #2997.  Interface is optional DSL stanza `container_type`.
This should only be used in rare instances.  It is needed for the
case of a naked executable which should not be unpacked.
2014-02-25 16:39:12 -05:00
Võ Anh Duy 33a97a1a5f CLI - Fetch
Add `fetch` command to cli like suggestion at the end of #2528
2014-02-26 00:44:22 +07:00
Roland Walker 22e24ea5c5 Merge pull request #3131 from rolandwalker/cmd_aliases
provide command aliases to match Homebrew
2014-02-25 12:29:22 -05:00
Roland Walker 619a82335e Merge pull request #3137 from rolandwalker/doc_contributing_ref_followup
doc: expand CASK_LANGUAGE_REFERENCE, shrink CONTRIBUTING
2014-02-25 06:06:54 -05:00
Roland Walker 45d72b8838 Merge pull request #3079 from rolandwalker/brew_cask_update
make `brew cask update` synonym for `brew update`
2014-02-24 19:08:02 -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 4fcdab0583 provide command aliases to match Homebrew
fixes #2969
2014-02-24 08:15:52 -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
Roland Walker 55e9cfc39d make `brew cask update` synonym for `brew update`
for convenience/typo
2014-02-21 10:23:16 -05:00
Roland Walker b7dcd35dab move HACKING.md and CHANGELOG.md to doc subdir 2014-02-20 19:17:02 -05:00
Roland Walker 2cf12c2c8b doc format nits noticed doing 0.29.2 release 2014-02-19 11:55:34 -05:00
Roland Walker 74fadd0ac8 devscript: add bump_version script for releasing 2014-02-15 10:53:52 -05:00
Roland Walker bd66e1f375 revise RELEASING.md after cutting v0.29.0
and move it into doc subdirectory
2014-02-15 09:51:55 -05:00
Roland Walker 6815a6188f recompile manpage with updates 2014-02-15 07:59:10 -05:00
Roland Walker d6c8a6917d add command `brew cask cleanup`
plus new option --outdated
2014-02-08 14:40:53 -05:00
Roland Walker ceb727b06b add man page brew-cask.1 2014-01-31 12:50:42 -05:00