Skip to content

Commit

Permalink
Rollup merge of #108088 - callumio:issue-107957, r=dtolnay
Browse files Browse the repository at this point in the history
clarify correctness of `black_box`

Resolves #107957, as described in the related issue.

No code changes, just documentation.
  • Loading branch information
matthiaskrgr committed Feb 15, 2023
2 parents 09ab35b + 29621ba commit 863cd15
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion library/core/src/hint.rs
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,8 @@ pub fn spin_loop() {
///
/// Note however, that `black_box` is only (and can only be) provided on a "best-effort" basis. The
/// extent to which it can block optimisations may vary depending upon the platform and code-gen
/// backend used. Programs cannot rely on `black_box` for *correctness* in any way.
/// backend used. Programs cannot rely on `black_box` for *correctness*, beyond it behaving as the
/// identity function.
///
/// [`std::convert::identity`]: crate::convert::identity
///
Expand Down

0 comments on commit 863cd15

Please sign in to comment.