Skip to content

Commit 23b10f2

Browse files
bors[bot]taiki-e
bors[bot]
and
taiki-e
authored
Merge #887
887: Update readme r=taiki-e a=taiki-e cc #635 Co-authored-by: Taiki Endo <[email protected]>
2 parents 7181f02 + b235917 commit 23b10f2

File tree

5 files changed

+38
-35
lines changed

5 files changed

+38
-35
lines changed

‎README.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -46,19 +46,19 @@ This crate provides a set of tools for concurrent programming:
4646
*Features marked with <sup>(alloc)</sup> can be used in `no_std` environments, but only if `alloc`
4747
feature is enabled.*
4848

49-
[`AtomicCell`]: https://docs.rs/crossbeam/*/crossbeam/atomic/struct.AtomicCell.html
50-
[`AtomicConsume`]: https://docs.rs/crossbeam/*/crossbeam/atomic/trait.AtomicConsume.html
51-
[`deque`]: https://docs.rs/crossbeam/*/crossbeam/deque/index.html
52-
[`ArrayQueue`]: https://docs.rs/crossbeam/*/crossbeam/queue/struct.ArrayQueue.html
53-
[`SegQueue`]: https://docs.rs/crossbeam/*/crossbeam/queue/struct.SegQueue.html
54-
[`channel`]: https://docs.rs/crossbeam/*/crossbeam/channel/index.html
55-
[`Parker`]: https://docs.rs/crossbeam/*/crossbeam/sync/struct.Parker.html
56-
[`ShardedLock`]: https://docs.rs/crossbeam/*/crossbeam/sync/struct.ShardedLock.html
57-
[`WaitGroup`]: https://docs.rs/crossbeam/*/crossbeam/sync/struct.WaitGroup.html
58-
[`epoch`]: https://docs.rs/crossbeam/*/crossbeam/epoch/index.html
59-
[`Backoff`]: https://docs.rs/crossbeam/*/crossbeam/utils/struct.Backoff.html
60-
[`CachePadded`]: https://docs.rs/crossbeam/*/crossbeam/utils/struct.CachePadded.html
61-
[`scope`]: https://docs.rs/crossbeam/*/crossbeam/fn.scope.html
49+
[`AtomicCell`]: https://docs.rs/crossbeam/latest/crossbeam/atomic/struct.AtomicCell.html
50+
[`AtomicConsume`]: https://docs.rs/crossbeam/latest/crossbeam/atomic/trait.AtomicConsume.html
51+
[`deque`]: https://docs.rs/crossbeam/latest/crossbeam/deque/index.html
52+
[`ArrayQueue`]: https://docs.rs/crossbeam/latest/crossbeam/queue/struct.ArrayQueue.html
53+
[`SegQueue`]: https://docs.rs/crossbeam/latest/crossbeam/queue/struct.SegQueue.html
54+
[`channel`]: https://docs.rs/crossbeam/latest/crossbeam/channel/index.html
55+
[`Parker`]: https://docs.rs/crossbeam/latest/crossbeam/sync/struct.Parker.html
56+
[`ShardedLock`]: https://docs.rs/crossbeam/latest/crossbeam/sync/struct.ShardedLock.html
57+
[`WaitGroup`]: https://docs.rs/crossbeam/latest/crossbeam/sync/struct.WaitGroup.html
58+
[`epoch`]: https://docs.rs/crossbeam/latest/crossbeam/epoch/index.html
59+
[`Backoff`]: https://docs.rs/crossbeam/latest/crossbeam/utils/struct.Backoff.html
60+
[`CachePadded`]: https://docs.rs/crossbeam/latest/crossbeam/utils/struct.CachePadded.html
61+
[`scope`]: https://docs.rs/crossbeam/latest/crossbeam/fn.scope.html
6262

6363
## Crates
6464

‎crossbeam-channel/README.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -25,15 +25,15 @@ Some highlights:
2525
* Channels use locks very sparingly for maximum [performance](benchmarks).
2626

2727
[`std::sync::mpsc`]: https://doc.rust-lang.org/std/sync/mpsc/index.html
28-
[`Sender`]: https://docs.rs/crossbeam-channel/*/crossbeam_channel/struct.Sender.html
29-
[`Receiver`]: https://docs.rs/crossbeam-channel/*/crossbeam_channel/struct.Receiver.html
30-
[`bounded`]: https://docs.rs/crossbeam-channel/*/crossbeam_channel/fn.bounded.html
31-
[`unbounded`]: https://docs.rs/crossbeam-channel/*/crossbeam_channel/fn.unbounded.html
32-
[`after`]: https://docs.rs/crossbeam-channel/*/crossbeam_channel/fn.after.html
33-
[`never`]: https://docs.rs/crossbeam-channel/*/crossbeam_channel/fn.never.html
34-
[`tick`]: https://docs.rs/crossbeam-channel/*/crossbeam_channel/fn.tick.html
35-
[`select!`]: https://docs.rs/crossbeam-channel/*/crossbeam_channel/macro.select.html
36-
[`Select`]: https://docs.rs/crossbeam-channel/*/crossbeam_channel/struct.Select.html
28+
[`Sender`]: https://docs.rs/crossbeam-channel/latest/crossbeam_channel/struct.Sender.html
29+
[`Receiver`]: https://docs.rs/crossbeam-channel/latest/crossbeam_channel/struct.Receiver.html
30+
[`bounded`]: https://docs.rs/crossbeam-channel/latest/crossbeam_channel/fn.bounded.html
31+
[`unbounded`]: https://docs.rs/crossbeam-channel/latest/crossbeam_channel/fn.unbounded.html
32+
[`after`]: https://docs.rs/crossbeam-channel/latest/crossbeam_channel/fn.after.html
33+
[`never`]: https://docs.rs/crossbeam-channel/latest/crossbeam_channel/fn.never.html
34+
[`tick`]: https://docs.rs/crossbeam-channel/latest/crossbeam_channel/fn.tick.html
35+
[`select!`]: https://docs.rs/crossbeam-channel/latest/crossbeam_channel/macro.select.html
36+
[`Select`]: https://docs.rs/crossbeam-channel/latest/crossbeam_channel/struct.Select.html
3737

3838
## Usage
3939

‎crossbeam-queue/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ This crate provides concurrent queues that can be shared among threads:
2020
Everything in this crate can be used in `no_std` environments, provided that `alloc` feature is
2121
enabled.
2222

23-
[`ArrayQueue`]: https://docs.rs/crossbeam-queue/*/crossbeam_queue/struct.ArrayQueue.html
24-
[`SegQueue`]: https://docs.rs/crossbeam-queue/*/crossbeam_queue/struct.SegQueue.html
23+
[`ArrayQueue`]: https://docs.rs/crossbeam-queue/latest/crossbeam_queue/struct.ArrayQueue.html
24+
[`SegQueue`]: https://docs.rs/crossbeam-queue/latest/crossbeam_queue/struct.SegQueue.html
2525

2626
## Usage
2727

‎crossbeam-skiplist/README.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,15 @@ https://docs.rs/crossbeam-skiplist)
1212
https://www.rust-lang.org)
1313
[![chat](https://img.shields.io/discord/569610676205781012.svg?logo=discord)](https://discord.com/invite/JXYwgWZ)
1414

15-
**Note:** This crate is still a work in progress.
15+
This crate provides the types [`SkipMap`] and [`SkipSet`].
16+
These data structures provide an interface similar to `BTreeMap` and `BTreeSet`,
17+
respectively, except they support safe concurrent access across multiple threads.
1618

1719
This crate can be used in `no_std` environments that implement `alloc`. The `alloc` feature of this crate needs to be enabled in `no_std` environments.
1820

19-
<!--
21+
[`SkipMap`]: https://docs.rs/crossbeam-skiplist/latest/crossbeam_skiplist/struct.SkipMap.html
22+
[`SkipSet`]: https://docs.rs/crossbeam-skiplist/latest/crossbeam_skiplist/struct.SkipSet.html
23+
2024
## Usage
2125

2226
Add this to your `Cargo.toml`:
@@ -25,7 +29,6 @@ Add this to your `Cargo.toml`:
2529
[dependencies]
2630
crossbeam-skiplist = "0.1"
2731
```
28-
-->
2932

3033
## Compatibility
3134

‎crossbeam-utils/README.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -33,14 +33,14 @@ This crate provides miscellaneous tools for concurrent programming:
3333

3434
*Features marked with <sup>(no_std)</sup> can be used in `no_std` environments.*<br/>
3535

36-
[`AtomicCell`]: https://docs.rs/crossbeam-utils/*/crossbeam_utils/atomic/struct.AtomicCell.html
37-
[`AtomicConsume`]: https://docs.rs/crossbeam-utils/*/crossbeam_utils/atomic/trait.AtomicConsume.html
38-
[`Parker`]: https://docs.rs/crossbeam-utils/*/crossbeam_utils/sync/struct.Parker.html
39-
[`ShardedLock`]: https://docs.rs/crossbeam-utils/*/crossbeam_utils/sync/struct.ShardedLock.html
40-
[`WaitGroup`]: https://docs.rs/crossbeam-utils/*/crossbeam_utils/sync/struct.WaitGroup.html
41-
[`Backoff`]: https://docs.rs/crossbeam-utils/*/crossbeam_utils/struct.Backoff.html
42-
[`CachePadded`]: https://docs.rs/crossbeam-utils/*/crossbeam_utils/struct.CachePadded.html
43-
[`scope`]: https://docs.rs/crossbeam-utils/*/crossbeam_utils/thread/fn.scope.html
36+
[`AtomicCell`]: https://docs.rs/crossbeam-utils/latest/crossbeam_utils/atomic/struct.AtomicCell.html
37+
[`AtomicConsume`]: https://docs.rs/crossbeam-utils/latest/crossbeam_utils/atomic/trait.AtomicConsume.html
38+
[`Parker`]: https://docs.rs/crossbeam-utils/latest/crossbeam_utils/sync/struct.Parker.html
39+
[`ShardedLock`]: https://docs.rs/crossbeam-utils/latest/crossbeam_utils/sync/struct.ShardedLock.html
40+
[`WaitGroup`]: https://docs.rs/crossbeam-utils/latest/crossbeam_utils/sync/struct.WaitGroup.html
41+
[`Backoff`]: https://docs.rs/crossbeam-utils/latest/crossbeam_utils/struct.Backoff.html
42+
[`CachePadded`]: https://docs.rs/crossbeam-utils/latest/crossbeam_utils/struct.CachePadded.html
43+
[`scope`]: https://docs.rs/crossbeam-utils/latest/crossbeam_utils/thread/fn.scope.html
4444

4545
## Usage
4646

0 commit comments

Comments
 (0)