Commit Graph

147 Commits

Author SHA1 Message Date
Vítor Galvão 8275276493 Linked → moved (#21597)
* docs: chrome real staged output

* usage: fixed linked to moved

* all_stanzas doc: fixed linked to moved

* man page: fixed linked to moved
2016-06-01 17:31:35 -04:00
Vítor Galvão cd96c6c8af README.md: correct considering we now move (#21566) 2016-05-31 20:46:07 +01:00
Matt Wean 47383169de [WIP] Change artifact behavior to moving instead of symlinking (#13966)
* Change app artifact to move instead of link

First step towards change in installation behavior mentioned in [13201]

* Fix handling of binaries linked from inside of app bundles

Also adds `appdir` method for interpolation in stanzas

* Change appdir to root Applications directory

* Update 2-app tests

* Refactor: add options, ivars to `Installer`, `Download`

In preparation for upcoming changes, this commit cleans up some code. The commit includes:

- In order to reduce unnecessary object passing, make both the `force` and `skip_cask_deps` option into instance variables of the `Installer` class

- Introduce options hashes to initializers of both the `Installer` and `Download` class

- When the `install --force` command enters the fetch phase, make it explicit in the code that fetching is never enforced in that case.

- Update tests

* Force overwrite artifacts on `--force` reinstall

This commit changes the behavior of a `Moved` artifact such that if the target already exists, `brew cask install --force` will remove the existing target before moving the staged artifact.

In that case, the warning message will say *overwriting* instead of *not moving*.

The behavior of plain `brew cask install` remains unchanged; the same goes for the warning message for that case.

* Change remaining artifacts to move instead of symlink

* Update casks to use appdir in binary paths

* Forcibly overwrite artifacts, modifying flags and using `sudo` if needed

- This commit implements [the proposed behavior for `install --force`](https://github.com/caskroom/homebrew-cask/pull/13966#issuecomment-220830387) when a target already exists and has either permission problems or is not owned by the user.

- The changes apply only when the `force` option is given.

- Reused the existing safeguard from the `.pkg` artifact to prevent deleting important directories by bug or mistake

- The two existing blacklists `SYSTEM_DIRS` and `UNDELETABLE_DIRS` have been consolidated into the `Hbc::MacOS` module.

- `UNDELETABLE_DIRS` now also contains all the entries from `SYSTEM_DIRS` which was a to-do anyway.

- The two blacklists are now also frozen for good measure.

- The utility method `permissions_rmtree` was moved to `Hbc::Utils`.

- The `tried_permissions` part in `Utils` now falls back correctly when there are also ownership issues at the same time.

- Introduced a separate `current_user` method for mocking.

- Added an optional feature to `FakeSystemCommand` so it can now act as a proxy to `SystemCommand`.

- Added tests for various `permissions_rmtree` cases.
2016-05-31 15:23:21 -04:00
Vítor Galvão 070a3d5d4f README.md: removed extraneous space 2016-05-22 13:58:02 +01:00
Aditya Dalal 07f63d45cb Update README.md
Modify readme to give info about moving -> linking transition
2016-05-19 22:20:49 -04:00
Joshua McKinney ae3a29a076 (doc) Fix link to homebrew documentation 2016-04-03 14:14:58 -04:00
Razvan Botez dd73cc5775 Removed the word "Finally", which could have caused people to stop reading and not notice the last paragraph. 2016-02-12 15:29:14 +00:00
miccal e7e6ce5454 Update README.md 2016-02-09 10:12:35 +08:00
Morton Fox a576a5585e Fix hacking.md link 2016-01-23 00:14:24 -05:00
Vítor Galvão 6a531ab261 Delete FAQ.md 2016-01-15 14:12:51 +00:00
miccal 02b67ee7b0 Update README.md 2016-01-11 14:02:00 +00:00
miccal efe6f73a81 Update README.md 2016-01-11 14:02:00 +00:00
Josh Hagins 0e1aba0024 Re-emphasize bug report template in Reporting Bugs 2016-01-07 00:08:33 -05:00
Vítor Galvão bbc26347fa README.md: mention caskbot 2016-01-06 21:28:07 +00:00
Vítor Galvão 52ac87aea3 README.md: remove period on gitter link 2016-01-06 21:23:43 +00:00
Vítor Galvão 25cbb4c758 README.md: add gitter link in chat section 2016-01-06 20:50:26 +00:00
Josh Hagins e1c43aa059 Add common troubleshooting advice to README
We suggest these steps nearly every time someone has a problem,
so we should probably display them more prominently in the README.
2016-01-04 04:59:19 -05:00
Vítor Galvão 0d290b15e8 readme: clarify installation 2015-12-22 18:22:51 +00:00
Josh Hagins 2e723d4abd Link to bug report template in 'Reporting Bugs' 2015-12-10 17:34:34 -05:00
Josh Hagins 7d8b38ade7 Double-space lines in cask_request.md for consistency 2015-12-10 17:23:42 -05:00
Josh Hagins 55fca817be Add issue templates
Add issue template links to README

Remove accidental line in feature request template

Reorder template links
2015-12-10 17:04:27 -05:00
Josh Hagins c65720470c Remove extra space in update command
I assume this is the more commonly used form. I've never seen anyone space out
their semicolons like `foo ; bar`.
2015-12-10 11:19:38 -05:00
Vítor Galvão e83c0099aa README: December update 2015-12-10 16:02:25 +00:00
Aditya Dalal e8ff79f03e README.md: remove tap directions
Reverts #15731
2015-12-09 18:07:56 -05:00
Aditya Dalal e48fcbe121 README.md: Add in command to tap cask
As we no longer get automatically installed by homebrew, let's add in the tap command to the readme again
2015-12-09 17:25:34 -05:00
Vítor Galvão 5e79596ef7 long update command now uses ';' instead of '&&' 2015-12-09 17:18:46 -05:00
Vítor Galvão 6627f4de23 README.md: no longer needed to specifcally install homebrew-cask, to use it 2015-11-13 16:39:44 +00:00
Josh Hagins 835c89de79 Fix typo in README (provding -> providing) 2015-11-03 13:13:06 -05:00
dwkns c0bbd9ec52 Clearer important update message and description of Homebrew-Cask 2015-11-02 21:59:31 +00:00
Josh Hagins 3bd694eda2 Add Gitter badge to README 2015-09-18 13:31:32 -04:00
Vítor Galvão 28fba7ee76 README.md: general structure fixes 2015-09-18 01:48:56 +01:00
Vítor Galvão 11b484340e README.md: removed double spacing 2015-09-18 01:48:55 +01:00
Vítor Galvão 7b5477f119 readme: typographical fixes 2015-09-08 01:29:10 +01:00
Vítor Galvão bcca589be6 README.md: add notice on linking behaviour change. 2015-08-12 12:47:39 +01:00
Vítor Galvão 5c72f0182d readme.md: further refinements to header 2015-03-23 03:00:36 +01:00
Paul Hinze a6ef391c3f Update README.md
Italicize slogan. Bump badges down.
2015-03-22 10:56:27 -05:00
Paul Hinze f4e887dfed Merge pull request #10046 from bcomnes/patch-1
Demoted "To install, drag this icon" from readme header.
2015-03-22 10:38:07 -05:00
Bret Comnes 49b7f67bd5 Update README.md 2015-03-21 13:50:57 -07:00
Josh Hagins 6290ca1b2f Add coveralls badge to README.md 2015-03-17 22:02:52 -04:00
Vítor Galvão 9d7810fb1a README.md: issues should be searched for before opened. 2015-03-15 15:02:13 +01:00
Bret Comnes 72b3478d22 Removed "To install, drag this icon" from readme.
I always found the wording of the header in the readme confusing.  e.g. Did homebrew cask used be installed by icon dragging?  Do I install cask by dragging? Oh wait, its referring to what cask enables.

Care if we change the header to something more conventional and just include the concept as a pull quote?
2015-03-14 10:32:50 -07:00
Vítor Galvão d0b874099a README.me: ask for commands to be run with verbose, when reporting bugs 2015-01-11 17:45:04 +00:00
Vítor Galvão e367aea100 Merge pull request #8807 from vitorgalvao/lowercasehomebrew
Made homebrew lowercase in readme
2015-01-11 03:50:35 +00:00
Vítor Galvão 690133b271 Made homebrew lowercase in readme 2015-01-11 03:49:24 +00:00
Vítor Galvão 65599c03dc Additional instructions for reporting bugs 2015-01-10 19:08:45 +00:00
Vítor Galvão e8ebb350bf remove quotes around 'external command' 2015-01-09 16:38:35 +00:00
David J. Felix dfccc92971 Update readme badges for consistency 2014-12-16 10:53:13 -05:00
Michael Ford 67cadb7fc6 Remove Bitdeli Badge from README.md
GitHub now has it’s own analytics.
2014-12-14 16:31:19 +08:00
Maximilian Schüßler 9501d56941 Fix broken documentation link 2014-12-06 14:39:04 +01: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 e0c05651af remove DSL-change banner 2014-11-29 20:35:10 -05:00
Roland Walker 36449339fe doc nit; missing prompt character 2014-09-16 09:42:13 -04:00
Roland Walker 58a4c1092d rename delta file and update transition docs
requires #6074 (may show merge conflict)
2014-09-08 20:37:42 -04:00
Roland Walker 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
Roland Walker 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
Rico Sta. Cruz 8fc4701c81 Readme: update install instructions 2014-07-21 13:52:11 +08:00
Roland Walker 6ff511cd7c recommend `brew cask cleanup` before bug report
A user reported this fixed a problem in #4772.

References: #4857
2014-06-14 08:39:58 -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 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
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 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 ce58a0d9c3 Merge pull request #3074 from rolandwalker/doc_bug_report
doc: remind to upgrade before filing bug report
2014-02-21 17:10:29 -05:00
Roland Walker 1ec1eb682e doc: remind to upgrade before filing bug report 2014-02-21 08:58:19 -05:00
Roland Walker b7dcd35dab move HACKING.md and CHANGELOG.md to doc subdir 2014-02-20 19:17:02 -05:00
Roland Walker 46a0e53e27 add Reporting Bugs section to README 2014-01-27 10:45:24 -05:00
Roland Walker 9c2c589a7c truly trivial doc followups
- sync the docs to match some recent PRs
- formatting mistakes
- capitalization
- quoting
2014-01-18 11:38:34 -05:00
Roland Walker 8f9fc13cf5 standardize project name: homebrew-cask
- make lower-case and remove backticks for project name
  (backticks kept for commands/filenames/etc)
2014-01-17 20:14:48 -05:00
Geoffrey Oxberry 25ddc729ff Make links in README relative instead of absolute
Fixes #2347 based on recommendations in
https://help.github.com/articles/relative-links-in-readmes.
2014-01-07 09:20:48 -08:00
Seyi Ogunyemi 644c9512fc README: update initial instruction.
Homebrew handles the prefixes automatically.
2013-12-23 12:06:18 +00:00
Roland Walker e6630fb49e Fix documentation nits
Mostly this is spelling, capitalization, and whitespace.  One
substantive change is updating the list of fields given in FAQ.md
to match CONTRIBUTING.md.  Also incorporates suggestions from @NanoXD,
removing an old paragraph from FAQ.md re: nested containers.
2013-12-07 13:42:16 -05:00
Fernando Paredes 642a7c5f53 Add BSD 2 Clause License 2013-09-22 11:37:18 -07:00
Fernando Paredes 1ccc705a3c Add color to README
Change installation instructions to use shell colors
2013-09-19 08:14:57 -07:00
Fernando Paredes a2264a487e Add Bitdeli badge
Add bitdeli badge to readme.
2013-08-12 14:03:06 -07:00
phinze 18f115c12b and info about new IRC channel to README 2013-07-09 09:30:07 -05:00
phinze b48bf00dc7 Remove coverage status from README
Since it ain't gonna work with ruby 1.8. Maybe someday, maybe someday.
2013-05-02 15:52:11 -05:00
Mathias Bynens c7b897b99b README: Fix typo
`open "~/Applications/Google Chrome.app"` won’t work as intended, since the tilde isn’t expanded in that case.
2013-05-02 22:18:17 +03:00
phinze 9236a74393 lets try coveralls.io 2013-04-28 16:50:54 -05:00
phinze 354dfc3a75 split docs into README, USAGE, FAQ
moving towards more complete, centralized, maintainable documentation
2013-04-28 14:20:03 -05:00
Paul Gross 661cce07f2 Update README.md with new location of caskroom. 2013-04-27 22:19:33 -07:00
Vítor Galvão 85ea4b5909 Clarified that what goes to /Applications are links 2013-04-12 15:19:31 +01:00
Vítor Galvão b4f2933f9b hopefully resolved confusion with 'a-cask' 2013-04-12 11:30:41 +01:00
phinze 18f281b385 add code climate for the hell of it 2013-04-05 02:35:15 -06:00
phinze 81ebce073a correct branch on travis badge 2013-04-05 02:12:40 -06:00
phinze 1797ce9400 travis badge woo 2013-04-05 02:10:59 -06:00
phinze 47544e46b6 Reflect the Cellar -> Caskroom change in README 2013-02-18 08:53:38 -06:00
Félix Saparelli 14bd960b3d Add link to ‘Contributing’ wiki page
Re: @mkouhia's #127.
2013-01-07 09:41:00 +13:00
Zach Hobbs c42e8a737b Add tip about mac file chooser
By default, the mac file chooser won't list folders like /usr/,
add tip to readme about Cmd-Shift-G workaround.

Signed-off-by: Félix Saparelli <me@passcod.net>
2013-01-07 09:39:19 +13:00
Félix Saparelli 9c74809989 Fix opts syntax (see #123) 2013-01-03 15:18:05 +13:00
Félix Saparelli 5ad6796bcd Add options to the cli
Options can be passed on the command-line and/or using
the HOMEBREW_CASK_OPTS environment variable (which has
lowest priority). There is a single --appdir=PATH option
right now, but this commit enables future awesomeness!

Other minor changes:

* `brew cask help` now returns the same thing as `brew cask`
  instead of saying there was “no such command as help”.

* The HEREDOC block now uses Homebrew's #undent instead of the
  customed-rolled #gsub version. Cleaner and more flexible.

* `Cask.set_appdir` has been renamed to `Cask.appdir=`. This
  is more Rubyish, and of little consequence (the only place
  it was previously used was in the tests).
2012-12-19 00:54:49 +13:00
phinze 50bbd4e195 adding note about homebrew version requirement
did the research to figure out in which HOMEBREW_VERSION the wild Tap
linking problem that we ran into in #37 was fixed.

hopefully this will prevent other folks from running into it.
2012-10-20 13:12:33 -05:00
phinze 0ec6e18fde readme tweak 2012-10-12 19:11:15 -05:00
phinze 18f947fa90 add explanation from #38 into readme
thanks to @muescha for the good suggestion
2012-10-10 13:57:31 -05:00
Félix Saparelli 96b192f26b Update README w/ info about taps 2012-09-24 16:47:45 +12:00
phinze df45d87408 readme cleanup and updates 2012-08-25 22:01:34 -05:00
phinze b242a97f53 update README and add a version 2012-08-25 21:32:06 -05:00
phinze 383dbe870e Get the readme in line with our current status 2012-03-10 02:12:09 -06:00
phinze 5a0d1d5556 quick sketchy first release of code/ideas
this is a first draft of an idea i've had kicking around for awhile

pushing out some code so i can get a conversation started
2012-03-09 22:43:50 -06:00