diff options
| author | Siri Hansen <[email protected]> | 2011-12-07 11:05:18 +0100 |
|---|---|---|
| committer | Siri Hansen <[email protected]> | 2011-12-07 11:05:18 +0100 |
| commit | a1f72ad056cbec4cd69ff4ef0e9c2cc744361eac (patch) | |
| tree | 9cf36e6b7b923f7a2c367d6b86de7bb4ba9bfc42 /lib | |
| parent | 287764befb7d9baf0af22bad5f7a16380effd6d4 (diff) | |
| parent | 1443c80ff59c46674855880a1f75e28480e6db4e (diff) | |
| download | otp-a1f72ad056cbec4cd69ff4ef0e9c2cc744361eac.tar.gz otp-a1f72ad056cbec4cd69ff4ef0e9c2cc744361eac.tar.bz2 otp-a1f72ad056cbec4cd69ff4ef0e9c2cc744361eac.zip | |
Merge branch 'siri/reltool/doc-rootdir-recommendataion/OTP-9742'
* siri/reltool/doc-rootdir-recommendataion/OTP-9742:
Add recommendation about RootDir parameter to reltool:eval_target_spec/3
Diffstat (limited to 'lib')
| -rw-r--r-- | lib/reltool/doc/src/reltool.xml | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/lib/reltool/doc/src/reltool.xml b/lib/reltool/doc/src/reltool.xml index ab1c8e3034..60e886e8f5 100644 --- a/lib/reltool/doc/src/reltool.xml +++ b/lib/reltool/doc/src/reltool.xml @@ -558,7 +558,17 @@ target_spec() = [target_spec()] <c>true</c> there is no need to install the target system with <c>reltool:install/2</c> before it can be started. In that case the file tree containing the target system can be moved without - re-installation.</p></desc> + re-installation.</p> + + <p>In most cases, the <c>RootDir</c> parameter should be set to + the same as the <c>root_dir</c> configuration parameter used in + the call to <c>reltool:get_target_spec/1</c> + (or <c>code:root_dir()</c> if the configuration parameter is not + set). In some cases it might be useful to evaluate the same + target specification towards different root directories. This + should, however, be used with great care as it requires + equivalent file structures under all roots.</p> + </desc> </func> <func> |