From e0d428e1d143eae2d8ec6503b4136028631d52ff Mon Sep 17 00:00:00 2001 From: Michael Rieder Date: Wed, 16 Oct 2024 08:21:53 +0200 Subject: [PATCH] Update features documentation in README file Signed-off-by: Michael Rieder --- jemallocator/README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/jemallocator/README.md b/jemallocator/README.md index 43e00d106..207a51d55 100644 --- a/jemallocator/README.md +++ b/jemallocator/README.md @@ -69,8 +69,14 @@ other targets are only tested on Rust nightly. ## Features -The `tikv-jemallocator` crate re-exports the [features of the `tikv-jemalloc-sys` -dependency](https://github.com/tikv/jemallocator/blob/master/jemalloc-sys/README.md). +This crate provides following cargo feature flags: + +* `alloc_trait` When the `alloc_trait` feature of this crate is enabled, it also implements the `Alloc` trait, allowing usage in collections. + +* `default` feature is `background_threads_runtime_support`. + +* The `tikv-jemallocator` crate re-exports the [features of the `tikv-jemalloc-sys` +dependency](https://github.com/tikv/jemallocator/blob/master/jemalloc-sys/README.md#features). ## License