Enable doctests in compiler/ crates

[reez12g]

Helps with #99144

[rust-highfive]

r? @kennytm

(rust-highfive has picked a reviewer for you, use r? to override)

[Mark-Simulacrum]

I would like to verify that these aren't already running on other builders - at a quick look, CrateLibrustc is default enabled, so I would expect them to be...

[Mark-Simulacrum]

Yeah, it looks like we are?

If I look at the llvm-12 builder (after a rebase/rerun llvm-13) builder in this PR, or from a recent master merge:

2022-07-16T12:23:18.2198781Z �[0m�[0m�[1m�[32m Running�[0m unittests src/lib.rs (build/x86_64-unknown-linux-gnu/stage1-rustc/x86_64-unknown-linux-gnu/release/deps/rustc_parse_format-d175d01f72a50abf)
2022-07-16T12:23:23.8389736Z �[0m�[0m�[1m�[32m Doc-tests�[0m rustc_parse_format

So I think we should try to understand what we're intending to add here -- @jyn514, marking as waiting on reviewer for you to confirm whether #99144 actually needs fixing.

[jyn514]

Something strange is going on. https://pipelines.actions.githubusercontent.com/serviceHosts/d3b42637-680e-47c4-b396-04d4ba514549/_apis/pipelines/1/runs/64123/signedlogcontent/8?urlExpires=2022-09-07T03%3A02%3A56.8274271Z&urlSigningMethod=HMACV1&urlSignature=XpkHU6Ja%2BoIzOyGtj83HPrWJa1K0ULVXrUQCmh3Na40%3D shows doc-tests for rustc crates, but only some of them. Notably, at least rustc_borrowck is missing doctests.

Oh, it turns out all these crates set doctest = false 🤦

rust/compiler/rustc_borrowck/Cargo.toml

Line 7 in d10497b

doctest = false

@reez12g can you remove this new job, and instead remove doctest = false from all compiler/ crates, then check that the llvm-12 PR job includes "Doc-tests rustc_borrowck"?

[reez12g]

@jyn514
Thank you for your kind guide!
Do I just remove the doctest = false in line below?
OR change it to doctest = true? I'm not sure I can delete it.

% grep -r 'doctest = false' compiler
compiler/rustc_errors/Cargo.toml:doctest = false
compiler/rustc_resolve/Cargo.toml:doctest = false
compiler/rustc_symbol_mangling/Cargo.toml:doctest = false
compiler/rustc_query_system/Cargo.toml:doctest = false
compiler/rustc_index/Cargo.toml:doctest = false
compiler/rustc_infer/Cargo.toml:doctest = false
compiler/rustc_query_impl/Cargo.toml:doctest = false
compiler/rustc_hir/Cargo.toml:doctest = false
compiler/rustc_trait_selection/Cargo.toml:doctest = false
compiler/rustc_mir_transform/Cargo.toml:doctest = false
compiler/rustc_mir_transform/src/coverage/test_macros/Cargo.toml:doctest = false
compiler/rustc_error_messages/Cargo.toml:doctest = false
compiler/rustc_typeck/Cargo.toml:doctest = false
compiler/rustc_plugin_impl/Cargo.toml:doctest = false
compiler/rustc_data_structures/Cargo.toml:doctest = false
compiler/rustc_ast_pretty/Cargo.toml:doctest = false
compiler/rustc_attr/Cargo.toml:doctest = false
compiler/rustc_span/Cargo.toml:doctest = false
compiler/rustc_hir_pretty/Cargo.toml:doctest = false
compiler/rustc_incremental/Cargo.toml:doctest = false
compiler/rustc_mir_build/Cargo.toml:doctest = false
compiler/rustc_codegen_llvm/Cargo.toml:doctest = false
compiler/rustc_type_ir/Cargo.toml:doctest = false
compiler/rustc_const_eval/Cargo.toml:doctest = false
compiler/rustc_ast/Cargo.toml:doctest = false
compiler/rustc_metadata/Cargo.toml:doctest = false
compiler/rustc_middle/Cargo.toml:doctest = false
compiler/rustc_expand/Cargo.toml:doctest = false
compiler/rustc_monomorphize/Cargo.toml:doctest = false
compiler/rustc_parse/Cargo.toml:doctest = false
compiler/rustc_borrowck/Cargo.toml:doctest = false
compiler/rustc_mir_dataflow/Cargo.toml:doctest = false
compiler/rustc_lexer/Cargo.toml:doctest = false
compiler/rustc_ast_lowering/Cargo.toml:doctest = false
compiler/rustc_interface/Cargo.toml:doctest = false
compiler/rustc_builtin_macros/Cargo.toml:doctest = false
compiler/rustc_feature/Cargo.toml:doctest = false

[jyn514]

@reez12g yes, you can just delete it :) the default is true.

[rustbot]

Some changes occurred to MIR optimizations

cc @rust-lang/wg-mir-opt

rustc_error_messages was changed

cc @davidtwco, @compiler-errors, @JohnTitor, @estebank, @TaKO8Ki

[jyn514]

Looks like the test failure is because the doctests are now running 🎉 @reez12g can you please fix those failures? You can run them locally with the command in #99324 (comment) (replacing --stage 2 with --stage 0 for better iteration times).

Once you do that, I think is ready to merge :)

[jyn514]

Oh, looks like this is still disabled for bootstrap - if it's easy to fix it would be nice to remove these too. But I won't block on that.

; git grep 'doctest = ' FETCH_HEAD
FETCH_HEAD:src/bootstrap/Cargo.toml:doctest = false
FETCH_HEAD:src/tools/rust-demangler/Cargo.toml:doctest = false

[rustbot]

Some changes occurred to the CTFE / Miri engine

cc @rust-lang/miri

[jyn514]

This looks great so far :) just one question.

By the way, if this is more work than you were expecting, I'm happy to merge this for a subset of crates at first and we can fix the rest later.

[reez12g]

I would appreciate it if you merge this!
It looks like there are still some doctests that need to be fixed, so I agree to merge it for now and move on.

[jyn514]

I would appreciate it if you merge this! It looks like there are still some doctests that need to be fixed, so I agree to merge it for now and move on.

For us to be able to merge this, you'll need to re-enable doctest = false for the crates you haven't fixed. Can you please do that? As a bonus, it would be extremely helpful if you could post the list of crates with doctest=false on the tracking issue.

[reez12g]

@rustbot ready

[reez12g]

@jyn514

you'll need to re-enable doctest = false for the crates you haven't fixed.

I did it.
After this PR is merged, I will create a tracking issue to clean up the rest!

[jyn514]

Thanks! Please reuse #99144 for the tracking issue :)

@bors r+ rollup=iffy

[bors]

📌 Commit 488eb42 has been approved by jyn514

It is now in the queue for this repository.

[bors]

⌛ Testing commit 488eb42 with merge 0152393...

[bors]

☀️ Test successful - checks-actions
Approved by: jyn514
Pushing 0152393 to master...

[rust-timer]

Finished benchmarking commit (0152393): comparison URL.

Overall result: no relevant changes - no action needed

@rustbot label: -perf-regression

Instruction count

This benchmark run did not return any relevant results for this metric.

Max RSS (memory usage)

Results

This is a less reliable metric that may be of interest but was not used to determine the overall result at the top of this comment.

	mean1	range	count2
Regressions ❌ (primary)	-	-	0
Regressions ❌ (secondary)	3.4%	[2.3%, 4.5%]	2
Improvements ✅ (primary)	-	-	0
Improvements ✅ (secondary)	-2.1%	[-3.0%, -1.2%]	6
All ❌✅ (primary)	-	-	0

Cycles

This benchmark run did not return any relevant results for this metric.

Footnotes

1. the arithmetic mean of the percent change ↩

2. number of relevant changes ↩