Skip to content

Commit 44be6f1

Browse files
committed
Clarify JEMALLOC_OVERRIDE usage
1 parent 371568f commit 44be6f1

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

jemalloc-sys/README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -153,10 +153,15 @@ hyphens `-` are replaced with underscores `_`(see
153153
By default this crate builds and links against a vendored version of `jemalloc`. To
154154
provide your own `jemalloc` version, set `JEMALLOC_OVERRIDE` to point to a built
155155
version of `jemalloc`. This can point to either a shared or static library. For
156-
instance: `JEMALLOC_OVERRIDE=/path/to/libjemalloc.a`. The library should be built
157-
with `jemalloc`'s `--with-jemalloc-prefix=_rjem_`. For static libraries it is also
158-
recommended to build with `--with-private-namespace=_rjem_`. For more information
159-
see [`jemalloc/INSTALL.md`][jemalloc_install].
156+
instance: `JEMALLOC_OVERRIDE=/path/to/libjemalloc.a`.
157+
158+
`JEMALLOC_OVERRIDE` is for advanced usage only. Providing your own library means
159+
most features of jemalloc-sys will be ignored in build script, and you are
160+
responsible for compiling the library to match what `jemalloc-sys` expects.
161+
Especially, handle API prefix as whatever feature
162+
`unprefixed_malloc_on_supported_platforms` says.
163+
164+
For more information see [`jemalloc/INSTALL.md`][jemalloc_install].
160165

161166
[jemalloc_install]: https://github.com/jemalloc/jemalloc/blob/dev/INSTALL.md#advanced-configuration
162167

0 commit comments

Comments
 (0)