doc: list all remove_dir_all fallback targets - #158999
Conversation
|
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.
|
Reminder, once the PR becomes ready for a review, use |
|
Updated the docs to drop the implementation-detail wording and restored the original phrasing explaining the platform limitation. The expanded platform list (ESP-IDF, Horizon, PS Vita, QNX, Redox OS, VxWorks) is kept. Ready for re-review. |
|
Unknown argument "r+". Did you mean to use |
|
@bors squash |
This comment has been minimized.
This comment has been minimized.
* doc: list all remove_dir_all fallback targets * doc: restore original TOCTOU phrasing for remove_dir_all fallback list 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. Co-authored-by: Md Muhtasim Munif Fahim <s1911024120@ru.ac.bd>
|
@bors r+ rollup |
|
🔨 2 commits were squashed into 9f30bc4. This pull request was unapproved. |
eb3629f to
9f30bc4
Compare
|
|
@bors r+ |
…move-dir-all-docs, r=aapoalas doc: list all remove_dir_all fallback targets 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 rust-lang#153781
…move-dir-all-docs, r=aapoalas doc: list all remove_dir_all fallback targets 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 rust-lang#153781
…uwer Rollup of 26 pull requests Successful merges: - #161384 (Bust sccache's cache) - #161325 (Bump bootstrap to 1.99.0-beta.1) - #161344 (Update the `rustc-perf` submodule) - #161366 (Subtree sync for rustc_codegen_cranelift) - #159071 ([PAC] Encoder and hash (1/8)) - #160639 ([rustdoc] Only generate search DOM elements if the search is actually needed) - #161068 (Ensure TLS accesses don't call the global allocator through panic (part 3) ) - #161332 (Some `GlobalCtxt`/`Session` cleanups) - #150931 (rustdoc: Always document `#[repr(transparent)]` if `#[rustc_pub_transparent]` is applied) - #158999 (doc: list all remove_dir_all fallback targets) - #160582 (Add `remove hidden_glob_reexports item breaks downstream` test) - #160876 (remove unwrap from write_mir_fn_graphviz) - #160927 (Enhance EII UI tests) - #161070 (fix arm homogeneous aggregate ABI) - #161190 (fix crash in async-drop and async-gen) - #161236 (Download auto jobs in citool in parallel) - #161254 (Reserve capacity for 3% anon nodes) - #161283 (Tighten the language used for documenting `TargetOptions::llvm_abiname`) - #161291 (Rename `ProjectionPredicate` and `TraitPredicate`) - #161293 (add relnotes 1.98.0) - #161299 (Remove a bunch of unnecessary explicit lifetimes) - #161307 (make ARM maintainers pingable) - #161308 (Add regression test for rustc diagnostic to recognize variables in match guards) - #161346 (Don't rely on std traits not being const in tests) - #161360 (vec: fixup the name that i forgot) - #161367 (Reflect current PR title names for subtree syncs in triagebot no-merges)
Rollup merge of #158999 - Muhtasim-Munif-Fahim:codex/rust-remove-dir-all-docs, r=aapoalas doc: list all remove_dir_all fallback targets 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
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