Update git submodules
[LibreOffice.git] / offapi / README.md
blob1d35bd2ca51a3787d67432e52fa627943648de83
1 # LibreOffice API IDL Files Except UDK API
3 Contains all of the IDL files except those in `udkapi`.
5 i.e. the interfaces that are specific to the LibreOffice application.
6 An artificial (?) separation.
8 The reference `offapi/type_reference/offapi.idl` and
9 `udkapi/type_reference/udkapi.idl` (formerly combined into a single
10 `offapi/type_reference/types.rdb`) are used to detect inadvertent incompatible
11 changes.  They are plain-text `.idl` files (not strictly lexicographically sorted,
12 though, so they satisfy the `.idl` file requirements for no forward dependencies),
13 so in cases where we deliberately /do/ become incompatible they can be modified
14 manually.
16 Old such cases of deliberately becoming incompatible are listed in
17 `offapi/type_reference/typelibrary_history.txt`, newer such cases are recorded in
18 the `git log`s of (now superseded) `offapi/type_reference/types.rdb`,
19 `offapi/type_reference/offapi.rdb`, and `udkapi/type_reference/udkapi.rdb`, new such
20 cases are recorded in the `git log`s of `offapi/type_reference/offapi.idl` and
21 `udkapi/type_reference/udkapi.idl`.