From 1443c80ff59c46674855880a1f75e28480e6db4e Mon Sep 17 00:00:00 2001
From: Siri Hansen
Date: Mon, 5 Dec 2011 12:24:26 +0100
Subject: Add recommendation about RootDir parameter to
reltool:eval_target_spec/3
---
lib/reltool/doc/src/reltool.xml | 12 +++++++++++-
1 file changed, 11 insertions(+), 1 deletion(-)
(limited to 'lib')
diff --git a/lib/reltool/doc/src/reltool.xml b/lib/reltool/doc/src/reltool.xml
index 31e15e34e7..79e88f8bbc 100644
--- a/lib/reltool/doc/src/reltool.xml
+++ b/lib/reltool/doc/src/reltool.xml
@@ -558,7 +558,17 @@ target_spec() = [target_spec()]
true there is no need to install the target system with
reltool:install/2 before it can be started. In that case
the file tree containing the target system can be moved without
- re-installation.
+ re-installation.
+
+ In most cases, the RootDir parameter should be set to
+ the same as the root_dir configuration parameter used in
+ the call to reltool:get_target_spec/1
+ (or code:root_dir() 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.
+
--
cgit v1.2.3