[RFC PATCH liburing v2 0/2] Explain about FFI support and how to build liburing

[RFC PATCH liburing v2 0/2] Explain about FFI support and how to build liburing

[Ammar Faizi]

From: Ammar Faizi <ammarfaizi2@gnuweeb.org>

v
v

Signed-off-by: Ammar Faizi <ammarfaizi2@gnuweeb.org>
---

Ammar Faizi (2):
  README: Explain how to build liburing
  README: Explain about FFI support

 README | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 48 insertions(+)


base-commit: 19424b0baa5999918701e1972b901b0937331581
-- 
Ammar Faizi

[RFC PATCH liburing v2 1/2] README: Explain how to build liburing

[Ammar Faizi]

From: Ammar Faizi <ammarfaizi2@gnuweeb.org>

Tell people how to build liburing.

Signed-off-by: Ammar Faizi <ammarfaizi2@gnuweeb.org>
---
 README | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/README b/README
index 80d2b3dc5d5eaf76..4dd59f67fcbfbc5e 100644
--- a/README
+++ b/README
@@ -47,6 +47,30 @@ the kernel io_uring support. Please note that this suite isn't expected to
 pass on older kernels, and may even crash or hang older kernels!
 
 
+Building liburing
+-----------------
+
+    #
+    # Prepare build config (optional).
+    #
+    #  --cc  specifies the C   compiler.
+    #  --cxx speficies the C++ compiler.
+    #
+    ./configure --cc=gcc --cxx=g++;
+
+    #
+    # Build liburing.
+    #
+    make -j$(nproc);
+
+    #
+    # Install liburing (headers, shared/static libs, and manpage).
+    #
+    sudo make install;
+
+See './configure --help' for more information about build config options.
+
+
 License
 -------
 
-- 
Ammar Faizi

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

[Ammar Faizi]

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 --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
 -------
 
-- 
Ammar Faizi

Re: [RFC PATCH liburing v2 0/2] Explain about FFI support and how to build liburing

[Ammar Faizi]

On 1/16/23 9:28 PM, Ammar Faizi wrote:
> From: Ammar Faizi <ammarfaizi2@gnuweeb.org>
> 
> v
> v

Sorry, wrong cover letter, missed it when sending. But the patchset
diff and changelog are all good.

-- 
Ammar Faizi

Re: [RFC PATCH liburing v2 0/2] Explain about FFI support and how to build liburing

[Jens Axboe]

On Mon, 16 Jan 2023 21:28:20 +0700, Ammar Faizi wrote:
> v
> v
> 
> 

Applied, thanks!

[1/2] README: Explain how to build liburing
      commit: 888e608937c2a052e01bc3730dc4ae9bcff4b3e2
[2/2] README: Explain about FFI support
      commit: 808b972006716090c18ee1305a23f2148ed97434

Best regards,
-- 
Jens Axboe