Skip to content

Commit

Permalink
Update features documentation in README file
Browse files Browse the repository at this point in the history
Signed-off-by: Michael Rieder <[email protected]>
  • Loading branch information
miried committed Oct 16, 2024
1 parent 9b665ce commit e0d428e
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions jemallocator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit e0d428e

Please sign in to comment.