docs: add Windows feature parity matrix to README#3417
Merged
Conversation
Documents the actual Windows feature state so users have realistic expectations: ACLs (-A), xattrs (-X), symlinks, devices, and ownership are stubbed on Windows, while permissions degrade to the read-only flag and IOCP is implemented in fast_io but not yet wired into the transfer pipeline. References tasks #1866 (Windows ACLs), #1867 (Windows xattrs), and #1868 (IOCP wiring).
github-actions
Bot
added
the
documentation
3 tasks
oferchen
added a commit
that referenced
this pull request
May 1, 2026
Documents the actual Windows feature state so users have realistic expectations: ACLs (-A), xattrs (-X), symlinks, devices, and ownership are stubbed on Windows, while permissions degrade to the read-only flag and IOCP is implemented in fast_io but not yet wired into the transfer pipeline. References tasks #1866 (Windows ACLs), #1867 (Windows xattrs), and #1868 (IOCP wiring).
oferchen
added a commit
that referenced
this pull request
May 5, 2026
Documents the actual Windows feature state so users have realistic expectations: ACLs (-A), xattrs (-X), symlinks, devices, and ownership are stubbed on Windows, while permissions degrade to the read-only flag and IOCP is implemented in fast_io but not yet wired into the transfer pipeline. References tasks #1866 (Windows ACLs), #1867 (Windows xattrs), and #1868 (IOCP wiring).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a compact platform feature parity table to README.md so users have realistic expectations about Windows support. The previous wording (
Linux, macOS (full); Windows (partial - no ACLs/xattrs)) understated the gap; the new section documents which features are stubbed and links to the open implementation tasks.The matrix was built from a code-level audit of
#[cfg(unix)]/#[cfg(not(unix))]gates incrates/metadata/andcrates/fast_io/, not from memory:-p)-t)-A)-X)-H)-D)-S)copy_file_rangefcopyfileCopyFileExWA short preamble explains that Linux is the primary platform, macOS is well-supported, and Windows has known gaps with ongoing work.
Closes task #1870. Related implementation tasks: #1866 (Windows ACLs), #1867 (Windows xattrs), #1868 (IOCP benchmark and wiring).
Test plan