diff options
| author | Mark Allen <[email protected]> | 2016-05-11 20:24:06 -0500 |
|---|---|---|
| committer | Mark Allen <[email protected]> | 2016-05-11 20:24:06 -0500 |
| commit | 6d2daf42967e3b04ba39aaa8430ef2db0539bcab (patch) | |
| tree | 9662774e34e23c72b637087ae56de3b68b2d930a | |
| parent | c3b80fdd9bde6b2c2cd312a0749c24926ef54699 (diff) | |
| download | kerl-6d2daf42967e3b04ba39aaa8430ef2db0539bcab.tar.gz kerl-6d2daf42967e3b04ba39aaa8430ef2db0539bcab.tar.bz2 kerl-6d2daf42967e3b04ba39aaa8430ef2db0539bcab.zip | |
Update README
| -rw-r--r-- | README.md | 16 |
1 files changed, 14 insertions, 2 deletions
@@ -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 |