Activity

1. ehuss

   added

   C-tracking-issueCategory: An issue tracking the progress of sth. like the implementation of an RFCCategory: An issue tracking the progress of sth. like the implementation of an RFC

   T-rustdoc

   on Apr 28, 2021
2. jyn514

   added

   T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.Relevant to the rustdoc team, which will review and decide on the PR/issue.

   and removed

   T-rustdoc

   on May 7, 2021
3. Swatinem commented on Oct 28, 2022

   

   Swatinem

   on Oct 28, 2022

   Contributor

   More actions

   Request for Stabilization

   I opened #103682 with the aim to stabilize this rustdoc flag, primarily to facilitate the cargo doctest-in-workspace flag, and to eventually making it the default.

   Summary

   The --test-run-directory flag in combination with --test allows specifying an explicit directory in which rustdoc will run the compiled doctests. The default, without this explicit flag, is to run the resulting doctest binaries in the same current working directory as rustdoc itself.

   This flag is primarily the building block for the doctest-in-workspace cargo flag (See rust-lang/cargo#9427).

   With that flag, doctests are handled consistently to unit- and integration tests: They will be compiled relative to the cargo workspace root, but they are run in the crate directory.

   Documentation

   The flag is currently not documented as part of the unstable rustdoc features.

   Tests

   • src/test/rustdoc-ui/run-directory.rs -- highlights usage with cwd-sensitive std::fs functions inside doctests.
   • cargo tests/testsuite/doc.rs -- shows indirect usage via the cargo doctest-in-workspace flag.

   Unresolved questions

   • Similar flags that allow hooking into or observing the side effects of rustdoc test compilation, such as --run-tool or --persist-doctests are not stable yet, and there does not seem to be a push to stabilization either.
   • The usefulness of this flag when invoking rustdoc manually might be limited. But it is a requirement for the cargo doctest-in-workspace flag.
   • ☝🏻 Is there maybe a better alternative to solve the compile/run directory inconsistency that exists in cargo workspaces today?
4. Swatinem commented on Nov 9, 2022

   

   Swatinem

   on Nov 9, 2022

   Contributor

   More actions

   @ehuss over in rust-lang/cargo#9427 (comment) expressed agreement to make the doctest-in-workspace cargo flag the default, considering it rather a bugfix for the current inconsistent behavior.

   However, stabilizing --test-run-directory is a requirement for that, and there does not seem to be a better alternative to it.

   @GuillaumeGomez is there anything I can do to move stabilization (#103682) forward?
5. GuillaumeGomez commented on Nov 9, 2022

   

   GuillaumeGomez

   on Nov 9, 2022

   Member

   More actions

   Next step is the FCP. I'll start on the PR.
6. DXist commented on Feb 20, 2023

   

   DXist

   on Feb 20, 2023

   Last edited by DXist

   More actions

   cargo test runs doc tests by default and doesn't allow to specify --test-run-directory.

   My project uses sqlx which tries to create target/sqlx/<crate_name>/ directory. But if fails because I run the build inside a container against immutable source.

   Instead I expect that the test should stay in the workspace directory and use <workspace_root>/target which is mounted as a build cache volume.
7. JohnTitor

   added a commit that references this issue on Apr 14, 2023

   Rollup merge of rust-lang#103682 - Swatinem:stable-run-directory, r=G…

   ...

   9aa24fd
8. bors

   closed this as completedin 9aa24fdon Apr 14, 2023