aboutsummaryrefslogtreecommitdiffstats
path: root/lib/reltool/doc/src/reltool.xml
diff options
context:
space:
mode:
authorSiri Hansen <[email protected]>2012-09-19 14:45:55 +0200
committerSiri Hansen <[email protected]>2012-09-21 08:46:28 +0200
commit4a6edd6f6ffe820db595dfa1f2c43311f6581ca7 (patch)
tree3e78993483b5d77176e7a7bce2abf853dd2efd1c /lib/reltool/doc/src/reltool.xml
parent04c6b9a40f782099ece28dbde39c35f25dd2e37b (diff)
downloadotp-4a6edd6f6ffe820db595dfa1f2c43311f6581ca7.tar.gz
otp-4a6edd6f6ffe820db595dfa1f2c43311f6581ca7.tar.bz2
otp-4a6edd6f6ffe820db595dfa1f2c43311f6581ca7.zip
[reltool] Use application name from .app file instead of directory name
In the first traversal of library directories, reltool used only the directory names in order to figure out application names. This would succeed if the directory name was AppName only or AppName-AppVsn and AppVsn consisted of integers separated by dots only. If the AppVsn has any other format, then reltool would not find the correct application name. With this commit, reltool will first look for a .app file and use the .app file name as the application name. This will allow different formats of the version identifier in the directory name. Note that reltool can still not sort (and select the latest) amongst version identifiers of other format than integers separated by dots.
Diffstat (limited to 'lib/reltool/doc/src/reltool.xml')
-rw-r--r--lib/reltool/doc/src/reltool.xml24
1 files changed, 22 insertions, 2 deletions
diff --git a/lib/reltool/doc/src/reltool.xml b/lib/reltool/doc/src/reltool.xml
index d7d7e12566..fbe29753be 100644
--- a/lib/reltool/doc/src/reltool.xml
+++ b/lib/reltool/doc/src/reltool.xml
@@ -51,8 +51,18 @@
defines library directories where additional applications
may reside and it defaults to the directories
listed by the operating system environment variable
- <c>ERL_LIBS</c>. See the module <c>code</c> for more info.
- Finally single modules and entire applications may be read from
+ <c>ERL_LIBS</c>. See the module <c>code</c> for more info.</p>
+
+ <p>An application directory <c>AppDir</c> under a library
+ directory is recognized by the existence of an <c>AppDir/ebin</c>
+ directory. If this does not exist, <c>reltool</c> will not
+ consider <c>AppDir</c> at all when looking for applications.</p>
+
+ <p>It is recommended that application directories are named as the
+ application, possibly followed by a dash and the version
+ number. For example <c>myapp</c> or <c>myapp-1.1</c>.</p>
+
+ <p>Finally single modules and entire applications may be read from
Escripts.</p>
<p>Some configuration parameters control the behavior of Reltool
@@ -372,6 +382,11 @@
<p>This parameter is mutual exclusive with <c>lib_dir</c>. If
<c>vsn</c> and <c>lib_dir</c> are both omitted, the latest version
will be chosen.</p>
+ <p>Note that in order for reltool to sort application versions
+ and thereby be able to select the latest, it is required that
+ the version id for the application consits of integers and
+ dots only, for example <c>1</c>, <c>2.0</c> or
+ <c>3.17.1</c>.</p>
</item>
<tag><c>lib_dir</c></tag>
<item>
@@ -383,6 +398,11 @@
<p>This parameter is mutual exclusive with <c>vsn</c>. If
<c>vsn</c> and <c>lib_dir</c> are both omitted, the latest version
will be chosen.</p>
+ <p>Note that in order for reltool to sort application versions
+ and thereby be able to select the latest, it is required that
+ the version id for the application consits of integers and
+ dots only, for example <c>1</c>, <c>2.0</c> or
+ <c>3.17.1</c>.</p>
</item>
<tag><c>mod</c></tag>
<item>