diff mbox series

[RFC,liburing,v2,2/2] README: Explain about FFI support

Message ID 20230116142822.717320-3-ammar.faizi@intel.com (mailing list archive)
State New
Headers show
Series Explain about FFI support and how to build liburing | expand

Commit Message

Ammar Faizi Jan. 16, 2023, 2:28 p.m. UTC 
From: Ammar Faizi <ammarfaizi2@gnuweeb.org>

Languages and applications that can't use 'static inline' functions in
liburing.h should use the FFI variants.

Co-authored-by: Christian Mazakas <christian.mazakas@gmail.com>
Signed-off-by: Christian Mazakas <christian.mazakas@gmail.com>
Signed-off-by: Ammar Faizi <ammarfaizi2@gnuweeb.org>
---
 README | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
diff mbox series

Patch

diff --git a/README b/README
index 4dd59f67fcbfbc5e..9c881ae75787795c 100644
--- a/README
+++ b/README
@@ -71,6 +71,30 @@  Building liburing
 See './configure --help' for more information about build config options.
 
 
+FFI support
+-----------
+
+By default, the build results in 4 lib files:
+
+    2 shared libs:
+
+        liburing.so
+        liburing-ffi.so
+
+    2 static libs:
+
+        liburing.a
+        liburing-ffi.a
+
+Languages and applications that can't use 'static inline' functions in
+liburing.h should use the FFI variants.
+
+liburing's main public interface lives in liburing.h as 'static inline'
+functions. Users wishing to consume liburing purely as a binary dependency
+should link against liburing-ffi. It contains definitions for every 'static
+inline' function.
+
+
 License
 -------