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

Doc section for sync module on runtime compatibility #6833

Merged
merged 1 commit into from
Sep 16, 2024

Conversation

jofas
Copy link
Contributor

@jofas jofas commented Sep 9, 2024

Fixes #6832.

@github-actions github-actions bot added the R-loom-sync Run loom sync tests on this PR label Sep 9, 2024
@Darksonn Darksonn added T-docs Topic: documentation A-tokio Area: The main tokio crate M-sync Module: tokio/sync labels Sep 9, 2024
tokio/src/sync/mod.rs Outdated Show resolved Hide resolved
@jofas jofas force-pushed the sync-runtime-agnosticism-docs branch 2 times, most recently from f38b04b to 05f22e9 Compare September 9, 2024 18:07
tokio/src/sync/mod.rs Show resolved Hide resolved
tokio/src/sync/mod.rs Outdated Show resolved Hide resolved
@jofas jofas force-pushed the sync-runtime-agnosticism-docs branch from 05f22e9 to 031344e Compare September 9, 2024 18:42
tokio/src/sync/mod.rs Outdated Show resolved Hide resolved
tokio/src/sync/mod.rs Outdated Show resolved Hide resolved
tokio/src/sync/mpsc/mod.rs Outdated Show resolved Hide resolved
@jofas jofas force-pushed the sync-runtime-agnosticism-docs branch from afbf8c8 to 4ea7da6 Compare September 10, 2024 06:38
Copy link
Contributor

@Darksonn Darksonn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks.

@Darksonn Darksonn merged commit 02aaea2 into tokio-rs:master Sep 16, 2024
81 checks passed
kodiakhq bot pushed a commit to pdylanross/fatigue that referenced this pull request Oct 23, 2024
Bumps tokio from 1.40.0 to 1.41.0.

Release notes
Sourced from tokio's releases.

Tokio v1.41.0
1.41.0 (Oct 22th, 2024)
Added

metrics: stabilize global_queue_depth (#6854, #6918)
net: add conversions for unix SocketAddr (#6868)
sync: add watch::Sender::sender_count (#6836)
sync: add mpsc::Receiver::blocking_recv_many (#6867)
task: stabilize Id apis (#6793, #6891)

Added (unstable)

metrics: add H2 Histogram option to improve histogram granularity (#6897)
metrics: rename some histogram apis (#6924)
runtime: add LocalRuntime (#6808)

Changed

runtime: box futures larger than 16k on release mode (#6826)
sync: add #[must_use] to Notified (#6828)
sync: make watch cooperative (#6846)
sync: make broadcast::Receiver cooperative (#6870)
task: add task size to tracing instrumentation (#6881)
wasm: enable cfg_fs for wasi target (#6822)

Fixed

net: fix regression of abstract socket path in unix socket (#6838)

Documented

io: recommend OwnedFd with AsyncFd (#6821)
io: document cancel safety of AsyncFd methods (#6890)
macros: render more comprehensible documentation for join and try_join (#6814, #6841)
net: fix swapped examples for TcpSocket::set_nodelay and TcpSocket::nodelay (#6840)
sync: document runtime compatibility (#6833)

#6793: tokio-rs/tokio#6793
#6808: tokio-rs/tokio#6808
#6810: tokio-rs/tokio#6810
#6814: tokio-rs/tokio#6814
#6821: tokio-rs/tokio#6821
#6822: tokio-rs/tokio#6822
#6826: tokio-rs/tokio#6826
#6828: tokio-rs/tokio#6828
#6833: tokio-rs/tokio#6833
#6836: tokio-rs/tokio#6836
#6838: tokio-rs/tokio#6838
#6840: tokio-rs/tokio#6840


... (truncated)


Commits

01e04da chore: prepare Tokio v1.41.0 (#6917)
92ccade runtime: fix stability feature flags for docs (#6909)
fbfeb9a metrics: rename *_poll_count_* to *_poll_time_* (#6924)
da745ff metrics: add H2 Histogram option to improve histogram granularity (#6897)
ce1c74f metrics: fix deadlock in injection_queue_depth_multi_thread test (#6916)
28c9a14 metrics: rename injection_queue_depth to global_queue_depth (#6918)
32e0b43 ci: freeze FreeBSD and wasm-unknown-unknown on rustc 1.81 (#6911)
1656d8e sync: add mpsc::Receiver::blocking_recv_many (#6867)
c9e998e ci: print the correct sort order of the dictionary on failure (#6905)
512e9de rt: add LocalRuntime (#6808)
Additional commits viewable in compare view




Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR
@dependabot recreate will recreate this PR, overwriting any edits that have been made to it
@dependabot merge will merge this PR after your CI passes on it
@dependabot squash and merge will squash and merge this PR after your CI passes on it
@dependabot cancel merge will cancel a previously requested merge and block automerging
@dependabot reopen will reopen this PR if it is closed
@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
@dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-tokio Area: The main tokio crate M-sync Module: tokio/sync R-loom-sync Run loom sync tests on this PR T-docs Topic: documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documenting the fact that the sync module is runtime agnostic
2 participants