summaryrefslogtreecommitdiff
path: root/odk/docs/tools.html
diff options
context:
space:
mode:
authorStephan Bergmann <sbergman@redhat.com>2021-09-14 17:26:17 +0200
committerStephan Bergmann <sbergman@redhat.com>2022-06-10 17:15:49 +0200
commita8485d558fab53291e2530fd9a1be581c1628deb (patch)
treedff1f2885f954b9da2d3d2dbb9adc20b5b69c69c /odk/docs/tools.html
parent611fe67394820e589e86f543c614632fc273eb5e (diff)
[API CHANGE] Remove deprecated idlc and regmerge from the SDK
* Client code must replace uses of idlc and regmerge with uses of unoidl-write, see the changes to odk/examples/ and ure/source/uretext/ in 40f2aee6584eafcf4cd1d95fcf1f775e5435440d "Provide unoidl-write also for the SDK" for examples. * The new types.rdb format is not compatible with LibreOffice < 4.1. Clients generating extensions containing such files are advised to use appropriate LibreOffice-minimal-version elements. * For compatibility with old extensions, reading the legacy types.rdb format is still supported. * The SDK no longer ships an idl/ sub-directory containing the udkap and offapi .idl files (as, unlike idlc, unoidl-write does not need them). odk/config/cfgWin.js had to be adapted to look (somewhat arbitrarily) for an examples/ sub-directory instead of idl/ when checking for "an sdk folder". gb_UnoApi_package_idlfiles became unused and has been removed. * The idlc and regmerge executables have been removed. Module idlc has been removed except for idlc/test/parser/, which is also used by CustomTarget_unoidl/unoidl-write_test, and which may eventually be moved into module unoidl. Module external/ucpp and the corresponding configure options have also been removed. Change-Id: I42a0231699b863b5ebe2bee63bc32c8f79278cc1 Reviewed-on: https://gerrit.libreoffice.org/c/core/+/122363 Tested-by: Jenkins Reviewed-by: Stephan Bergmann <sbergman@redhat.com>
Diffstat (limited to 'odk/docs/tools.html')
-rw-r--r--odk/docs/tools.html144
1 files changed, 1 insertions, 143 deletions
diff --git a/odk/docs/tools.html b/odk/docs/tools.html
index adbe0f1ddbdd..092f4b185cbf 100644
--- a/odk/docs/tools.html
+++ b/odk/docs/tools.html
@@ -70,15 +70,8 @@
</tr>
<tr valign="top">
<td class="content3"><img src="images/arrow-1.gif"/></td>
- <td><a href="#idlc" title="link to the idlc tool description">idlc</a></td>
- <td class="content87">The deprecated UNOIDL compiler, generates a common
- legacy binary type library format as base for all codemaker tools and
- the UNO runtime type library.</td>
- </tr>
- <tr valign="top">
- <td class="content3"><img src="images/arrow-1.gif"/></td>
<td><a href="#unoidl-write" title="link to the unoidl-write tool description">unoidl-write</a></td>
- <td class="content87">The new UNOIDL compiler, generates a common
+ <td class="content87">The UNOIDL compiler, generates a common
binary type library format as base for all codemaker tools and
the UNO runtime type library.</td>
</tr>
@@ -113,12 +106,6 @@
</tr>
<tr valign="top">
<td class="content3"><img src="images/arrow-1.gif"/></td>
- <td><a href="#regmerge" title="link to the regmerge tool description">regmerge</a></td>
- <td class="content87">Deprecated tool to merge several legacy registry (e.g. type
- libraries) files into one file. <b>Note:</b> Since OpenOffice.org 3 it is no longer part of the SDK but it comes directly with the office as part of the <b>ure</b>.</td>
- </tr>
- <tr valign="top">
- <td class="content3"><img src="images/arrow-1.gif"/></td>
<td><a href="#regview" title="link to the regview tool description">regview</a></td>
<td class="content87">Tool to view the content of a legacy registry file
in a human readable manner. Special support for type library
@@ -334,80 +321,6 @@
<td>
<table class="table2">
<tr>
- <td colspan="2" class="head1"><a name="idlc"/>idlc</td>
- <td align="right">
- <a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"/></a>
- <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"/></a>
- </td>
- </tr>
- <tr>
- <td colspan="3">
- <p>'idlc' is the deprecated UNOIDL compiler. It is a full featured compiler used
- to check UNODL type definitions and transform valid type definitions
- into a binary type library format, which is later used by all codemaker
- tools. It is also used as a dynamic type library for UNO at runtime.<br/>
- You can find a syntax description for UNOIDL <a href="http://wiki.openoffice.org/wiki/Documentation/DevGuide/AppendixD/UNOIDL_Syntax_Specification" title="link to the &quot;UNOIDL Syntax Specification&quot; chapter in the Developer's Guide">here</a>.</p>
- <p><b>Note:</b> idlc and regmerge are deprecated and produce a legacy binary type
- library format that is different from the new format that is produced by
- unoidl-write.</p>
- <p class="head2">Usage:</p>
- <blockquote>
- <b><code>idlc [-options] file_1 ... file_n | @&lt;filename&gt;</code></b>
- </blockquote>
- <table class="table4">
- <tr>
- <td class="cell15"><code>file_1 ... file_n</code></td>
- <td class="cell85">specifies one or more idl files. Only files with
- the extension '.idl' are valid.</td>
- </tr>
- <tr>
- <td class="cell15"><code>@&lt;filename&gt;</code></td>
- <td class="cell85">filename specifies the name of a command
- file.</td>
- </tr>
- </table>
- <p class="head2">Options:</p>
- <table class="table4">
- <tr>
- <td class="cell15"><code>-O&lt;path&gt;</code></td>
- <td class="cell85">path describes the output directory. The
- generated output is a legacy registry file with the same name as the idl
- input file.</td>
- </tr>
- <tr>
- <td class="cell15"><code>-I&lt;path&gt;</code></td>
- <td class="cell85">path specifies a directory where included files
- that will be searched by the preprocessor are located. Multiple
- directories can be combined with ';'.</td>
- </tr>
- <tr>
- <td class="cell15"><code>-D&lt;name&gt;</code></td>
- <td class="cell85">name defines a macro for the preprocessor.</td>
- </tr>
- <tr>
- <td class="cell15"><code>-C</code></td>
- <td class="cell85">generates complete type information, including
- additional service information and documentation.</td>
- </tr>
- <tr>
- <td class="cell15"><code>-h|?</code></td>
- <td class="cell85">print this help message and exit.</td>
- </tr>
- </table>
- </td>
- </tr>
- </table>
- </td>
- <td class="content1"><img class="nothing8" src="images/nada.gif"/></td>
- </tr>
- <tr>
- <td colspan="3"><img class="line" src="images/sdk_line-1.gif"/></td>
- </tr>
- <tr>
- <td class="content1"><img class="nothing8" src="images/nada.gif"/></td>
- <td>
- <table class="table2">
- <tr>
<td colspan="2" class="head1"><a name="unoidl-write"/>unoidl-write</td>
<td align="right">
<a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"/></a>
@@ -897,61 +810,6 @@ types the specified types depend on.</p>
<td>
<table class="table2">
<tr>
- <td colspan="2" class="head1"><a name="regmerge"/>regmerge</td>
- <td align="right">
- <a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"/></a>
- <a href="../index.html" title="link to the SDK start page"><img class="navigate" src="images/nav_home.png"/></a>
- </td>
- </tr>
- <tr>
- <td colspan="3">
- <p>The deprecated 'regmerge' is a small tool to merge different legacy registry files under a
- specified key into another legacy registry file. If a value already exists in
- the target file the value is overwritten by the value of the source
- file.</p>
- <p><b>Note:</b> idlc and regmerge are deprecated and produce a legacy binary type
- library format that is different from the new format that is produced by
- unoidl-write.</p>
- <p class="head2">Usage:</p>
- <blockquote>
- <b><code>regmerge [-v|--verbose] &lt;mergefile&gt; &lt;mergeKeyName&gt; &lt;regfile_1&gt; ... &lt;regfile_n&gt;</code></b>
- </blockquote>
- <p class="head2">Options:</p>
- <table class="table4">
- <tr>
- <td class="cell15"><code>-v|--verbose</code></td>
- <td class="cell85">verbose output on stdout.</td>
- </tr>
- <tr>
- <td class="cell15"><code>&lt;mergefile&gt;</code></td>
- <td class="cell85">specifies the merged registry file. If this file
- doesn't exist, it is created.</td>
- </tr>
- <tr>
- <td class="cell15"><code>&lt;mergeKeyName&gt;</code></td>
- <td class="cell85">specifies the merge key, everything is merged
- under this key. If this key doesn't exist, it is created.</td>
- </tr>
- <tr>
- <td class="cell15"><code>&lt;regfile_1&gt; ... &lt;regfile_n&gt;</code></td>
- <td class="cell85">specifies one or more registry files that are
- merged.</td>
- </tr>
- </table>
- </td>
- </tr>
- </table>
- </td>
- <td class="content1"><img class="nothing8" src="images/nada.gif"/></td>
- </tr>
- <tr>
- <td colspan="3"><img class="line" src="images/sdk_line-1.gif"/></td>
- </tr>
- <tr>
- <td class="content1"><img class="nothing8" src="images/nada.gif"/></td>
- <td>
- <table class="table2">
- <tr>
<td colspan="2" class="head1"><a name="regview"/>regview</td>
<td align="right">
<a href="#tools" title="link to the tools overview"><img class="navigate" src="images/nav_up.png"/></a>