Skip to content

Add notice that hashbrown removed these functions for not helping LLVM consistently #1

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

Merged
merged 3 commits into from
Nov 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

This document contains all changes to the crate since version 0.4.3

## 0.4.7

- Add notice to README that these functions were removed from `hashbrown` for not helping LLVM consistently. Context: https://github.com/rust-lang/hashbrown/issues/482.

## 0.4.6

- Lower the `rust-version` to 1.38.0 by using Rust edition 2015.
Expand Down
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "branch_hints"
version = "0.4.6"
version = "0.4.7"
edition = "2015"
authors = ["Johanna Sörngård ([email protected])"]
license = "MIT OR Apache-2.0"
Expand Down
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,14 @@ if likely(condition) {
and they should be optimized away by the compiler.

## Credit
The functions are taken directly from the [hashbrown](https://crates.io/crates/hashbrown) crate and this crate simply exposes them, all credit belongs to the hashbrown authors.
The functions are taken directly from the [`hashbrown`](https://crates.io/crates/hashbrown) crate and this crate simply exposes them, all credit belongs to the hashbrown authors.

## Note
This is a very minimal crate. If you want more comprehensive functionality, take a look at the [likely_stable](https://crates.io/crates/likely_stable) crate.

`hashbrown`'s implementation of these functions [has been removed](https://github.com/rust-lang/hashbrown/commit/d677fd42df6978522045a9561242588ef970ed0c) with the motivation that they do not help LLVM consistently.
Verify for yourself with benchmarks if these functions do anything for you.

<br>

### License
Expand Down