Rollup merge of #102188 - flba-eb:doc_missed_at_rename, r=jyn514

Update doc after renaming `fn is_zero`

`fn is_zero` has been renamed to `fn count_is_zero` in 1b1bf24636.
This patch updates the documentation accordingly.
This commit is contained in:
Matthias Krüger 2022-09-24 07:38:57 +02:00 committed by GitHub
commit be902e8905
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -300,7 +300,7 @@ pub mod panic_count {
thread_local! { static LOCAL_PANIC_COUNT: Cell<usize> = const { Cell::new(0) } } thread_local! { static LOCAL_PANIC_COUNT: Cell<usize> = const { Cell::new(0) } }
// Sum of panic counts from all threads. The purpose of this is to have // Sum of panic counts from all threads. The purpose of this is to have
// a fast path in `is_zero` (which is used by `panicking`). In any particular // a fast path in `count_is_zero` (which is used by `panicking`). In any particular
// thread, if that thread currently views `GLOBAL_PANIC_COUNT` as being zero, // thread, if that thread currently views `GLOBAL_PANIC_COUNT` as being zero,
// then `LOCAL_PANIC_COUNT` in that thread is zero. This invariant holds before // then `LOCAL_PANIC_COUNT` in that thread is zero. This invariant holds before
// and after increase and decrease, but not necessarily during their execution. // and after increase and decrease, but not necessarily during their execution.
@ -369,7 +369,7 @@ pub fn count_is_zero() -> bool {
} }
// Slow path is in a separate function to reduce the amount of code // Slow path is in a separate function to reduce the amount of code
// inlined from `is_zero`. // inlined from `count_is_zero`.
#[inline(never)] #[inline(never)]
#[cold] #[cold]
fn is_zero_slow_path() -> bool { fn is_zero_slow_path() -> bool {