Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Confusing README #56

Closed
konstin opened this issue Jun 21, 2023 · 2 comments
Closed

Confusing README #56

konstin opened this issue Jun 21, 2023 · 2 comments

Comments

@konstin
Copy link

konstin commented Jun 21, 2023

The readme says:

The project is published as tikv-jemallocator and jemallocator for historical reasons. The two crates are the same except names. It's OK to use either crate. But due to lack of permissions, only jemallocator and jemalloc-sys are updated. If you want to use other crates, tikv-xxx versions are still required.

To me, this reads like "use jemallocator over tikv-jemallocator" (maybe incorrectly so!), but if i further, it tells me to use tikv-jemallocator = "0.5". We've discussed in the team and we're confused if we're using the correct crate. Would it be possible to disambiguate the readme paragraph further to make it easier to follow what current best practice is?

@BusyJay
Copy link
Member

BusyJay commented Jun 24, 2023

Currently, the crate we don't have permission to publish is jemallocator-global. So if you need it, then you have to use tikv-jemallocator-global and then all the dependencies will go to tikv-xxx. If you don't need it, choose whichever you like.

@nnethercote
Copy link

I was also confused by this situation. See nnethercote/perf-book#67 for the details.

I recommend changing the README to clarify things, as @konstin suggested. In fact, until you have permission to publish every jemalloc* crate, I would recommend suggesting tikv-jemalloc* everywhere, because that's easier to understand.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants