Skip to content

Commit dbcf9f4

Browse files
aviramhaRazz4780
authored andcommitted
add docs
1 parent ca21eb3 commit dbcf9f4

File tree

2 files changed

+9
-0
lines changed

2 files changed

+9
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -176,6 +176,10 @@ the system's version of librdkafka. Example:
176176
rdkafka = { version = "0.25", features = ["dynamic-linking"] }
177177
```
178178

179+
If you'd like to compile librdkafka statically yourself, then use
180+
that, you can use `static-linking` while supplying `DEP_LIBRDKAFKA_STATIC_ROOT`
181+
with path to where librdkafka was built.
182+
179183
For a full listing of features, consult the [rdkafka-sys crate's
180184
documentation][rdkafka-sys-features]. All of rdkafka-sys features are
181185
re-exported as rdkafka features.

rdkafka-sys/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,11 @@ system, and it will configure the compiler to dynamically link against it.
4545
The system version of librdkafka must exactly match the version of
4646
librdkafka bundled with this crate.
4747

48+
The **`static-linking`** feature can be used to link rdkafka to a locally
49+
built version of librdkafka: if the feature is enabled, the build script
50+
will try to find `DEP_LIBRDKAFKA_STATIC_ROOT` environment variable
51+
and it will statically link against it.
52+
4853
The **`cmake-build`** feature builds librdkafka with its [CMake] build
4954
system, rather than its default [mklove]-based build system. This feature
5055
requires that CMake is installed on the build machine.

0 commit comments

Comments
 (0)