diff options
| author | Trevor Brown <[email protected]> | 2018-07-25 02:45:03 -0400 |
|---|---|---|
| committer | Pierre Fenoll <[email protected]> | 2018-07-25 08:45:03 +0200 |
| commit | 9fccf3d503188bf324110dcaab4d3cce5edb77e7 (patch) | |
| tree | 992b93a79ab4298d562120bb14912ddec40ba943 | |
| parent | 699633a001227b9f48cc692feb7f806b4b691c66 (diff) | |
| download | kerl-9fccf3d503188bf324110dcaab4d3cce5edb77e7.tar.gz kerl-9fccf3d503188bf324110dcaab4d3cce5edb77e7.tar.bz2 kerl-9fccf3d503188bf324110dcaab4d3cce5edb77e7.zip | |
Clarify purpose of KERL_INSTALL_MANPAGES and KERL_INSTALL_HTMLDOCS (#292)
| -rw-r--r-- | README.md | 13 |
1 files changed, 11 insertions, 2 deletions
@@ -282,13 +282,22 @@ Acceptable value: any github fork of OTP, e.g. `https://github.com/basho/otp` ### KERL_BUILD_DOCS -### KERL_INSTALL_MANPAGES -### KERL_INSTALL_HTMLDOCS If `$KERL_BUILD_DOCS` is set, kerl will create docs from the built erlang version regardless of origin (`tarball` backend from erlang.org or via `kerl build git`, or via `git` backend). If `$KERL_BUILD_DOCS` is unset, kerl will only install docs when NOT installing a build created via `kerl build git...`, and according to `KERL_INSTALL_HTMLDOCS` and `KERL_INSTALL_MANPAGES`. +### KERL_INSTALL_MANPAGES + +Install man pages when not building from git source. + +It's noteworthy that when not using `KERL_BUILD_DOCS=yes`, the docset that may be downloaded can be up to 120MB. + + +### KERL_INSTALL_HTMLDOCS + +Install HTML documentation when not building from git source. + It's noteworthy that when not using `KERL_BUILD_DOCS=yes`, the docset that may be downloaded can be up to 120MB. |