9568ac55e2
Merge pull request #6384 from ndr-qef/docs/hacking
...
Review HACKING docs
2014-09-29 20:27:48 +02:00
74fc49a1a7
Revert "WIP Review HACKING docs"
2014-09-29 14:08:18 -04:00
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
dabdd2d201
Merge pull request #6342 from ndr-qef/docs/hacking
...
Review HACKING docs
2014-09-29 14:04:20 -04:00
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
8501332abf
Merge pull request #6362 from rolandwalker/doc_tables
...
doc nits: table order, table format, whitespace
2014-09-27 20:20:41 +02:00
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
019b412713
simplify RELEASING.md a bit
2014-09-27 13:26:56 -04:00
077a8514fe
cut v0.43.0
2014-09-27 13:18:00 -04:00
0b22bbf3a5
doc followup: missing deprecations
2014-09-18 07:36:38 -04:00
568365194d
Merge pull request #6227 from rolandwalker/doc_uninstall_delete
...
doc/tests switchover to `uninstall :delete`
2014-09-18 06:25:59 -04:00
0b4ad8714b
doc/tests switchover to `uninstall :delete`
...
from `uninstall :files`
2014-09-17 10:41:10 -04:00
28217a5b77
cut v0.42.0
2014-09-17 09:45:32 -04:00
d9fe7a9c17
Merge pull request #6225 from rolandwalker/add_artifact_stanza
...
DSL: add `artifact` stanza
2014-09-17 09:35:53 -04:00
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
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
fe0a053dad
Merge pull request #6208 from rolandwalker/uninstall_force
...
add `--force` option for `brew cask uninstall`
2014-09-16 19:33:17 -04:00
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
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
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
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
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
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
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
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
d2ba4fdf4d
cut v0.41.1
2014-09-13 12:49:30 -04:00
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
35671e5900
restore `pkg` to cask_language_deltas.md
...
was deleted due to merge error in #6138
2014-09-13 10:09:16 -04:00
dfcbd7154e
docs, error msgs, tests for depends_on :formula
...
replacing depends_on_formula in DSL
2014-09-11 20:33:39 -04:00
2e5fcfbde0
Merge pull request #6141 from rolandwalker/doc_pkgutil_uninstall
...
doc: highlight `:pkgutil`
2014-09-11 20:23:16 -04:00
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
e8ac96693e
replaced vagrant with unity in examples referencing the pkg
2014-09-11 20:09:24 +01:00
113f02dd43
doc: highlight `:pkgutil`
...
As the most-important `uninstall` directive
2014-09-11 11:15:58 -04:00
cfd6bd003e
doc nits re: caveats. Broken anchor link.
2014-09-11 10:50:27 -04:00
719bb998ed
cut v0.41.0
2014-09-11 10:08:43 -04:00
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
ab4f52a781
docs and error messages for new DSL stanza `pkg`
...
transition from `install` to `pkg`
2014-09-10 10:54:06 -04:00
5104f9a3d4
Merge pull request #6094 from rolandwalker/doc_ls_long
...
document new option brew cask ls -l
2014-09-09 20:44:59 +02:00
868ed811b7
document new option brew cask ls -l
2014-09-09 07:05:31 -04:00
58a4c1092d
rename delta file and update transition docs
...
requires #6074 (may show merge conflict)
2014-09-08 20:37:42 -04:00
0bc6cc4cf3
Merge pull request #6073 from rolandwalker/releasing_updates_0.40.0
...
updates to release process after v0.40.0
2014-09-08 17:38:02 -04:00
28c2c1106a
transition: doc preflight/postflight stanzas
...
a mass change to Casks to come later
2014-09-08 11:47:59 -04:00
4ecc1b97dc
Merge pull request #6072 from rolandwalker/dsl_transition_doc
...
doc: first changes for DSL 1.0
2014-09-08 11:30:05 -04:00
b93206093a
updates to release process after v0.40.0
2014-09-08 11:24:38 -04:00
a38ec50a3b
doc: first changes for DSL 1.0
...
Do not revert this PR after the transition period. It contains
a README banner which needs to be deleted later, but also a
persistent doc file and an unrelated whitespace nit.
2014-09-08 10:48:39 -04:00
92e15b4a91
cut v0.40.0
2014-09-08 10:28:31 -04:00
1b05d18a3b
add support for internet_plugin artifact
...
closes #5909
2014-08-26 11:22:25 -04:00
615f895a1c
updates to release procedure after v0.39.3
2014-08-13 08:26:26 -04:00
99e75bddfd
cut v0.39.3
2014-08-13 07:47:41 -04:00
906aa4e167
Merge pull request #5750 from rolandwalker/release_process_updates
...
minor amendments to release process/changelog
2014-08-12 16:09:43 -04:00
38adf8b021
Merge pull request #5729 from rolandwalker/doc_list_1
...
document new option `brew cask list -1`
2014-08-12 09:58:45 -04:00
5faacd885a
minor amendments to release process/changelog
...
based on lessons learned from failed release v0.39.0,
`git push && git push --follow-tags` is smarter because
it reduces the chance of an unreleasable tag being pushed.
(git pushes the tags before it pushes the commits).
2014-08-12 09:00:49 -04:00
b65c4963ea
cut v0.39.2
2014-08-12 08:17:12 -04:00
e86e94f6d3
cut v0.39.1
2014-08-12 07:36:38 -04:00
029907a875
document new option `brew cask list -1`
...
References: #5699
2014-08-11 10:07:18 -04:00
7a58fdaeca
doc: preferred conditional structure
...
latest OS version or hardware should be the default case
2014-08-09 12:43:16 -04:00
99d001afa4
add support for xar containers
...
references: #5442
2014-08-02 14:51:51 -04:00
6f34db7dfd
doc updated valid values for container_type
2014-08-02 11:19:39 -04:00
0c609fbfe6
cut v0.38.1
2014-07-31 09:24:45 -04:00
a2eae68b03
Merge pull request #5542 from rolandwalker/remove_migration_banner
...
Move the Tap Migration banner from README.md to FAQ.md
2014-07-28 17:40:05 -04:00
219ce8feee
doc: changelog glitch
2014-07-28 15:16:54 -04:00
30296d5ded
cut v0.38.0
2014-07-28 15:13:12 -04:00
bfd88bc5af
Move the Tap Migration banner from README to FAQ
...
We have not seen an issue filed on this in some time.
2014-07-28 14:33:00 -04:00
fb13db0e98
fix missing changelog entries for 0.37.1
2014-06-25 20:50:59 -04:00
29a6a1ec10
Extend subcommand dispatch to include full paths
...
Covering all cases
- external commands as executables
- external commands as Ruby libraries
- built-in command verbs
This is intended as a development aid.
A side benefit is that an external command can be constructed
to use a `run` method, rather than having to accomplish everything
at `require` time.
2014-06-21 14:51:57 -04:00
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
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
8e8e6399fd
updates to release process after v0.37.0
2014-06-19 16:42:25 -04:00
e61f297f9d
cut v0.37.0
2014-06-19 15:38:38 -04:00
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
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
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
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
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
3cb729095d
suggested (not enforced) order for Cask stanzas
...
References: #4914
2014-06-16 13:32:08 -04:00
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
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
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
e6ce577429
Merge pull request #4913 from radeksimko/x11-doc
...
Mention x11_required caveat in docs
2014-06-16 07:26:13 -04:00
55b5f6ceea
Mention x11_required caveat in docs
2014-06-15 20:17:31 +01:00
ba7d3c08b4
changed footnote syntax in alternate taps doc
2014-06-15 17:58:29 +01:00
8d4b731d21
All bulletpoints now start with a capital letter in alternate taps doc
2014-06-15 17:57:50 +01:00
266b22d47f
Merge pull request #4884 from rolandwalker/doc_upgrade_progress
...
update HACKING.md re: upgrade verb
2014-06-14 18:16:21 -04:00
7ec9698091
Merge pull request #4875 from laurent22/patch-1
...
Added two more questions / answers
2014-06-14 14:30:34 -04:00
8a7ca82894
Added two more questions / answers
...
Added QAs regarding localized versions and auto-updated applications.
2014-06-14 13:57:57 -03:00
8d123a0cad
update HACKING.md re: upgrade verb
2014-06-14 08:37:03 -04:00
3f4f6580e0
cut v0.36.2
2014-06-14 08:19:00 -04:00
25d0e65713
put gpsbabel utility function inside namespace
...
and document the conventions for doing so
2014-06-12 10:52:03 -04:00
4652e8bbcb
cut v0.36.1
2014-06-11 12:47:13 -04:00
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
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
b7cf18c139
document signal severity
2014-06-10 10:55:13 -04:00
4bf7d5bdc6
cut v0.36.0
2014-06-07 18:02:33 -04:00
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
cf89f7f7e8
regularize whitespace
2014-06-07 11:43:40 -04:00
770643a5f7
Separate the HTTPS statement under one heading
...
also update examples to use HTTPS
2014-06-06 22:15:24 -04:00
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
0ef4606e0c
retire support for `no_checksum` stanza
2014-06-04 23:26:09 -04:00
d3e2c477ee
doc: we now have user-maintained alt Cask Taps
2014-06-03 11:58:57 -04:00
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
b41b364d85
document how to create alternate Cask Taps
...
closes #3954
2014-06-02 08:40:47 -04:00
19fb223bae
doc: tweak version numbers needed for migration
2014-05-31 10:29:16 -04:00
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
1b0ef14e3b
update TAP_MIGRATION.md based on recent reports
...
from IRC and GitHub issues. Closes #4312
2014-05-12 08:20:38 -04:00
60ba164c1b
Merge pull request #4299 from rolandwalker/expand_plus
...
expand the `+` symbol in Cask names
2014-05-09 16:26:10 -04:00
e8c73b7b66
expand the `+` symbol in Cask names
...
closes #4275 . references discussion in #4106 .
2014-05-09 09:32:47 -04:00
112964ca7f
changed mentions of 'brew --prefix' to 'brew --repository'
2014-05-09 01:02:48 +01:00
cfc6ae7a13
Merge pull request #4264 from rolandwalker/retire_sha1
...
Retire support for `sha1` stanza.
2014-05-08 18:37:00 -04:00
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
77d165d938
Improve readability of documentation change.
...
Markdoooooown!!!!
2014-05-08 15:00:25 +02:00
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
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
7e47c36e7c
Clarify additional URL Stanza parameters.
2014-05-08 14:13:45 +02:00
89082904c4
cut v0.35.0
2014-05-08 07:48:34 -04:00
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
e910467b39
update docs and messages for `brew cask cat`
2014-05-07 10:32:15 -04:00
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
085b29fa10
Merge pull request #4107 from ndr-qef/patch-1
...
Document preference for https over http
2014-05-06 09:57:26 -04:00
d37a10ed96
document Tap migration
...
The change to the main README should be temporary (two weeks?).
2014-05-05 10:30:51 -04:00
767be2b4b0
cut v0.34.0
2014-05-04 18:53:58 -05:00
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
401fb56088
Document preference for https over http
2014-04-29 23:57:53 +02:00
90bba2cf00
cut v0.33.1
2014-04-29 09:49:12 -04:00
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
1f69c04cd6
cut v0.33.0
2014-04-26 09:59:40 -04:00
1387bded24
Correct `uninstall` stanza documentation
...
The `pkgutil` option can take strings as parameters
2014-04-21 12:34:53 +02:00
af3fe61ae5
cut v0.32.0
2014-03-29 09:04:25 -04:00
0652a39eb8
Merge pull request #3700 from rolandwalker/assistive_devices_caveat
...
add `assistive_devices` to `caveats` DSL
2014-03-28 09:33:00 -04:00
af103f1486
add `zsh_path_helper` to `caveats` DSL
...
Per discussion in #3597 and Homebrew/homebrew#25719
2014-03-27 09:42:33 -04:00
9554b58245
add `assistive_devices` to `caveats` DSL
...
Inspired by #3695
2014-03-27 09:41:20 -04:00
0938a9d862
cut v0.31.1
2014-03-17 10:11:50 -04:00
008b96353d
cut v0.31.0
2014-03-15 10:30:37 -04:00
58db20192f
Merge pull request #3443 from rolandwalker/cask_namer
...
devscript: add `cask_namer`
2014-03-10 10:33:23 -04:00
c4f059c1f1
Merge pull request #3422 from pedros/curl-post-download-strategy
...
add new CurlPostDownloadStrategy
2014-03-10 09:08:50 -04:00
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
a113bb1478
Fix links to other doc pages
2014-03-07 15:14:04 -08:00
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
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
af009793a1
devscript: add list_pkg_ids_by_regexp
...
Inspired by @alebcay in #3431 .
2014-03-07 09:58:25 -05:00
bc6306135c
Merge pull request #3364 from rolandwalker/doc_demote_faq
...
demote FAQ.md to doc directory
2014-03-04 19:00:42 -05:00
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
5e879f83d6
Complete example in automation docs
2014-03-04 12:07:50 +01:00
655f50b064
cut v0.30.1
2014-03-02 10:30:23 -05:00
8feb7e8495
cut v0.30.0
2014-03-01 12:30:17 -05:00
e37b76edbd
regenerate man page for 0.30.0 release
2014-03-01 12:07:16 -05:00
662b49a463
fix broken merge in man page
2014-03-01 12:05:41 -05:00
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
8f7036743a
Merge pull request #3293 from ndr-qef/doc-automation
...
Add docs for Caskfiles and automation
2014-03-01 06:23:51 -05:00
878e1f2619
Add dotfiles section to Caskfile docs
2014-03-01 05:29:07 +01:00
94170eba2e
Add docs for Caskfiles
2014-03-01 05:21:10 +01:00
ndr