summaryrefslogtreecommitdiff
path: root/unoidl/README
diff options
context:
space:
mode:
authorStephan Bergmann <sbergman@redhat.com>2013-09-16 16:48:09 +0200
committerStephan Bergmann <sbergman@redhat.com>2013-09-16 16:48:09 +0200
commitfc54915c461dc753866627bd52ea60b12b71a012 (patch)
tree8f71995fb5420ae1c32e8669e3fd249c82728f8e /unoidl/README
parent95e566b9a0df06d130e118181058273f034bcf2c (diff)
Replace reg2unoidl with unoidl-write
...that can also generate an .rdb containing a specific set of entities, intended to replace idlc (when reading directly from .idl source registries). Change-Id: I630ce4640828979d7952dc24dbbef80a42a8140a
Diffstat (limited to 'unoidl/README')
-rw-r--r--unoidl/README21
1 files changed, 11 insertions, 10 deletions
diff --git a/unoidl/README b/unoidl/README
index 84246e9db876..cf405a12a34b 100644
--- a/unoidl/README
+++ b/unoidl/README
@@ -8,16 +8,16 @@ for both the new and the old types.rdb formats (unoidl::loadProvider tries both
implementations in turn for a given file, so the old format is still supported
transparently for now).
-Executable_reg2unoidl is a helper tool to convert from the old to the new
+Executable_unoidl-write is a helper tool to convert from the old to the new
types.rdb format. It is currently used at build-time. idlc still generates the
old format, and any new-format files (used at build-time only, or included in
installation sets in URE or program/types/ or as part of bundled extensions that
are created during the build and not merely included as pre-built .oxt files)
-are explicitly generated via reg2unoidl. The SDK is still designed to generate
-old-format files exclusively (especially, any non-bundled extensions will only
-contain old-format files for now; that allows to modify the new format further
-without having to worry about compatibility with multiple versions of that
-format).
+are explicitly generated via unoidl-write. The SDK is still designed to
+generate old-format files exclusively (especially, any non-bundled extensions
+will only contain old-format files for now; that allows to modify the new format
+further without having to worry about compatibility with multiple versions of
+that format).
== Specification of the new UNOIDL types.rdb format ==
@@ -56,7 +56,7 @@ The following definitions are used throughout:
* Map: zero or more Entries
The file starts with an 8 byte header, followed by information about the root
-map (reg2unoidl generates files in a single depth-first pass, so the root map
+map (unoidl-write generates files in a single depth-first pass, so the root map
itself is at the end of the file):
* 7 byte magic header "UNOIDL\xFF"
@@ -65,11 +65,12 @@ itself is at the end of the file):
* UInt32 number of entries of root Map
...
-Files generated by reg2unoidl follow that by a
+Files generated by unoidl-write follow that by a
- "\0** Created by LibreOffice " LIBO_VERSION_DOTTED " reg2unoidl **\0"
+ "\0** Created by LibreOffice " LIBO_VERSION_DOTTED " unoidl-write **\0"
-banner (cf. config_host/config_version.h.in), as a debugging aid.
+banner (cf. config_host/config_version.h.in), as a debugging aid. (Old versions
+used "reg2unoidl" instead of "unoidl-write" in that banner.)
Layout of per-entry payload in the root or a module Map: