summaryrefslogtreecommitdiffstats
path: root/offapi/README
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-27 16:51:28 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-27 16:51:28 +0000
commit940b4d1848e8c70ab7642901a68594e8016caffc (patch)
treeeb72f344ee6c3d9b80a7ecc079ea79e9fba8676d /offapi/README
parentInitial commit. (diff)
downloadlibreoffice-1ad18e38974bb28c3d98d0be8f7d8c18fc56de29.tar.xz
libreoffice-1ad18e38974bb28c3d98d0be8f7d8c18fc56de29.zip
Adding upstream version 1:7.0.4.upstream/1%7.0.4upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'offapi/README')
-rw-r--r--offapi/README19
1 files changed, 19 insertions, 0 deletions
diff --git a/offapi/README b/offapi/README
new file mode 100644
index 000000000..80c60484d
--- /dev/null
+++ b/offapi/README
@@ -0,0 +1,19 @@
+Contains all of the IDL files except those in [[udkapi]]
+
+i.e. the interfaces that are specific to the LibreOffice application.
+An artificial (?) separation.
+
+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 strictly 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.