diff --git a/doc/CASK_LANGUAGE_REFERENCE.md b/doc/CASK_LANGUAGE_REFERENCE.md index 6c0c8aad47b4..187d72533f16 100644 --- a/doc/CASK_LANGUAGE_REFERENCE.md +++ b/doc/CASK_LANGUAGE_REFERENCE.md @@ -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. @@ -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 diff --git a/doc/cask_language_deltas.md b/doc/cask_language_deltas.md index 26a64c951a61..70edfea28a2f 100644 --- a/doc/cask_language_deltas.md +++ b/doc/cask_language_deltas.md @@ -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`