aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorMark Allen <[email protected]>2016-05-12 21:26:21 -0500
committerMark Allen <[email protected]>2016-05-12 21:26:21 -0500
commitfccafcd6a44b2495f3c30317b812d458a54a6294 (patch)
tree626644b303926368079bf9a467c0415976d8ee55 /README.md
parent092fc73dde5a1161112ab87db5fc64a0f9269703 (diff)
parentd8315197f0c2801e5c2d42b7f51dcd28c752b256 (diff)
downloadkerl-fccafcd6a44b2495f3c30317b812d458a54a6294.tar.gz
kerl-fccafcd6a44b2495f3c30317b812d458a54a6294.tar.bz2
kerl-fccafcd6a44b2495f3c30317b812d458a54a6294.zip
Merge pull request #127 from kerl/check_paths
Be more careful about paths before install and delete operations
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 14 insertions, 2 deletions
diff --git a/README.md b/README.md
index 02a809e..8b4c699 100644
--- a/README.md
+++ b/README.md
@@ -285,9 +285,21 @@ Installs a named build to the specified filesystem location.
$ kerl install r14b02 /srv/otp/r14b02
-If path is omitted the current working directory will be used. However, if `KERL_DEFAULT_INSTALL_DIR` is defined in ~/.kerlrc, `KERL_DEFAULT_INSTALL_DIR/<build-name>` will be used instead.
+If path is omitted the current working directory will be used. However, if
+`KERL_DEFAULT_INSTALL_DIR` is defined in ~/.kerlrc,
+`KERL_DEFAULT_INSTALL_DIR/<build-name>` will be used instead.
-*Note*: kerl assumes the specified directory is for its sole use. If you later delete it with the kerl delete command, the whole directory will be deleted, along with anything you may have added to it!
+#### Install location restrictions
+
+**WARNING**: kerl assumes the given installation directory is for its sole use.
+If you later delete it with the `kerl delete` command, the whole directory will
+be deleted, along with anything you may have added to it!
+
+So please only install kerl in an empty (or non-existant) directory.
+
+If you attempt to install kerl in `$HOME` or `.erlang` or `$KERL_BASE_DIR`,
+then kerl will give you an error and refuse to proceed. If you try to install
+kerl in a directory that exists and is not empty, kerl will give you an error.
#### Tuning