Skip to content

Conversation

@VbhvGupta
Copy link
Contributor

This PR fixes documentation mismatches introduced by cfg changes that exclude Cygwin from certain unix-only APIs.

  • Update docstrings in tokio/src/net/tcp/socket.rs so set_reuseport and reuseport explicitly mention Cygwin alongside Solaris & Illumos.

Rationale:

The implementation cfgs exclude Cygwin (not(target_os = "cygwin")), but the prose still listed only Solaris & Illumos.
That mismatch confuses users who attempt to compile for *-pc-cygwin.
This PR makes docstring consistent with the code.

No runtime or API changes are included here.

@ADD-SP ADD-SP added T-docs Topic: documentation A-tokio Area: The main tokio crate M-net Module: tokio/net labels Sep 17, 2025
Copy link
Member

@ADD-SP ADD-SP left a comment

Choose a reason for hiding this comment

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

Thanks!

@ADD-SP ADD-SP changed the title docs: mention Cygwin exclusion for reuseport net: clarify the supported platform of set_reuseport() and reuseport() Sep 17, 2025
@ADD-SP ADD-SP merged commit c6b16cc into tokio-rs:master Sep 17, 2025
99 checks passed
@Darksonn Darksonn mentioned this pull request Oct 14, 2025
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-net Module: tokio/net T-docs Topic: documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants