diff options
Diffstat (limited to 'upb/bindings/README')
| -rw-r--r-- | upb/bindings/README | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/upb/bindings/README b/upb/bindings/README new file mode 100644 index 0000000..e4bf0b8 --- /dev/null +++ b/upb/bindings/README @@ -0,0 +1,25 @@ +This directory contains code that interfaces upb with external C/C++ +libraries. For example: + + * upb/bindings/{stdc,stdc++} + interfaces between upb and the standard libraries of C and C++ (like C's + FILE/stdio, C++'s string/iostream, etc.) + + * upb/bindings/googlepb + interfaces between upb and the "protobuf" library distributed by Google. + + * upb/bindings/lua: + a Lua extension that exposes upb to Lua programs via the Lua C API. + + * upb/bindings/linux: + code and build system for building upb as a Linux kernel module. + +The two key characteristics that decide whether code belongs in upb/bindings/ +are: + + * Does the code's public API refer to types from another library? + If so it belongs in upb/bindings/. But this doesn't include code that just + happens to use another library internally, as an implementation detail. + + * Would this code be useful to someone who is not using this external library + in some other way? If so, the code probably doesn't belong in upb/bindings/. |