Adapt documentation to reality

...that both OFFICE_HOME and OO_SDK_URE_HOME are always set

Change-Id: I74f3a19cd7020fbefc30b08e122ca20e292f1830
This commit is contained in:
Stephan Bergmann 2014-11-24 17:14:14 +01:00
parent 0d2befdaea
commit d395093aec

View File

@ -68,8 +68,8 @@
<td><b>LibreOffice %PRODUCT_RELEASE% <td><b>LibreOffice %PRODUCT_RELEASE%
installation</b></td> installation</b></td>
<td class="content80">The SDK works on top of an <td class="content80">The SDK works on top of an
existing office installation and uses the same existing LibreOffice installation and uses the same
libraries as the office installation.</td> libraries as the LibreOffice installation.</td>
</tr> </tr>
<tr valign="middle"> <tr valign="middle">
<td colspan="2"><img class="line" src="images/sdk_line-1.gif"/></td> <td colspan="2"><img class="line" src="images/sdk_line-1.gif"/></td>
@ -228,12 +228,9 @@
<tr valign="top"> <tr valign="top">
<td class="cell20"><b>OFFICE_HOME</b></td> <td class="cell20"><b>OFFICE_HOME</b></td>
<td class="cell80">Path to an existing <td class="cell80">Path to an existing
LibreOffice base installation, e.g. LibreOffice installation, e.g.
&quot;/opt/libreoffice8&quot;. Be sure that it &quot;/opt/libreoffice8&quot;. Be sure that it
is not a user installation only. Exactly one is not a user installation only.</td>
of OFFICE_HOME and OO_SDK_URE_HOME must be
set. The other should be either unset or set
to an empty value.</td>
</tr> </tr>
<tr> <tr>
<td class="cell20"><a name="oosdkname"/><b>OO_SDK_NAME</b></td> <td class="cell20"><a name="oosdkname"/><b>OO_SDK_NAME</b></td>
@ -251,10 +248,7 @@
<td class="cell20"><b>OO_SDK_URE_HOME</b></td> <td class="cell20"><b>OO_SDK_URE_HOME</b></td>
<td class="cell80">Path to an existing UNO <td class="cell80">Path to an existing UNO
Runtime Environment installation, e.g. Runtime Environment installation, e.g.
&quot;/opt/libreoffice/ure&quot;. Exactly one &quot;/opt/libreoffice/ure&quot;.</td>
of OFFICE_HOME and OO_SDK_URE_HOME must be
set. The other should be either unset or set
to an empty value.</td>
</tr> </tr>
<tr> <tr>
<td class="cell20"><b>OO_SDK_HOME</b></td> <td class="cell20"><b>OO_SDK_HOME</b></td>
@ -321,11 +315,10 @@
<td class="cell20"><b>SDK_AUTO_DEPLOYMENT</b></td> <td class="cell20"><b>SDK_AUTO_DEPLOYMENT</b></td>
<td class="cell80">If this variable is set, the <td class="cell80">If this variable is set, the
component examples are automatically deployed component examples are automatically deployed
into the Office installation referenced by into the LibreOffice installation referenced
OFFICE_HOME. See also chapter by OFFICE_HOME. See also chapter
<a href="http://wiki.openoffice.org/wiki/Documentation/DevGuide/Extensions/unopkg" title="link to the &quot;Extension Manager - unopkg&quot; chapter in the Developer's Guide">&quot;Extension Manager - unopkg&quot;</a> <a href="http://wiki.openoffice.org/wiki/Documentation/DevGuide/Extensions/unopkg" title="link to the &quot;Extension Manager - unopkg&quot; chapter in the Developer's Guide">&quot;Extension Manager - unopkg&quot;</a>
from the Developer's Guide. This variable is from the Developer's Guide.</td>
only relevant when OFFICE_HOME is set.</td>
</tr> </tr>
</table> </table>
<p>You must run the <b>setsdkenv_XXX</b> script <p>You must run the <b>setsdkenv_XXX</b> script
@ -358,30 +351,24 @@
<tr valign="top"> <tr valign="top">
<td class="cell20">OO_SDK_URE_BIN_DIR</td> <td class="cell20">OO_SDK_URE_BIN_DIR</td>
<td class="cell80">The path within the chosen <td class="cell80">The path within the chosen
office or URE installation where binary URE installation where binary executables are
executables are located (e.g., located (e.g., <i>$OO_SDK_URE_HOME/bin</i>
<i>$OFFICE_HOME/program</i> for an office for a Unix installation).</td>
installation, or <i>$OO_SDK_URE_HOME/bin</i>
for a Unix URE installation).</td>
</tr> </tr>
<tr valign="top"> <tr valign="top">
<td class="cell20">OO_SDK_URE_LIB_DIR</td> <td class="cell20">OO_SDK_URE_LIB_DIR</td>
<td class="cell80">The path within the chosen <td class="cell80">The path within the chosen
office or URE installation where dynamic URE installation where dynamic libraries are
libraries are located (e.g., located (e.g., <i>$OO_SDK_URE_HOME/lib</i>
<i>$OFFICE_HOME/program</i> for an office for a Unix installation).</td>
installation, or <i>$OO_SDK_URE_HOME/lib</i>
for a Unix URE installation).</td>
</tr> </tr>
<tr valign="top"> <tr valign="top">
<td class="cell20">OO_SDK_URE_JAVA_DIR</td> <td class="cell20">OO_SDK_URE_JAVA_DIR</td>
<td class="cell80">The path within the chosen <td class="cell80">The path within the chosen
office or URE installation where Java JARs are URE installation where Java JARs are
located (e.g., located (e.g.,
<i>$OFFICE_HOME/program/classes</i> for an
office installation, or
<i>$OO_SDK_URE_HOME/share/java</i> for a Unix <i>$OO_SDK_URE_HOME/share/java</i> for a Unix
URE installation).</td> installation).</td>
</tr> </tr>
<tr valign="top"> <tr valign="top">
<td class="cell20">CLASSPATH</td> <td class="cell20">CLASSPATH</td>
@ -389,12 +376,11 @@
$OO_SDK_URE_JAVA_DIR/jurt.jar; $OO_SDK_URE_JAVA_DIR/jurt.jar;
$OO_SDK_URE_JAVA_DIR/ridl.jar; $OO_SDK_URE_JAVA_DIR/ridl.jar;
$OO_SDK_URE_JAVA_DIR/unoloader.jar; $OO_SDK_URE_JAVA_DIR/unoloader.jar;
[$OO_SDK_URE_JAVA_DIR/unoil.jar;] $OO_SDK_URE_JAVA_DIR/unoil.jar;
$CLASSPATH</i><br/> $CLASSPATH</i><br/>
<p>The classpath will be set or extended to <p>The classpath will be set or extended to
the necessary jar files of the specified the necessary jar files of the specified
office installation. (<i>unoil.jar</i> is LibreOffice installation.</p>
only included when OFFICE_HOME is set.)</p>
</td> </td>
</tr> </tr>
<tr valign="top"> <tr valign="top">
@ -402,8 +388,7 @@
<td class="cell80">=<i>$OFFICE_HOME/program</i><br/> <td class="cell80">=<i>$OFFICE_HOME/program</i><br/>
<p>This variable is used to find, for example, <p>This variable is used to find, for example,
the office type library and the UNO package the office type library and the UNO package
deployment tool. This variable is only deployment tool.</p>
relevant when OFFICE_HOME is set.</p>
</td> </td>
</tr> </tr>
<tr valign="top"> <tr valign="top">
@ -411,16 +396,14 @@
<td class="cell80">=<i>$OFFICE_PROGRAM_PATH</i><br/> <td class="cell80">=<i>$OFFICE_PROGRAM_PATH</i><br/>
<p>This variable is used to ensure that the <p>This variable is used to ensure that the
new C++ UNO bootstrap mechanism uses the new C++ UNO bootstrap mechanism uses the
configured office installation of the SDK. configured LibreOffice installation of the
Normally the bootstrap mechanism finds the SDK. Normally the bootstrap mechanism finds
default office installation for the user on the default office installation for the user
the system. This variable is optional but is on the system. This variable is optional but
set from the scripts to ensure a homogeneous is set from the scripts to ensure a
environment. Especially useful during homogeneous environment. Especially useful
development where you might have more than during development where you might have more
one office installation installed. This than one office installation installed.</p>
variable is only relevant when OFFICE_HOME
is set.</p>
</td> </td>
</tr> </tr>
</table> </table>
@ -452,8 +435,7 @@
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="2" class="cell80">When <td colspan="2" class="cell80">The script
OO_SDK_URE_HOME is set, the script
additionally creates symbolic links to the additionally creates symbolic links to the
public dynamic libraries of the URE in public dynamic libraries of the URE in
<i>$OO_SDK_HOME/(solsparc|solintel)/lib</i>, <i>$OO_SDK_HOME/(solsparc|solintel)/lib</i>,
@ -487,8 +469,7 @@
</td> </td>
</tr> </tr>
<tr> <tr>
<td colspan="2" class="cell80">When <td colspan="2" class="cell80">The script
OO_SDK_URE_HOME is set, the script
additionally creates symbolic links to the additionally creates symbolic links to the
public dynamic libraries of the URE in public dynamic libraries of the URE in
<i>$OO_SDK_HOME/linux/lib</i>, which are <i>$OO_SDK_HOME/linux/lib</i>, which are