Skip to content

Commit

Permalink
Bug 572890: Add @launcher.dir to documentation
Browse files Browse the repository at this point in the history
Contributed by STMicroelectronics

Change-Id: I52e62f3979c8cb8f6d13e66e67eeaf2761dfa7d1
Signed-off-by: Torbjörn Svensson <torbjorn.svensson@st.com>
Reviewed-on: https://git.eclipse.org/r/c/platform/eclipse.platform.common/+/181146
Reviewed-by: Jonah Graham <jonah@kichwacoders.com>
Reviewed-by: Thomas Watson <tjwatson@us.ibm.com>
Tested-by: Thomas Watson <tjwatson@us.ibm.com>
  • Loading branch information
Torbjorn-Svensson authored and tjwatson committed Jun 1, 2021
1 parent ea85aee commit f6ad745
Showing 1 changed file with 30 additions and 8 deletions.
Expand Up @@ -864,7 +864,7 @@ <h2><a name="locations"></a>Locations
location is based on the value of the Java <code>user.home</code> system
property but this can be overridden. Information such as user scoped preferences
and login information may be found in the user location.</dd>
<dt>Install (-install) {osgi.install.area} [@user.home, @user.dir, filepath,
<dt>Install (-install) {osgi.install.area} [@launcher.dir, @user.home, @user.dir, filepath,
url]</dt>
<dd>An install location is where Eclipse itself is installed. In practice
this location is the directory (typically &quot;eclipse&quot;) which is
Expand Down Expand Up @@ -915,6 +915,18 @@ <h3>More detail</h3>
want to allow for data in the corresponding location but the Eclipse default
value is not appropriate. @noDefault must not be followed by any
additional path segments.</dd>
<dt>@launcher.dir</dt>
<dd>Directs Eclipse to compute a location value relative to the directory
containing the Eclipse launcher binary. @launcher.dir can be followed
by additional path segments. In all cases, the string &quot;@location.dir&quot; is
simply replaced with the parent directory of the path pointed to by the Java
&quot;eclipse.launcher&quot; System property. For example, setting<br>
&nbsp;&nbsp;&nbsp;&nbsp;osgi.install.area=@launcher.dir/../../../pool<br>
results in a value of
<br>
&nbsp;&nbsp;&nbsp;&nbsp;file:/home/bob/eclipse-product/linux/gtk/x86_64/../../../pool<br>
if the &quot;eclipse.launcher&quot; property is set to
&quot;/home/bob/eclipse-product/linux/gtk/x86_64/eclipse&quot;.</dd>
<dt>@user.home</dt>
<dd>Directs Eclipse to compute a location value relative to the user's home
directory. @user.home can be followed
Expand All @@ -937,17 +949,19 @@ <h3>More detail</h3>
</dl>
<table width="100%" border="0" bgcolor="#FFFFFF">
<tr bgcolor="#CCCCCC">
<td width="10%">location/value</td>
<td width="17%"><div align="center">supports default</div></td>
<td width="17%"><div align="center">file/URL</div>
<td width="9%">location/value</td>
<td width="13%"><div align="center">supports default</div></td>
<td width="13%"><div align="center">file/URL</div>
</td>
<td width="13%"><div align="center">@none</div>
</td>
<td width="17%"><div align="center">@none</div>
<td width="13%"><div align="center">@noDefault</div>
</td>
<td width="17%"><div align="center">@noDefault</div>
<td width="13%"><div align="center">@launcher.dir</div>
</td>
<td width="17%"><div align="center">@user.home</div>
<td width="13%"><div align="center">@user.home</div>
</td>
<td width="17%"><div align="center">@user.dir</div>
<td width="13%"><div align="center">@user.dir</div>
</td>
</tr>
<tr>
Expand All @@ -960,6 +974,8 @@ <h3>More detail</h3>
</td>
<td><div align="center">yes</div>
</td>
<td><div align="center">no</div>
</td>
<td><div align="center">yes</div>
</td>
<td><div align="center">yes (default)</div>
Expand All @@ -976,6 +992,8 @@ <h3>More detail</h3>
</td>
<td><div align="center">yes*</div>
</td>
<td><div align="center">no</div>
</td>
<td><div align="center">yes</div>
</td>
<td><div align="center">yes</div>
Expand All @@ -996,6 +1014,8 @@ <h3>More detail</h3>
</td>
<td><div align="center">yes</div>
</td>
<td><div align="center">yes</div>
</td>
</tr>
<tr>
<td bgcolor="#CCCCCC"><div align="center">user</div>
Expand All @@ -1008,6 +1028,8 @@ <h3>More detail</h3>
</td>
<td><div align="center">yes</div>
</td>
<td><div align="center">no</div>
</td>
<td><div align="center">yes</div>
</td>
<td><div align="center">yes</div>
Expand Down

0 comments on commit f6ad745

Please sign in to comment.