From 4a6edd6f6ffe820db595dfa1f2c43311f6581ca7 Mon Sep 17 00:00:00 2001
From: Siri Hansen <siri@erlang.org>
Date: Wed, 19 Sep 2012 14:45:55 +0200
Subject: [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.
---
 lib/reltool/doc/src/reltool.xml       | 24 ++++++++++++++++++++++--
 lib/reltool/doc/src/reltool_usage.xml | 11 ++++++++---
 2 files changed, 30 insertions(+), 5 deletions(-)

(limited to 'lib/reltool/doc')

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>
diff --git a/lib/reltool/doc/src/reltool_usage.xml b/lib/reltool/doc/src/reltool_usage.xml
index d128e80a77..0041e60d8f 100644
--- a/lib/reltool/doc/src/reltool_usage.xml
+++ b/lib/reltool/doc/src/reltool_usage.xml
@@ -5,7 +5,7 @@
   <header>
     <copyright>
       <year>2009</year>
-      <year>2011</year>
+      <year>2012</year>
       <holder>Ericsson AB, All Rights Reserved</holder>
     </copyright>
     <legalnotice>
@@ -257,6 +257,11 @@
     policy</c> part of the page. By default the latest version of the
     application is selected, but it is possible to override this by
     explicitly selecting another version.</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>
     
     <p>By default the <c>Application inclusion policy</c> on system
     level is used for all applications. Set the value to
@@ -335,7 +340,7 @@
 
     <p>There are two categories of modules on the <c>Module
     dependencies</c> page. If the module is used by other modules,
-    these are listed under <c>Modules used by others</c>. If the
+    these are listed under <c>Modules using this</c>. If the
     module uses other modules, these are listed under <c>Used
     modules</c>.</p>
 
@@ -365,7 +370,7 @@
 
     <p>There are two categories of modules on the <c>Dependencies</c>
     page. If the module is used by other modules, these are listed
-    under <c>Modules used by others</c>. If the module uses other
+    under <c>Modules using this</c>. If the module uses other
     modules, these are listed under <c>Used modules</c>.</p>
 
     <p>Double click on an module name to launch a module window.</p>
-- 
cgit v1.2.3