Doctest persist full binaries when persisting by prconrad · Pull Request #88269 · rust-lang/rust (original) (raw)

Conversation

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

[ Show hidden characters]({{ revealButtonHref }})

prconrad changed the titleDoctest persist full binaries when persisting #88110 Doctest persist full binaries when persisting

Aug 23, 2021

jyn514 added A-doctests

Area: Documentation tests, run by rustdoc

T-rustdoc

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

labels

Aug 23, 2021

jyn514 added S-waiting-on-author

Status: This is awaiting some action (such as code changes or more information) from the author.

and removed S-waiting-on-review

Status: Awaiting review from the assignee but also interested parties.

labels

Aug 23, 2021

jyn514 added S-waiting-on-review

Status: Awaiting review from the assignee but also interested parties.

and removed S-waiting-on-author

Status: This is awaiting some action (such as code changes or more information) from the author.

labels

Aug 25, 2021

bors added S-waiting-on-bors

Status: Waiting on bors to run and complete tests. Bors will change the label on completion.

and removed S-waiting-on-review

Status: Awaiting review from the assignee but also interested parties.

labels

Aug 26, 2021

Manishearth added a commit to Manishearth/rust that referenced this pull request

Aug 27, 2021

…r=jyn514

Doctest persist full binaries when persisting

Tested by adding an extra debug to echo the whole compiler line. Trimmed significantly:

Persisted but not running -> full compile so we get binaries (new behavior).

$ rustdoc -Zunstable-options --test --persist-doctests doctests --no-run --extern t=libt.rlib t.rs

DEBUG rustdoc::doctest run_test compiler "rustc" "--crate-type" "bin" "--edition" "2015" "-o" "doctests/t_rs_8_0/rust_out" "--extern" "t=libt.rlib" "-Ccodegen-units=1" "-Z" "unstable-options" "--target" "x86_64-unknown-linux-gnu" "--color" "always"
DEBUG rustdoc::doctest run_test compiler "rustc" "--crate-type" "bin" "--edition" "2015" "-o" "doctests/t_rs_2_0/rust_out" "--extern" "t=libt.rlib" "-Ccodegen-units=1" "-Z" "unstable-options" "--target" "x86_64-unknown-linux-gnu" "--color" "always"
test t.rs - foople (line 2) - compile ... ok
test t.rs - florp (line 8) - compile ... ok

Persisted and running -> full compile.

$ rustdoc -Zunstable-options --test --persist-doctests doctests --extern t=libt.rlib t.rs

DEBUG rustdoc::doctest run_test compiler "rustc" "--crate-type" "bin" "--edition" "2015" "-o" "doctests/t_rs_8_0/rust_out" "--extern" "t=libt.rlib" "-Ccodegen-units=1" "-Z" "unstable-options" "--target" "x86_64-unknown-linux-gnu" "--color" "always"
DEBUG rustdoc::doctest run_test compiler "rustc" "--crate-type" "bin" "--edition" "2015" "-o" "doctests/t_rs_2_0/rust_out" "--extern" "t=libt.rlib" "-Ccodegen-units=1" "-Z" "unstable-options" "--target" "x86_64-unknown-linux-gnu" "--color" "always"

Running but not persisted -> full compile only

$ rustdoc --test --extern t=libt.rlib t.rs

DEBUG rustdoc::doctest run_test compiler "rustc" "--crate-type" "bin" "--edition" "2015" "-o" "/tmp/rustdoctestixWAUI/rust_out" "--extern" "t=libt.rlib" "-Ccodegen-units=1" "--target" "x86_64-unknown-linux-gnu" "--color" "always"
DEBUG rustdoc::doctest run_test compiler "rustc" "--crate-type" "bin" "--edition" "2015" "-o" "/tmp/rustdoctestKEaJQu/rust_out" "--extern" "t=libt.rlib" "-Ccodegen-units=1" "--target" "x86_64-unknown-linux-gnu" "--color" "always"

Not running and not persisting -> save time and only run metadata.

RUSTDOC_LOG=rustdoc=debug,std::test=debug rustdoc -Zunstable-options --no-run --test --extern t=libt.rlib t.rs

DEBUG rustdoc::doctest run_test compiler "rustc" "--crate-type" "bin" "--edition" "2015" "-o" "/tmp/rustdoctest8twt2c/rust_out" "--extern" "t=libt.rlib" "-Ccodegen-units=1" "-Z" "unstable-options" "--emit=metadata" "--target" "x86_64-unknown-linux-gnu" "--color" "always"
DEBUG rustdoc::doctest run_test compiler "rustc" "--crate-type" "bin" "--edition" "2015" "-o" "/tmp/rustdoctest3miSqv/rust_out" "--extern" "t=libt.rlib" "-Ccodegen-units=1" "-Z" "unstable-options" "--emit=metadata" "--target" "x86_64-unknown-linux-gnu" "--color" "always"

I can't see any infrastructure for automating this sort of test. Am I missing it?

Dylan-DPC-zz pushed a commit to Dylan-DPC-zz/rust that referenced this pull request

Aug 27, 2021

…r=jyn514

Doctest persist full binaries when persisting

Tested by adding an extra debug to echo the whole compiler line. Trimmed significantly:

Persisted but not running -> full compile so we get binaries (new behavior).

$ rustdoc -Zunstable-options --test --persist-doctests doctests --no-run --extern t=libt.rlib t.rs

DEBUG rustdoc::doctest run_test compiler "rustc" "--crate-type" "bin" "--edition" "2015" "-o" "doctests/t_rs_8_0/rust_out" "--extern" "t=libt.rlib" "-Ccodegen-units=1" "-Z" "unstable-options" "--target" "x86_64-unknown-linux-gnu" "--color" "always"
DEBUG rustdoc::doctest run_test compiler "rustc" "--crate-type" "bin" "--edition" "2015" "-o" "doctests/t_rs_2_0/rust_out" "--extern" "t=libt.rlib" "-Ccodegen-units=1" "-Z" "unstable-options" "--target" "x86_64-unknown-linux-gnu" "--color" "always"
test t.rs - foople (line 2) - compile ... ok
test t.rs - florp (line 8) - compile ... ok

Persisted and running -> full compile.

$ rustdoc -Zunstable-options --test --persist-doctests doctests --extern t=libt.rlib t.rs

DEBUG rustdoc::doctest run_test compiler "rustc" "--crate-type" "bin" "--edition" "2015" "-o" "doctests/t_rs_8_0/rust_out" "--extern" "t=libt.rlib" "-Ccodegen-units=1" "-Z" "unstable-options" "--target" "x86_64-unknown-linux-gnu" "--color" "always"
DEBUG rustdoc::doctest run_test compiler "rustc" "--crate-type" "bin" "--edition" "2015" "-o" "doctests/t_rs_2_0/rust_out" "--extern" "t=libt.rlib" "-Ccodegen-units=1" "-Z" "unstable-options" "--target" "x86_64-unknown-linux-gnu" "--color" "always"

Running but not persisted -> full compile only

$ rustdoc --test --extern t=libt.rlib t.rs

DEBUG rustdoc::doctest run_test compiler "rustc" "--crate-type" "bin" "--edition" "2015" "-o" "/tmp/rustdoctestixWAUI/rust_out" "--extern" "t=libt.rlib" "-Ccodegen-units=1" "--target" "x86_64-unknown-linux-gnu" "--color" "always"
DEBUG rustdoc::doctest run_test compiler "rustc" "--crate-type" "bin" "--edition" "2015" "-o" "/tmp/rustdoctestKEaJQu/rust_out" "--extern" "t=libt.rlib" "-Ccodegen-units=1" "--target" "x86_64-unknown-linux-gnu" "--color" "always"

Not running and not persisting -> save time and only run metadata.

RUSTDOC_LOG=rustdoc=debug,std::test=debug rustdoc -Zunstable-options --no-run --test --extern t=libt.rlib t.rs

DEBUG rustdoc::doctest run_test compiler "rustc" "--crate-type" "bin" "--edition" "2015" "-o" "/tmp/rustdoctest8twt2c/rust_out" "--extern" "t=libt.rlib" "-Ccodegen-units=1" "-Z" "unstable-options" "--emit=metadata" "--target" "x86_64-unknown-linux-gnu" "--color" "always"
DEBUG rustdoc::doctest run_test compiler "rustc" "--crate-type" "bin" "--edition" "2015" "-o" "/tmp/rustdoctest3miSqv/rust_out" "--extern" "t=libt.rlib" "-Ccodegen-units=1" "-Z" "unstable-options" "--emit=metadata" "--target" "x86_64-unknown-linux-gnu" "--color" "always"

I can't see any infrastructure for automating this sort of test. Am I missing it?

bors added S-waiting-on-author

Status: This is awaiting some action (such as code changes or more information) from the author.

and removed S-waiting-on-bors

Status: Waiting on bors to run and complete tests. Bors will change the label on completion.

labels

Aug 27, 2021

bors added S-waiting-on-bors

Status: Waiting on bors to run and complete tests. Bors will change the label on completion.

and removed S-waiting-on-author

Status: This is awaiting some action (such as code changes or more information) from the author.

labels

Sep 1, 2021

athei mentioned this pull request

Sep 1, 2021

wip-sync pushed a commit to NetBSD/pkgsrc-wip that referenced this pull request

Oct 22, 2021

Pkgsrc changes:

• Remove one now-longer-applicable patch, adjust a few others
• Bump bootstrap requirements to 1.55.0.

Upstream changes:

Version 1.56.0 (2021-10-21)

Language

• The 2021 Edition is now stable. See the edition guide for more details.
• [The pattern in binding @ pattern can now also introduce new bindings.] rust#85305
• [Union field access is permitted in const fn.][rust#85769]

Compiler

• Upgrade to LLVM 13.
• Support memory, address, and thread sanitizers on aarch64-unknown-freebsd.
• Allow specifying a deployment target version for all iOS targets
• Warnings can be forced on with --force-warn. This feature is primarily intended for usage by cargo fix, rather than end users.
• Promote aarch64-apple-ios-sim to Tier 2*.
• Add powerpc-unknown-freebsd at Tier 3*.
• [Add riscv32imc-esp-espidf at Tier 3*.][rust#87666]

* Refer to Rust's [platform support page][platform-support-doc] for more information on Rust's tiered platform support.

Libraries

• [Allow writing of incomplete UTF-8 sequences via stdout/stderr on Windows.] rust#83342 The Windows console still requires valid Unicode, but this change allows splitting a UTF-8 character across multiple write calls. This allows, for instance, programs that just read and write data buffers (e.g. copying a file to stdout) without regard for Unicode or character boundaries.
• [Prefer AtomicU{64,128} over Mutex for Instant backsliding protection.] rust#83093 For this use case, atomics scale much better under contention.
• Implement Extend<(A, B)> for (Extend<A>, Extend<B>)
• impl Default, Copy, Clone for std::io::Sink and std::io::Empty
• impl From<[(K, V); N]> for all collections.
• Remove P: Unpin bound on impl Future for Pin.
• Treat invalid environment variable names as non-existent. Previously, the environment functions would panic if given a variable name with an internal null character or equal sign (=). Now, these functions will just treat such names as non-existent variables, since the OS cannot represent the existence of a variable with such a name.

Stabilised APIs

• std::os::unix::fs::chroot
• UnsafeCell::raw_get
• BufWriter::into_parts
• core::panic::{UnwindSafe, RefUnwindSafe, AssertUnwindSafe} These APIs were previously stable in std, but are now also available in core.
• Vec::shrink_to
• String::shrink_to
• OsString::shrink_to
• PathBuf::shrink_to
• BinaryHeap::shrink_to
• VecDeque::shrink_to
• HashMap::shrink_to
• HashSet::shrink_to

These APIs are now usable in const contexts:

• std::mem::transmute
• [T]::first
• [T]::split_first
• [T]::last
• [T]::split_last

Cargo

• [Cargo supports specifying a minimum supported Rust version in Cargo.toml.] rust-version This has no effect at present on dependency version selection. We encourage crates to specify their minimum supported Rust version, and we encourage CI systems that support Rust code to include a crate's specified minimum version in the text matrix for that crate by default.

Compatibility notes

• Update to new argument parsing rules on Windows. This adjusts Rust's standard library to match the behavior of the standard libraries for C/C++. The rules have changed slightly over time, and this PR brings us to the latest set of rules (changed in 2008).
• [Disallow the aapcs calling convention on aarch64][rust#88399] This was already not supported by LLVM; this change surfaces this lack of support with a better error message.
• Make SEMICOLON_IN_EXPRESSIONS_FROM_MACROS warn by default
• Warn when an escaped newline skips multiple lines.
• [Calls to libc::getpid / std::process::id from Command::pre_exec may return different values on glibc <= 2.24.][rust#81825] Rust now invokes the clone3 system call directly, when available, to use new functionality available via that system call. Older versions of glibc cache the result of getpid, and only update that cache when calling glibc's clone/fork functions, so a direct system call bypasses that cache update. glibc 2.25 and newer no longer cache getpid for exactly this reason.

Internal changes

These changes provide no direct user facing benefits, but represent significant improvements to the internals and overall performance of rustc and related tools.

• LLVM is compiled with PGO in published x86_64-unknown-linux-gnu artifacts. This improves the performance of most Rust builds.

• [Unify representation of macros in internal data structures.][rust#88019] This change fixes a host of bugs with the handling of macros by the compiler, as well as rustdoc.

[rust#85769]: rust-lang/rust#85769 (comment) [rust#88490]: rust-lang/rust#88490 [rust#88269]: rust-lang/rust#88269 [rust#84176]: rust-lang/rust#84176 [rust#88399]: rust-lang/rust#88399 [rust#88227]: rust-lang/rust#88227 [rust#88200]: rust-lang/rust#88200 [rust#82776]: rust-lang/rust#82776 [rust#88077]: rust-lang/rust#88077 [rust#87728]: rust-lang/rust#87728 [rust#87050]: rust-lang/rust#87050 [rust#87619]: rust-lang/rust#87619 [rust#81825]: rust-lang/rust#81825 (comment) [rust#88019]: rust-lang/rust#88019 [rust#87666]: rust-lang/rust#87666

netbsd-srcmastr pushed a commit to NetBSD/pkgsrc that referenced this pull request

Nov 20, 2021

Pkgsrc changes:

• Bump bootstrap kit version to 1.55.0.
• Adjust patches as needed, some no longer apply (so removed)
• Update checksum adjustments.
• Avoid rust-llvm on SunOS
• Optionally build docs
• Remove reference to closed/old PR#54621

Upstream changes:

Version 1.56.1 (2021-11-01)

• New lints to detect the presence of bidirectional-override Unicode codepoints in the compiled source code (CVE-2021-42574)

Version 1.56.0 (2021-10-21)

Language

• The 2021 Edition is now stable. See the edition guide for more details.
• [The pattern in binding @ pattern can now also introduce new bindings.] rust#85305
• [Union field access is permitted in const fn.][rust#85769]

Compiler

• Upgrade to LLVM 13.
• [Support memory, address, and thread sanitizers on aarch64-unknown-freebsd.] rust#88023
• Allow specifying a deployment target version for all iOS targets
• Warnings can be forced on with --force-warn. This feature is primarily intended for usage by cargo fix, rather than end users.
• Promote aarch64-apple-ios-sim to Tier 2*.
• Add powerpc-unknown-freebsd at Tier 3*.
• [Add riscv32imc-esp-espidf at Tier 3*.][rust#87666]

* Refer to Rust's [platform support page][platform-support-doc] for more information on Rust's tiered platform support.

Libraries

• [Allow writing of incomplete UTF-8 sequences via stdout/stderr on Windows.] rust#83342 The Windows console still requires valid Unicode, but this change allows splitting a UTF-8 character across multiple write calls. This allows, for instance, programs that just read and write data buffers (e.g. copying a file to stdout) without regard for Unicode or character boundaries.
• [Prefer AtomicU{64,128} over Mutex for Instant backsliding protection.] rust#83093 For this use case, atomics scale much better under contention.
• Implement Extend<(A, B)> for (Extend<A>, Extend<B>)
• impl Default, Copy, Clone for std::io::Sink and std::io::Empty
• impl From<[(K, V); N]> for all collections.
• Remove P: Unpin bound on impl Future for Pin.
• Treat invalid environment variable names as non-existent. Previously, the environment functions would panic if given a variable name with an internal null character or equal sign (=). Now, these functions will just treat such names as non-existent variables, since the OS cannot represent the existence of a variable with such a name.

Stabilised APIs

• std::os::unix::fs::chroot
• UnsafeCell::raw_get
• BufWriter::into_parts
• core::panic::{UnwindSafe, RefUnwindSafe, AssertUnwindSafe} These APIs were previously stable in std, but are now also available in core.
• Vec::shrink_to
• String::shrink_to
• OsString::shrink_to
• PathBuf::shrink_to
• BinaryHeap::shrink_to
• VecDeque::shrink_to
• HashMap::shrink_to
• HashSet::shrink_to

These APIs are now usable in const contexts:

• std::mem::transmute
• [T]::first
• [T]::split_first
• [T]::last
• [T]::split_last

Cargo

• [Cargo supports specifying a minimum supported Rust version in Cargo.toml.] rust-version This has no effect at present on dependency version selection. We encourage crates to specify their minimum supported Rust version, and we encourage CI systems that support Rust code to include a crate's specified minimum version in the text matrix for that crate by default.

Compatibility notes

• Update to new argument parsing rules on Windows. This adjusts Rust's standard library to match the behavior of the standard libraries for C/C++. The rules have changed slightly over time, and this PR brings us to the latest set of rules (changed in 2008).
• [Disallow the aapcs calling convention on aarch64][rust#88399] This was already not supported by LLVM; this change surfaces this lack of support with a better error message.
• Make SEMICOLON_IN_EXPRESSIONS_FROM_MACROS warn by default
• Warn when an escaped newline skips multiple lines.
• [Calls to libc::getpid / std::process::id from Command::pre_exec may return different values on glibc <= 2.24.][rust#81825] Rust now invokes the clone3 system call directly, when available, to use new functionality available via that system call. Older versions of glibc cache the result of getpid, and only update that cache when calling glibc's clone/fork functions, so a direct system call bypasses that cache update. glibc 2.25 and newer no longer cache getpid for exactly this reason.

Internal changes

These changes provide no direct user facing benefits, but represent significant improvements to the internals and overall performance of rustc and related tools.

• [LLVM is compiled with PGO in published x86_64-unknown-linux-gnu artifacts.] rust#88069 This improves the performance of most Rust builds.
• [Unify representation of macros in internal data structures.][rust#88019] This change fixes a host of bugs with the handling of macros by the compiler, as well as rustdoc.

[rust#85769]: rust-lang/rust#85769 (comment) [rust#88490]: rust-lang/rust#88490 [rust#88269]: rust-lang/rust#88269 [rust#84176]: rust-lang/rust#84176 [rust#88399]: rust-lang/rust#88399 [rust#88227]: rust-lang/rust#88227 [rust#88200]: rust-lang/rust#88200 [rust#82776]: rust-lang/rust#82776 [rust#88077]: rust-lang/rust#88077 [rust#87728]: rust-lang/rust#87728 [rust#87050]: rust-lang/rust#87050 [rust#87619]: rust-lang/rust#87619 [rust#81825]: rust-lang/rust#81825 (comment) [rust#88019]: rust-lang/rust#88019 [rust#87666]: rust-lang/rust#87666

Version 1.55.0 (2021-09-09)

Language

• You can now write open "from" range patterns (X..), which will start at X and will end at the maximum value of the integer.
• You can now explicitly import the prelude of different editions through std::prelude (e.g. use std::prelude::rust_2021::*;).

Compiler

• Added tier 3* support for powerpc64le-unknown-freebsd.

* Refer to Rust's [platform support page][platform-support-doc] for more information on Rust's tiered platform support.

Libraries

• Updated std's float parsing to use the Eisel-Lemire algorithm. These improvements should in general provide faster string parsing of floats, no longer reject certain valid floating point values, and reduce the produced code size for non-stripped artifacts.
• string::Drain now implements AsRef<str> and AsRef<[u8]>.

Stabilised APIs

• Bound::cloned
• Drain::as_str
• IntoInnerError::into_error
• IntoInnerError::into_parts
• MaybeUninit::assume_init_mut
• MaybeUninit::assume_init_ref
• MaybeUninit::write
• array::map
• ops::ControlFlow
• x86::_bittest
• x86::_bittestandcomplement
• x86::_bittestandreset
• x86::_bittestandset
• x86_64::_bittest64
• x86_64::_bittestandcomplement64
• x86_64::_bittestandreset64
• x86_64::_bittestandset64

The following previously stable functions are now const.

• str::from_utf8_unchecked

Cargo

• Cargo will now deduplicate compiler diagnostics to the terminal when invoking rustc in parallel such as when using cargo test.
• The package definition in cargo metadata now includes the "default_run" field from the manifest.
• Added cargo d as an alias for cargo doc.
• Added {lib} as formatting option for cargo tree to print the "lib_name" of packages.

Rustdoc

• Added "Go to item on exact match" search option.
• The "Implementors" section on traits no longer shows redundant method definitions.
• Trait implementations are toggled open by default. This should make the implementations more searchable by tools like CTRL+F in your browser.
• Intra-doc links should now correctly resolve associated items (e.g. methods) through type aliases.
• Traits which are marked with #[doc(hidden)] will no longer appear in the "Trait Implementations" section.

Compatibility Notes

• std functions that return an io::Error will no longer use the ErrorKind::Other variant. This is to better reflect that these kinds of errors could be categorised into newer more specific ErrorKind variants, and that they do not represent a user error.
• Using environment variable names with process::Command on Windows now behaves as expected. Previously using envionment variables with Command would cause them to be ASCII-uppercased.
• Rustdoc will now warn on using rustdoc lints that aren't prefixed with rustdoc::