bors 1d679446b0 Auto merge of #140527 - GuillaumeGomez:doctest-main-fn, r=notriddle ...

Emit a warning if the doctest `main` function will not be run

Fixes #140310.

I think we could try to go much further like adding a "link" (ie UI annotations) on the `main` function in the doctest. However that will require some more computation, not sure if it's worth it or not. Can still be done in a follow-up if we want it.

For now, this PR does two things:
1. Pass the `DiagCtxt` to the doctest parser to emit the warning.
2. Correctly generate the `Span` to where the doctest is starting (I hope the way I did it isn't too bad either...).

cc `@fmease`
r? `@notriddle`

2025-05-22 08:40:58 +00:00

..

auxiliary

rustdoc: Fix doctest heuristic for main fn wrapping

2025-05-01 11:56:11 +02:00

block-doc-comment.rs

Remove the -test suffix from normalize directives

2024-12-27 19:58:16 +11:00

block-doc-comment.stdout

…

cfg-test.rs

Remove the -test suffix from normalize directives

2024-12-27 19:58:16 +11:00

cfg-test.stdout

…

check-attr-test.rs

[AUTO_GENERATED] Migrate compiletest to use ui_test-style //@ directives

2024-02-22 16:04:04 +00:00

check-attr-test.stderr

Improve mistyped docblock attribute warning messages

2024-09-28 18:38:11 +02:00

check-cfg-test.rs

Remove the -test suffix from normalize directives

2024-12-27 19:58:16 +11:00

check-cfg-test.stderr

Move --check-cfg documentation to stable books

2024-04-15 21:49:56 +02:00

check-cfg-test.stdout

…

comment-in-attr-134221-2.rs

Remove the -test suffix from normalize directives

2024-12-27 19:58:16 +11:00

comment-in-attr-134221-2.stdout

Remove unneeded handling of backlines in doctest attributes

2024-12-16 17:59:07 +01:00

comment-in-attr-134221.rs

Remove the -test suffix from normalize directives

2024-12-27 19:58:16 +11:00

comment-in-attr-134221.stdout

Also handle cases where attributes are unclosed

2024-12-16 13:59:41 +01:00

dead-code-2024.rs

Remove the -test suffix from normalize directives

2024-12-27 19:58:16 +11:00

dead-code-2024.stdout

Stabilize the 2024 edition

2024-11-22 11:12:15 -08:00

dead-code.rs

Remove the -test suffix from normalize directives

2024-12-27 19:58:16 +11:00

dead-code.stdout

Add regression tests for #130681

2024-10-01 17:08:01 +02:00

display-output.rs

Remove the -test suffix from normalize directives

2024-12-27 19:58:16 +11:00

display-output.stdout

Correctly handle line comments in attributes and generate extern crates

2025-03-27 11:18:43 +01:00

doc-comment-multi-line-attr.rs

Remove the -test suffix from normalize directives

2024-12-27 19:58:16 +11:00

doc-comment-multi-line-attr.stdout

…

doc-comment-multi-line-cfg-attr.rs

Remove the -test suffix from normalize directives

2024-12-27 19:58:16 +11:00

doc-comment-multi-line-cfg-attr.stdout

…

doc-test-attr-pass.rs

[AUTO_GENERATED] Migrate compiletest to use ui_test-style //@ directives

2024-02-22 16:04:04 +00:00

doc-test-attr.rs

Update ui tests

2024-02-29 14:43:43 +01:00

doc-test-attr.stderr

Update ui tests

2024-02-29 14:43:43 +01:00

doc-test-doctest-feature.rs

Remove the -test suffix from normalize directives

2024-12-27 19:58:16 +11:00

doc-test-doctest-feature.stdout

…

doc-test-rustdoc-feature.rs

Remove the -test suffix from normalize directives

2024-12-27 19:58:16 +11:00

doc-test-rustdoc-feature.stdout

…

doctest-edition.rs

[AUTO_GENERATED] Migrate compiletest to use ui_test-style //@ directives

2024-02-22 16:04:04 +00:00

doctest-edition.stderr

…

doctest-multiline-crate-attribute.rs

Remove the -test suffix from normalize directives

2024-12-27 19:58:16 +11:00

doctest-multiline-crate-attribute.stdout

…

doctest-no-run-invalid-langstring-124577.rs

rustdoc: Fix flaky doctest test

2025-01-19 18:41:11 +01:00

doctest-no-run-invalid-langstring-124577.stdout

rustdoc: Fix flaky doctest test

2025-01-19 18:41:11 +01:00

doctest-output-include-fail.md

rustdoc: use the correct span for doctests

2024-09-19 13:57:44 -07:00

doctest-output-include-fail.rs

Remove the -test suffix from normalize directives

2024-12-27 19:58:16 +11:00

doctest-output-include-fail.stdout

rustdoc: use the correct span for doctests

2024-09-19 13:57:44 -07:00

doctest-output.edition2015.stdout

rustdoc: make doctest span tweak a 2024 edition change

2024-10-26 17:56:38 -07:00

doctest-output.edition2024.stdout

rustdoc: make doctest span tweak a 2024 edition change

2024-10-26 17:56:38 -07:00

doctest-output.rs

doctests: build test bundle and harness separately

2025-03-10 01:47:36 +01:00

edition-2024-error-output.rs

Use eprint! instead of eprintln!

2025-04-03 19:37:18 +02:00

edition-2024-error-output.stdout

Correctly display stdout and stderr in case a doctest is failing

2025-04-25 14:13:24 +02:00

extern-crate.rs

Correctly handle line comments in attributes and generate extern crates

2025-03-27 11:18:43 +01:00

extern-crate.stdout

Correctly handle line comments in attributes and generate extern crates

2025-03-27 11:18:43 +01:00

failed-doctest-compile-fail.rs

Remove the -test suffix from normalize directives

2024-12-27 19:58:16 +11:00

failed-doctest-compile-fail.stdout

…

failed-doctest-extra-semicolon-on-item.rs

If there is a ; alone, we consider that the doctest needs to be put inside a function

2025-04-25 22:04:50 +02:00

failed-doctest-extra-semicolon-on-item.stderr

Emit a warning if the doctest main function will not be run

2025-05-02 13:57:53 +02:00

failed-doctest-extra-semicolon-on-item.stdout

If there is a ; alone, we consider that the doctest needs to be put inside a function

2025-04-25 22:04:50 +02:00

failed-doctest-missing-codes.rs

Remove the -test suffix from normalize directives

2024-12-27 19:58:16 +11:00

failed-doctest-missing-codes.stdout

…

failed-doctest-output-windows.rs

Remove the -test suffix from normalize directives

2024-12-27 19:58:16 +11:00

failed-doctest-output-windows.stdout

Try to write the panic message with a single write_all call

2025-01-01 15:58:29 +01:00

failed-doctest-output.rs

Remove the -test suffix from normalize directives

2024-12-27 19:58:16 +11:00

failed-doctest-output.stdout

Try to write the panic message with a single write_all call

2025-01-01 15:58:29 +01:00

failed-doctest-should-panic-2021.rs

replace //@ compile-flags: --edition with //@ edition

2025-04-10 09:56:37 +02:00

failed-doctest-should-panic-2021.stdout

replace //@ compile-flags: --edition with //@ edition

2025-04-10 09:56:37 +02:00

failed-doctest-should-panic.rs

Remove the -test suffix from normalize directives

2024-12-27 19:58:16 +11:00

failed-doctest-should-panic.stdout

Report span of test when should_panic test failed

2025-04-14 10:36:11 +08:00

failed-doctest-test-crate.edition2015.stdout

doctests: build test bundle and harness separately

2025-03-10 01:47:36 +01:00

failed-doctest-test-crate.edition2024.stdout

doctests: build test bundle and harness separately

2025-03-10 01:47:36 +01:00

failed-doctest-test-crate.rs

doctests: build test bundle and harness separately

2025-03-10 01:47:36 +01:00

main-alongside-macro-calls.fail.stdout

rustdoc: Fix doctest heuristic for main fn wrapping

2025-05-01 11:56:11 +02:00

main-alongside-macro-calls.pass.stdout

rustdoc: Fix doctest heuristic for main fn wrapping

2025-05-01 11:56:11 +02:00

main-alongside-macro-calls.rs

rustdoc: Fix doctest heuristic for main fn wrapping

2025-05-01 11:56:11 +02:00

main-alongside-stmts.rs

rustdoc: Fix doctest heuristic for main fn wrapping

2025-05-01 11:56:11 +02:00

main-alongside-stmts.stderr

Emit a warning if the doctest main function will not be run

2025-05-02 13:57:53 +02:00

main-alongside-stmts.stdout

rustdoc: Fix doctest heuristic for main fn wrapping

2025-05-01 11:56:11 +02:00

merged-ignore-no_run.rs

Remove the -test suffix from normalize directives

2024-12-27 19:58:16 +11:00

merged-ignore-no_run.stdout

Stabilize the 2024 edition

2024-11-22 11:12:15 -08:00

nested-main.rs

Remove the -test suffix from normalize directives

2024-12-27 19:58:16 +11:00

nested-main.stdout

Add regression test for #131893

2024-10-24 21:35:15 +02:00

no-run-flag-error.rs

compiletest: Require //~ annotations even if error-pattern is specified

2025-04-03 11:08:55 +03:00

no-run-flag-error.stderr

…

no-run-flag.rs

Remove the -test suffix from normalize directives

2024-12-27 19:58:16 +11:00

no-run-flag.stdout

…

nocapture-fail.rs

Remove the -test suffix from normalize directives

2024-12-27 19:58:16 +11:00

nocapture-fail.stderr

…

nocapture-fail.stdout

…

nocapture.rs

Remove the -test suffix from normalize directives

2024-12-27 19:58:16 +11:00

nocapture.stderr

…

nocapture.stdout

…

non_local_defs.rs

Remove the -test suffix from normalize directives

2024-12-27 19:58:16 +11:00

non_local_defs.stderr

Remove deprecation note in the non_local_definitions warning

2024-10-11 21:21:32 +02:00

non_local_defs.stdout

Revert "Switch back non_local_definitions lint to allow-by-default"

2024-09-23 09:23:04 +02:00

non-local-defs-impl.rs

chore: fix some typos

2024-12-31 15:11:18 +08:00

non-local-defs-impl.stdout

Remove deprecation note in the non_local_definitions warning

2024-10-11 21:21:32 +02:00

per-target-ignores.rs

ignore doctests only in specified targets

2025-03-25 15:39:41 +09:00

per-target-ignores.stdout

ignore doctests only in specified targets

2025-03-25 15:39:41 +09:00

private-doc-test.rs

[AUTO_GENERATED] Migrate compiletest to use ui_test-style //@ directives

2024-02-22 16:04:04 +00:00

private-item-doc-test.rs

…

private-item-doc-test.stderr

…

private-public-item-doc-test.rs

…

private-public-item-doc-test.stderr

…

public-reexported-item-doc-test.rs

[AUTO_GENERATED] Migrate compiletest to use ui_test-style //@ directives

2024-02-22 16:04:04 +00:00

relative-path-include-bytes-132203.edition2015.stdout

Do not suggest using -Zmacro-backtrace for builtin macros

2025-03-14 19:50:03 +00:00

relative-path-include-bytes-132203.edition2024.stdout

rustdoc: make doctest span tweak a 2024 edition change

2024-10-26 17:56:38 -07:00

relative-path-include-bytes-132203.rs

Enable relative-path-include-bytes on Windows

2025-02-16 10:40:04 +00:00

run-directory.correct.stdout

…

run-directory.incorrect.stdout

…

run-directory.rs

Remove the -test suffix from normalize directives

2024-12-27 19:58:16 +11:00

rustflags-multiple-args.rs

Replace flag --doctest-compilation-args with a simpler one: --doctest-build-arg

2025-04-15 15:44:45 +02:00

rustflags-multiple-args.stdout

Replace flag --doctest-compilation-args with a simpler one: --doctest-build-arg

2025-04-15 15:44:45 +02:00

rustflags.rs

Replace flag --doctest-compilation-args with a simpler one: --doctest-build-arg

2025-04-15 15:44:45 +02:00

rustflags.stdout

Add regression test for --doctest-compilation-args

2024-12-20 15:17:47 +01:00

standalone-warning-2024.rs

Remove the -test suffix from normalize directives

2024-12-27 19:58:16 +11:00

standalone-warning-2024.stderr

Stabilize the 2024 edition

2024-11-22 11:12:15 -08:00

standalone-warning.rs

Rename doctest attribute standalone-crate into standalone_crate for coherency

2024-09-29 13:01:41 +02:00

stdout-and-stderr.rs

Add rustdoc-ui regression test for #140289

2025-04-25 15:55:54 +02:00

stdout-and-stderr.stdout

Add rustdoc-ui regression test for #140289

2025-04-25 15:55:54 +02:00

test-compile-fail1.rs

[AUTO_GENERATED] Migrate compiletest to use ui_test-style //@ directives

2024-02-22 16:04:04 +00:00

test-compile-fail1.stderr

…

test-compile-fail2.rs

[AUTO_GENERATED] Migrate compiletest to use ui_test-style //@ directives

2024-02-22 16:04:04 +00:00

test-compile-fail2.stderr

…

test-compile-fail3.rs

[AUTO_GENERATED] Migrate compiletest to use ui_test-style //@ directives

2024-02-22 16:04:04 +00:00

test-compile-fail3.stderr

Be more accurate about calculating display_col from a BytePos

2024-07-18 20:08:38 +00:00

test-main-alongside-exprs.stderr

Emit a warning if the doctest main function will not be run

2025-05-02 13:57:53 +02:00

test-no_std.rs

Remove the -test suffix from normalize directives

2024-12-27 19:58:16 +11:00

test-no_std.stdout

…

test-type.rs

Remove the -test suffix from normalize directives

2024-12-27 19:58:16 +11:00

test-type.stdout

…

unparseable-doc-test.rs

Remove the -test suffix from normalize directives

2024-12-27 19:58:16 +11:00

unparseable-doc-test.stdout

…

warn-main-not-called.rs

Add regression test for #140310

2025-05-02 13:57:53 +02:00

warn-main-not-called.stderr

Add regression test for #140310

2025-05-02 13:57:53 +02:00

warn-main-not-called.stdout

Add regression test for #140310

2025-05-02 13:57:53 +02:00

wrong-ast-2024.rs

Remove the -test suffix from normalize directives

2024-12-27 19:58:16 +11:00

wrong-ast-2024.stdout

Stabilize the 2024 edition

2024-11-22 11:12:15 -08:00

wrong-ast.rs

Remove the -test suffix from normalize directives

2024-12-27 19:58:16 +11:00

wrong-ast.stdout

Don't special-case if there is only one merged doctest

2024-08-13 20:14:56 +02:00