File tree Expand file tree Collapse file tree 1 file changed +20
-0
lines changed
src/native/include/mono-2.0 Expand file tree Collapse file tree 1 file changed +20
-0
lines changed Original file line number Diff line number Diff line change
1
+ # The Mono Embedding API #
2
+
3
+ The headers in this directory constitute the ` mono-2.0 ` runtime embedding API. They represent a
4
+ contract between the runtime and clients. Care must be taken to ensure that API and ABI
5
+ compatibility is not broken. For example: adding or removing function arguments, changing the
6
+ return type, changing the layout of defined non-opaque structs, changing the calling convention, etc
7
+ may potentially break existing clients and should not be undertaken lightly.
8
+
9
+ Adding functions constitutes a contract between the runtime and potential future clients. Adding a
10
+ new public API function incurs a maintenance cost. Care should be taken.
11
+
12
+ ## Unstable embedding API ##
13
+
14
+ The headers ` mono-private-unstable.h ` in each subdirectory are an exception to the above guarantees.
15
+ Functions added to these headers represent "work in progress" and may break API semantics or ABI
16
+ compatability. Clients using these functions are generally tightly coupled to the development of
17
+ the runtime and take on responsibility for any breaking changes.
18
+
19
+
20
+
You can’t perform that action at this time.
0 commit comments