summaryrefslogtreecommitdiff
path: root/offapi/README
diff options
context:
space:
mode:
authorStephan Bergmann <sbergman@redhat.com>2013-09-18 13:38:21 +0200
committerStephan Bergmann <sbergman@redhat.com>2013-09-18 14:44:10 +0200
commit8001d9f4fed8f32410128b180d881d1131317255 (patch)
tree69bf3c4656432fcf6b1139892dd99feb7dc7024e /offapi/README
parentcbea5d30b99b93b2118f5c1a081740e5880f18c1 (diff)
Replace binary type_references with human-readable .idl versions
...obtained from the old .rdb files via "unoidl-read --published". This removes the need for update-rdb.sh. Change-Id: I73c0d026af7e27370602f83c61dfa76fc4d17a83
Diffstat (limited to 'offapi/README')
-rw-r--r--offapi/README23
1 files changed, 14 insertions, 9 deletions
diff --git a/offapi/README b/offapi/README
index 90c4ee5290dd..4417ecc749b6 100644
--- a/offapi/README
+++ b/offapi/README
@@ -3,12 +3,17 @@ Contains all of the IDL files except those in [[udkapi]]
i.e. the interfaces that are specific to the OppenOffice.org application.
An artificial (?) separation.
-The reference offapi/type_reference/offapi.rdb and
-udkapi/type_reference/udkapi.rdb (formerly combined into a single
-offapi/type_reference/types.rdb), used to detect inadvertent incompatible
-changes, are maintained via offapi/type_reference/update-rdb.sh (see its usage
-message for details) for cases where we deliberately /do/ become incompatible.
-Old such cases are listed in offapi/type_reference/typelibrary_history.txt,
-newer such cases are recorded in the git log of (now removed)
-offapi/type_reference/types.rdb, new such cases are recorded in the git logs of
-offapi/type_reference/offapi.rdb and udkapi/type_reference/udkapi.rdb.
+The reference offapi/type_reference/offapi.idl and
+udkapi/type_reference/udkapi.idl (formerly combined into a single
+offapi/type_reference/types.rdb) are used to detect inadvertent incompatible
+changes. They are plain-text .idl files (not stricly lexicographically sorted,
+though, so they satisfy the .idl file requirements for no forward dependencies),
+so in cases where we deliberately /do/ become incompatible they can be modified
+manually.
+
+Old such cases of deliberately becoming incompatible are listed in
+offapi/type_reference/typelibrary_history.txt, newer such cases are recorded in
+the git logs of (now superseded) offapi/type_reference/types.rdb,
+offapi/type_reference/offapi.rdb, and udkapi/type_reference/udkapi.rdb, new such
+cases are recorded in the git logs of offapi/type_reference/offapi.idl and
+udkapi/type_reference/udkapi.idl.