Prevent rustdoc feature doctests #64741

GuillaumeGomez · 2019-09-24T15:38:35Z

Centril · 2019-09-24T16:15:44Z

src/librustdoc/test.rs

-    let mut test_args = options.test_args.clone();
+    let mut test_args = options.test_args
+        .iter()
+        .filter_map(|arg| {


.filter(..).cloned() seems cleaner here.

I continue to be deeply confused why we're altering test_args here.

test_args is the array of arguments that's passed to test::test_main -- that's way too late for cfg to matter, I believe, and test_main certainly is not a compiler.

Can you at least check manually that this works? A comment that explains how this works (e.g., why is this applying to cfg, despite not mentioning cfg at all?) would also be good.

I just thought about it when you said something was wrong in this implementation the other day: it's incorrect since I don't check the cfg. However, test_args are passed to each code sample rustdoc compiles and run. Therefore, it seems accurate to me to have this check here. However I need to fix it.

But... they're not? These are not the arguments to rustc. These are the arguments to the test 'binary'. I would expect you to never find a --cfg in these arguments; they're not (AFAICT) used at all for compilation. Right now the code is removing a test filter for rustdoc -- not a cfg gate or anything like that.

Then I completely misunderstood this part of the code... I'll take a step back and check what I missed...

GuillaumeGomez · 2019-09-25T14:49:23Z

Indeed, I wasn't looking at the good place at all... Thanks a lot for catching up my error @Mark-Simulacrum !

Mark-Simulacrum · 2019-09-25T14:51:01Z

src/librustdoc/test.rs

@@ -251,7 +251,9 @@ fn run_test(
    let mut compiler = Command::new(std::env::current_exe().unwrap().with_file_name("rustc"));
    compiler.arg("--crate-type").arg("bin");
    for cfg in &options.cfgs {
-        compiler.arg("--cfg").arg(&cfg);
+        if cfg != "rustdoc" {


This also feels like the wrong place :)

I would expect us to not add the rustdoc cfg ourselves -- looking at it, I guess here -- not remove it later on. We don't want to remove it if the user has passed it.

That's a good point I didn't think about... Checking more globally why we even need to do this. However, I think we need it at some point to check for the documentation build (not the tests build). I'm looking around to confirm it.

GuillaumeGomez · 2019-09-25T15:09:43Z

@Mark-Simulacrum Just like you suggested, instead of adding it into the options directly, I removed it from there and add it before the doc build. Sorry about all the fuss...

GuillaumeGomez · 2019-09-30T11:21:48Z

ping @Mark-Simulacrum

Mark-Simulacrum · 2019-09-30T11:37:08Z

@bors r+

bors · 2019-09-30T11:37:09Z

📌 Commit e4e674bec91e364f290ab8b708d960a292d2678a has been approved by Mark-Simulacrum

ollie27 · 2019-09-30T13:00:53Z

Shouldn't cfg(rustdoc) be set when looking for doctests as well:

rust/src/librustdoc/test.rs

Line 67 in bf8491e

crate_cfg: config::parse_cfgspecs(options.cfgs.clone()),

@bors r-

We need tests for this, a rustdoc-ui test like the following should be sufficient:

// build-pass
// compile-flags:--test
// normalize-stdout-test: "src/test/rustdoc-ui" -> "$$DIR"

#![feature(doc_cfg)]

// Make sure `cfg(rustdoc)` is set when finding doctests but not inside the doctests.

/// ```
/// #![feature(doc_cfg)]
/// assert!(!cfg!(rustdoc));
/// ```
#[cfg(rustdoc)]
pub struct Foo;

Mark-Simulacrum · 2019-09-30T13:05:40Z

r? @ollie27

I assumed that setting it in core would've done that...

GuillaumeGomez · 2019-09-30T13:55:13Z

I did as well since we use this one for it. Adding the test.

GuillaumeGomez · 2019-09-30T14:20:25Z

@ollie27 It seems like the test passed whereas I didn't change the code. Did we misunderstood your message?

ollie27 · 2019-09-30T14:30:16Z

If you look at the stdout it shows that it didn't actually run the doctest. It should say "running 1 test".

GuillaumeGomez · 2019-10-01T12:12:09Z

Oh I see! Indeed, good catch!

…down to doctests

GuillaumeGomez · 2019-10-01T12:39:16Z

Now we have it as well.

QuietMisdreavus · 2019-10-03T16:10:42Z

This looks like it's ready to go, and that @ollie27's test has been added and is working, so i'm going to push this along...

@bors r+

bors · 2019-10-03T16:10:43Z

📌 Commit 366fdeb has been approved by QuietMisdreavus

@ollie27

…ure-doctests, r=QuietMisdreavus Prevent rustdoc feature doctests Part of rust-lang#61351 cc @ollie27

@ollie27

…ure-doctests, r=QuietMisdreavus Prevent rustdoc feature doctests Part of rust-lang#61351 cc @ollie27

@ollie27

…ure-doctests, r=QuietMisdreavus Prevent rustdoc feature doctests Part of rust-lang#61351 cc @ollie27

@ollie27

…ure-doctests, r=QuietMisdreavus Prevent rustdoc feature doctests Part of rust-lang#61351 cc @ollie27

@ghost

Rollup of 11 pull requests Successful merges: - #61879 (Stabilize todo macro) - #64675 (Deprecate `#![plugin]` & `#[plugin_registrar]`) - #64690 (proc_macro API: Expose `macro_rules` hygiene) - #64706 (add regression test for #60218) - #64741 (Prevent rustdoc feature doctests) - #64842 (Disallow Self in type param defaults of ADTs) - #65004 (Replace mentions of IRC with Discord) - #65018 (Set RUST_BACKTRACE=0 in tests that include a backtrace in stderr) - #65055 (Add long error explanation for E0556) - #65056 (Make visit projection iterative) - #65057 (typo: fix typo in E0392) Failed merges: r? @ghost

rust-highfive assigned Mark-Simulacrum Sep 24, 2019

GuillaumeGomez force-pushed the prevent-rustdoc-feature-doctests branch from 7e7ab2b to bf41529 Compare September 24, 2019 15:39

Centril reviewed Sep 24, 2019

View reviewed changes

GuillaumeGomez force-pushed the prevent-rustdoc-feature-doctests branch 2 times, most recently from d19f3f3 to b69ae4a Compare September 25, 2019 14:48

Mark-Simulacrum reviewed Sep 25, 2019

View reviewed changes

GuillaumeGomez force-pushed the prevent-rustdoc-feature-doctests branch from b69ae4a to e4e674b Compare September 25, 2019 15:08

JohnCSimon added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Sep 28, 2019

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 Sep 30, 2019

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 Sep 30, 2019

rust-highfive assigned ollie27 and unassigned Mark-Simulacrum Sep 30, 2019

GuillaumeGomez force-pushed the prevent-rustdoc-feature-doctests branch from e4e674b to 57faf0f Compare September 30, 2019 14:19

GuillaumeGomez added 2 commits October 1, 2019 14:38

Prevent rustdoc feature to be passed down to doctests

445e735

Add new rustdoc-ui test to ensuire that rustdoc feature isn't passed …

366fdeb

…down to doctests

GuillaumeGomez force-pushed the prevent-rustdoc-feature-doctests branch from 57faf0f to 366fdeb Compare October 1, 2019 12:38

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 Oct 3, 2019

QuietMisdreavus mentioned this pull request Oct 3, 2019

Stabilize cfg(doc) #61351

Merged

Centril added a commit to Centril/rust that referenced this pull request Oct 3, 2019

Rollup merge of rust-lang#64741 - GuillaumeGomez:prevent-rustdoc-feat…

3c31eb3

…ure-doctests, r=QuietMisdreavus Prevent rustdoc feature doctests Part of rust-lang#61351 cc @ollie27

Centril mentioned this pull request Oct 3, 2019

Rollup of 10 pull requests #65070

Closed

Centril added a commit to Centril/rust that referenced this pull request Oct 3, 2019

Rollup merge of rust-lang#64741 - GuillaumeGomez:prevent-rustdoc-feat…

d7a4f9d

…ure-doctests, r=QuietMisdreavus Prevent rustdoc feature doctests Part of rust-lang#61351 cc @ollie27

Centril mentioned this pull request Oct 3, 2019

Rollup of 11 pull requests #65072

Closed

tmandry added a commit to tmandry/rust that referenced this pull request Oct 3, 2019

Rollup merge of rust-lang#64741 - GuillaumeGomez:prevent-rustdoc-feat…

cd0028e

…ure-doctests, r=QuietMisdreavus Prevent rustdoc feature doctests Part of rust-lang#61351 cc @ollie27

tmandry mentioned this pull request Oct 3, 2019

Rollup of 12 pull requests #65075

Closed

tmandry added a commit to tmandry/rust that referenced this pull request Oct 3, 2019

Rollup merge of rust-lang#64741 - GuillaumeGomez:prevent-rustdoc-feat…

69837b1

…ure-doctests, r=QuietMisdreavus Prevent rustdoc feature doctests Part of rust-lang#61351 cc @ollie27

tmandry mentioned this pull request Oct 3, 2019

Rollup of 11 pull requests #65076

Merged

bors merged commit 366fdeb into rust-lang:master Oct 4, 2019

GuillaumeGomez deleted the prevent-rustdoc-feature-doctests branch October 4, 2019 08:24

ollie27 mentioned this pull request Oct 6, 2019

[rustdoc] stabilize cfg(doctest) #63803

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Prevent rustdoc feature doctests #64741

Prevent rustdoc feature doctests #64741

GuillaumeGomez commented Sep 24, 2019 •

edited by Mark-Simulacrum

Loading

Centril Sep 24, 2019

Mark-Simulacrum Sep 24, 2019

GuillaumeGomez Sep 25, 2019

Mark-Simulacrum Sep 25, 2019

GuillaumeGomez Sep 25, 2019

GuillaumeGomez commented Sep 25, 2019

Mark-Simulacrum Sep 25, 2019

GuillaumeGomez Sep 25, 2019

GuillaumeGomez commented Sep 25, 2019

GuillaumeGomez commented Sep 30, 2019

Mark-Simulacrum commented Sep 30, 2019

bors commented Sep 30, 2019

ollie27 commented Sep 30, 2019

Mark-Simulacrum commented Sep 30, 2019

GuillaumeGomez commented Sep 30, 2019

GuillaumeGomez commented Sep 30, 2019

ollie27 commented Sep 30, 2019

GuillaumeGomez commented Oct 1, 2019

GuillaumeGomez commented Oct 1, 2019

QuietMisdreavus commented Oct 3, 2019

bors commented Oct 3, 2019

Prevent rustdoc feature doctests #64741

Prevent rustdoc feature doctests #64741

Conversation

GuillaumeGomez commented Sep 24, 2019 • edited by Mark-Simulacrum Loading

Centril Sep 24, 2019

Choose a reason for hiding this comment

Mark-Simulacrum Sep 24, 2019

Choose a reason for hiding this comment

GuillaumeGomez Sep 25, 2019

Choose a reason for hiding this comment

Mark-Simulacrum Sep 25, 2019

Choose a reason for hiding this comment

GuillaumeGomez Sep 25, 2019

Choose a reason for hiding this comment

GuillaumeGomez commented Sep 25, 2019

Mark-Simulacrum Sep 25, 2019

Choose a reason for hiding this comment

GuillaumeGomez Sep 25, 2019

Choose a reason for hiding this comment

GuillaumeGomez commented Sep 25, 2019

GuillaumeGomez commented Sep 30, 2019

Mark-Simulacrum commented Sep 30, 2019

bors commented Sep 30, 2019

ollie27 commented Sep 30, 2019

Mark-Simulacrum commented Sep 30, 2019

GuillaumeGomez commented Sep 30, 2019

GuillaumeGomez commented Sep 30, 2019

ollie27 commented Sep 30, 2019

GuillaumeGomez commented Oct 1, 2019

GuillaumeGomez commented Oct 1, 2019

QuietMisdreavus commented Oct 3, 2019

bors commented Oct 3, 2019

GuillaumeGomez commented Sep 24, 2019 •

edited by Mark-Simulacrum

Loading