doc: list all remove_dir_all fallback targets - #158999
doc: list all remove_dir_all fallback targets#158999Muhtasim-Munif-Fahim wants to merge 2 commits into
Conversation
rustbot
added
S-waiting-on-review
|
Thanks for the pull request, and welcome! The Rust Project is excited to review your changes, and you should hear from @aapoalas (or someone else) some time within the next two weeks. Please see the contribution instructions for more information. Namely, in order to ensure the minimum review times lag, PR authors and assigned reviewers should ensure that the review label (
Why was this reviewer chosen?The reviewer was selected based on:
|
| /// TOCTOU races, Miri will not do so. | ||
| /// - **QNX**, **Redox OS**, **VxWorks**: This function does not protect against TOCTOU races, as | ||
| /// the underlying platform does not implement the required platform support to do so. | ||
| /// - **ESP-IDF**, **Horizon**, **PS Vita**, **QNX**, **Redox OS**, **VxWorks**: This function |
There was a problem hiding this comment.
nitpick (blocking): I'd keep the original phrasing. It's technically wrong for QNX, but that's just a great way to rope the QNX folks in to remove this fallback when libc bindings for the platform are available. When QNX then inevitably gets removed from this list, the original phrasing will be more informative of why there is no TOCTOU protection: because there cannot be.
Also, "the fallback implementation" is only mentioned here so it means nothing to the reader of this documentation, only to the writer. Effectively it is internal documentation and should be in a // comment if anywhere. For a reader it is more important to hear that the reason is in the platform - hearing that the reason is that "this function uses the fallback implementation" sounds like they should come in and open a PR to remove the fallback implementation usage, which is not the case.
... Honestly; I'm not even sure if it's right to mention ESP-IDF, Horizon, and PS Vita here since if they don't have symlink support then there are no symlink TOCTOU races to protect against. But it's fine I guess.
rustbot
removed
the
S-waiting-on-review
|
Reminder, once the PR becomes ready for a review, use |
rustbot
added
the
S-waiting-on-author
Keep the expanded platform list but drop the writer-facing "uses the fallback implementation" wording per review, restoring the original reason phrasing that explains protection is absent because the underlying platform lacks the required support.
3 participants
This adds the still-missing
emove_dir_all fallback targets to the TOCTOU warning and updates the wording to describe the current implementation detail directly.
Closes #153781