Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document uninstall :trash #6507

Merged
merged 2 commits into from
Oct 6, 2014
Merged

Document uninstall :trash #6507

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a91673f
document `uninstall :trash`
rolandwalker Oct 6, 2014
8eaab93
incidental Markdown formatting
rolandwalker Oct 6, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions doc/CASK_LANGUAGE_REFERENCE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -524,6 +524,7 @@ of the following key/value pairs as arguments to `uninstall`.
- `:must_succeed` - set to `false` if the script is allowed to fail
* `:delete` (string or array) - single-quoted, absolute paths of files or directory trees to remove. `:delete` should only be used as a last resort. `:pkgutil` is strongly preferred
* `:rmdir` (string or array) - single-quoted, absolute paths of directories to remove if empty.
* `:trash` (string or array) - currently a synonym for `:delete`. In the future this will cause files to be moved to the Trash.

Each `uninstall` technique is applied according to the order above. The order
in which `uninstall` keys appear in the Cask file is ignored.
Expand Down Expand Up @@ -662,6 +663,14 @@ paths.

To remove user-specific files, use the `zap` stanza.


### Uninstall Key :trash

*stub* - currently a synonym for `:delete`. In the future this will cause
files to be moved to the Trash. It is best not to use this stub until it
gains the proper functionality.


### Working With a pkg File Manually

Advanced users may wish to work with a `pkg` file manually, without having the
Expand Down
12 changes: 7 additions & 5 deletions doc/cask_language_deltas.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,18 +33,20 @@ This notice will be removed for the final form.**

* `artifact`
* `depends_on :cask`
* stub - not yet functional
* *stub* - not yet functional
* `depends_on :macos`
* stub - not yet functional
* *stub* - not yet functional
* `depends_on :arch`
* stub - not yet functional
* *stub* - not yet functional
* `depends_on :x11`
* stub - not yet functional
* *stub* - not yet functional
* `depends_on :java`
* stub - not yet functional
* *stub* - not yet functional
* `license`
* `suite`
* `uninstall :rmdir`
* `uninstall :trash`
* *stub* - currently just a synonym for `uninstall :delete`
* `zap`


Expand Down