path: root/offapi/README
diff options
authorStephan Bergmann <>2012-12-12 18:15:01 +0100
committerStephan Bergmann <>2012-12-12 18:15:01 +0100
commit6a10f561d9e9cde17534bad7bf0497c9f74ece9e (patch)
treed79ca17531712860a7c1dedaae302f974e4f8c58 /offapi/README
parent3a14fa971f132b6d02cef5e97166972c7873a582 (diff)
Clean up offapi/type_reference/ documentation
Change-Id: I07d79291d161cf5c1ecc9db557d5025437ca2cc1
Diffstat (limited to 'offapi/README')
1 files changed, 7 insertions, 0 deletions
diff --git a/offapi/README b/offapi/README
index c33424d4a7e5..a8f3a9b442f4 100644
--- a/offapi/README
+++ b/offapi/README
@@ -2,3 +2,10 @@ Contains all of the IDL files except those in [[udkapi]]
i.e. the interfaces that are specific to the application.
An artificial (?) separation.
+The reference offapi/type_reference/types.rdb, used to detect inadvertent
+incompatible changes, is maintained via offapi/type_reference/ (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, new such cases are recorded in
+the git log of offapi/type_reference/types.rdb.