Samuel Tardieu fc4b3fa3f9 Rollup merge of #132748 - lolbinarycat:rustdoc-intra-doc-link-warn-more-54191, r=GuillaumeGomez ...

get rid of some false negatives in rustdoc::broken_intra_doc_links

rustdoc will not try to do intra-doc linking if the "path" of a link looks too much like a "real url".

however, only inline links (`[text](url)`) can actually contain a url, other types of links (reference links, shortcut links) contain a *reference* which is later resolved to an actual url.

the "path" in this case cannot be a url, and therefore it should not be skipped due to looking like a url.

fixes https://github.com/rust-lang/rust/issues/54191

to minimize the number of false positives that will be introduced, the following heuristic is used:

If there's no backticks, be lenient revert to old behavior.
This is to prevent churn by linting on stuff that isn't meant to be a link.
only shortcut links have simple enough syntax that they
are likely to be written accidentlly, collapsed and reference links
need 4 metachars, and reference links will not usually use
backticks in the reference name.
therefore, only shortcut syntax gets the lenient behavior.
here's a truth table for how link kinds that cannot be urls are handled:

|              |  is shortcut link  | not shortcut link |
|--------------|--------------------|-------------------|
| has backtick |    never ignore    |    never ignore   |
| no backtick  | ignore if url-like |    never ignore   |

2025-08-02 11:24:20 +02:00

..

argfile

Remove the -test suffix from normalize directives

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

auxiliary

Move "unused_exter_crate" test from rustdoc-ui to rustdoc

2025-02-27 13:22:46 +00:00

coverage

compiletest: Support matching on diagnostics without a span

2025-03-25 17:33:09 +03:00

doctest

Rollup merge of #144308 - GuillaumeGomez:merged-doctest-times, r=lolbinarycat

2025-07-30 19:49:02 +02:00

error-in-impl-trait

Remove the -test suffix from normalize directives

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

generate-link-to-definition

compiletest: Support matching on diagnostics without a span

2025-03-25 17:33:09 +03:00

intra-doc

move bad-intra-doc test into intra-doc dir

2025-07-24 11:17:14 -05:00

issues

Rework #[doc(cfg(..))] checks as distinct pass in rustdoc

2025-05-29 21:50:14 +02:00

lints

adjust more unit tests to reflect more aggressive intra-doc linting

2025-07-24 11:17:13 -05:00

scrape-examples

compiletest: Support matching on diagnostics without a span

2025-03-25 17:33:09 +03:00

suggestions

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

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

synthetic-auto-trait-impls

fix rustdoc test

2024-12-07 21:37:15 +00:00

2024-doctests-checks.rs

Update rustdoc ui tests

2025-07-24 11:06:28 +02:00

2024-doctests-checks.stdout

Update rustdoc ui tests

2025-07-24 11:06:28 +02:00

2024-doctests-crate-attribute.rs

Update rustdoc ui tests

2025-07-24 11:06:28 +02:00

2024-doctests-crate-attribute.stdout

Update rustdoc ui tests

2025-07-24 11:06:28 +02:00

ambiguous-inherent-assoc-ty.rs

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

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

apit-46976.rs

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

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

associated-constant-not-allowed-102467.rs

rustdoc: rename issue-\d+.rs tests to have meaningful names

2024-09-12 13:47:51 -07:00

associated-constant-not-allowed-102467.stderr

rustdoc: re-bless stderrs after renaming the test case

2024-09-12 13:48:51 -07:00

bounded-hr-lifetime.rs

Simple modification of diagnostic information

2023-12-21 10:17:11 +08:00

bounded-hr-lifetime.stderr

Simple modification of diagnostic information

2023-12-21 10:17:11 +08:00

cfg-boolean-literal.rs

Stabilize cfg_boolean_literals

2025-04-03 18:10:48 +00:00

check-cfg.rs

Stabilize checking of cfgs at compile-time: --check-cfg option

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

check-cfg.stderr

Move --check-cfg documentation to stable books

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

check-doc-alias-attr-location.rs

Move /src/test to /tests

2023-01-11 09:32:08 +00:00

check-doc-alias-attr-location.stderr

Specify of_trait in Target::Impl.

2025-07-17 22:21:21 +00:00

check-doc-alias-attr.rs

Move /src/test to /tests

2023-01-11 09:32:08 +00:00

check-doc-alias-attr.stderr

Move /src/test to /tests

2023-01-11 09:32:08 +00:00

circular-intra-doc-link-48414.rs

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

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

const_arg_in_type_position.rs

rustdoc: run more HIR validation to mirror rustc

2023-03-30 14:55:03 +02:00

const_arg_in_type_position.stderr

Bless rustdoc-ui tests

2023-11-24 19:15:52 +01:00

const-evalutation-ice.rs

Use the informative error as the main const eval error message

2025-06-02 15:37:15 +00:00

const-evalutation-ice.stderr

const-eval error: always say in which item the error occurred

2025-06-07 13:42:30 +02:00

crate-reference-in-block-module.rs

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

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

custom_code_classes_in_docs-warning3.rs

rustdoc: {Meta,Pointee,}Sized in non-minicore

2025-06-16 23:04:36 +00:00

custom_code_classes_in_docs-warning3.stderr

rustdoc: {Meta,Pointee,}Sized in non-minicore

2025-06-16 23:04:36 +00:00

deprecated-attrs.rs

UI tests: migrate remaining compile time error-patterns to line annotations

2025-04-13 21:48:53 +03:00

deprecated-attrs.stderr

UI tests: migrate remaining compile time error-patterns to line annotations

2025-04-13 21:48:53 +03:00

deref-generic.rs

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

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

diagnostic-width.rs

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

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

diagnostic-width.stderr

Fix rustdoc test

2025-03-07 17:55:08 +00:00

disambiguator-endswith-named-suffix.rs

adjust more unit tests to reflect more aggressive intra-doc linting

2025-07-24 11:17:13 -05:00

disambiguator-endswith-named-suffix.stderr

adjust more unit tests to reflect more aggressive intra-doc linting

2025-07-24 11:17:13 -05:00

disambiguator-macro-endswith-exclamatory.rs

add test for #126986

2024-06-28 08:01:07 +08:00

disambiguator-macro-endswith-exclamatory.stderr

add test for #126986

2024-06-28 08:01:07 +08:00

doc-alias-assoc-const.rs

Move /src/test to /tests

2023-01-11 09:32:08 +00:00

doc-alias-assoc-const.stderr

Bless rustdoc-ui tests

2023-11-24 19:15:52 +01:00

doc-alias-crate-level.rs

Move /src/test to /tests

2023-01-11 09:32:08 +00:00

doc-alias-crate-level.stderr

Move /src/test to /tests

2023-01-11 09:32:08 +00:00

doc-alias-same-name.rs

Move /src/test to /tests

2023-01-11 09:32:08 +00:00

doc-alias-same-name.stderr

Bless rustdoc-ui tests

2023-11-24 19:15:52 +01:00

doc-cfg-check-cfg.cfg_empty.stderr

Rework #[doc(cfg(..))] checks as distinct pass in rustdoc

2025-05-29 21:50:14 +02:00

doc-cfg-check-cfg.rs

Rework #[doc(cfg(..))] checks as distinct pass in rustdoc

2025-05-29 21:50:14 +02:00

doc-cfg-unstable.rs

Stabilize cfg_boolean_literals

2025-04-03 18:10:48 +00:00

doc-cfg-unstable.stderr

Stabilize cfg_boolean_literals

2025-04-03 18:10:48 +00:00

doc-cfg.rs

rustdoc: use custom CfgMatchesLintEmitter to make check-cfg work

2025-05-26 21:52:21 +02:00

doc-cfg.stderr

Rework #[doc(cfg(..))] checks as distinct pass in rustdoc

2025-05-29 21:50:14 +02:00

doc-include-suggestion.rs

Update ui tests

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

doc-include-suggestion.stderr

Update ui tests

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

doctest-output.rs

compiletest: Support matching on diagnostics without a span

2025-03-25 17:33:09 +03:00

doctest-output.stderr

Improve check for --output-format combinations and add ui regression test

2025-01-29 15:18:14 +01:00

extract-doctests-result.rs

Add new extracted option doctest ui test for result returning doctest

2025-06-10 13:54:47 +02:00

extract-doctests-result.stdout

Add new extracted option doctest ui test for result returning doctest

2025-06-10 13:54:47 +02:00

extract-doctests.rs

Add ui test for new rustdoc --output-format=doctest option

2025-01-29 13:57:27 +01:00

extract-doctests.stdout

Give more information into extracted doctest information

2025-06-10 13:54:46 +02:00

feature-gate-doc_cfg_hide.rs

Move /src/test to /tests

2023-01-11 09:32:08 +00:00

feature-gate-doc_cfg_hide.stderr

Bless tests

2024-01-13 12:46:58 -05:00

hashtag-doctest.rs

Add regression test for #136899

2025-02-12 19:46:07 +01:00

hidden-trait-method-34423.rs

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

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

ice-assoc-const-for-primitive-31808.rs

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

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

ice-assoc-type-loop-102154.rs

Move assertion-free rustdoc ice tests to rustdoc-ui

2024-07-12 18:18:30 -07:00

ice-blanket-impl-52873.rs

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

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

ice-blanket-impl-56701.rs

Move ice tests to rustdoc-ui

2024-04-15 15:11:49 -07:00

ice-blanket-impl-119792.rs

Add a regression test for a former blanket impl synthesis ICE

2024-06-03 03:50:15 +02:00

ice-blanket-impl-selection-55001.rs

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

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

ice-bug-report-url.rs

compiletest: Support matching on non-json lines in compiler output

2025-05-04 18:27:45 +03:00

ice-bug-report-url.stderr

compiletest: Support matching on non-json lines in compiler output

2025-05-04 18:27:45 +03:00

ice-cross-crate-opaque-assoc-type-73061.rs

Move ice tests to rustdoc-ui

2024-04-15 15:11:49 -07:00

ice-method-where-clause-circular-100620.rs

Move assertion-free rustdoc ice tests to rustdoc-ui

2024-07-12 18:18:30 -07:00

ice-unresolved-import-100241.rs

Move assertion-free rustdoc ice tests to rustdoc-ui

2024-07-12 18:18:30 -07:00

ice-unresolved-import-100241.stderr

Reword "crate not found" resolve message

2025-01-24 01:19:50 +00:00

ignore-block-help.rs

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

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

ignore-block-help.stderr

Move /src/test to /tests

2023-01-11 09:32:08 +00:00

impl-fn-nesting.rs

Move /src/test to /tests

2023-01-11 09:32:08 +00:00

impl-fn-nesting.stderr

Make configure_and_expand "infalllible" by just aborting the compilation if it fails instead of bubbling out an error

2023-02-20 15:28:59 +00:00

include-str-bare-urls.rs

compiletest: Support matching on diagnostics without a span

2025-03-25 17:33:09 +03:00

include-str-bare-urls.stderr

Adjust rustdoc automatic link suggestion

2024-07-04 00:40:04 +00:00

infinite-recursive-type.rs

Move /src/test to /tests

2023-01-11 09:32:08 +00:00

infinite-recursive-type.stderr

Bless rustdoc-ui tests

2023-11-24 19:15:52 +01:00

inherent-assoc-consts-36031.rs

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

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

invalid_associated_const.rs

Rename HIR TypeBinding to AssocItemConstraint and related cleanup

2024-05-30 22:52:33 +02:00

invalid_associated_const.stderr

Fix associated item removal suggestion

2024-07-17 21:30:40 +00:00

invalid_const_in_lifetime_position.rs

Refactor dyn-compatibility error and suggestions

2025-01-22 09:20:57 -08:00

invalid_const_in_lifetime_position.stderr

Compiler: Finalize dyn compatibility renaming

2025-01-26 21:20:31 +01:00

invalid_infered_static_and_const.rs

rustdoc: run more HIR validation to mirror rustc

2023-03-30 14:55:03 +02:00

invalid_infered_static_and_const.stderr

Replace ItemCtxt::report_placeholder_type_error match with a call to TyCtxt::def_descr

2025-06-30 20:36:16 +02:00

invalid-cfg.rs

Move /src/test to /tests

2023-01-11 09:32:08 +00:00

invalid-cfg.stderr

Move /src/test to /tests

2023-01-11 09:32:08 +00:00

invalid-keyword.rs

Move /src/test to /tests

2023-01-11 09:32:08 +00:00

invalid-keyword.stderr

Remove rustc::existing_doc_keyword lint.

2024-12-17 13:56:10 +11:00

invalid-redundant-explicit-link.rs

Add regression test for #123158

2024-03-28 11:09:08 +01:00

invalid-syntax.rs

UI tests: add missing diagnostic kinds where possible

2025-04-08 23:06:31 +03:00

invalid-syntax.stderr

Account for /// when rendering multiline spans

2024-12-13 18:48:33 +00:00

invalid-theme-name.rs

UI tests: migrate remaining compile time error-patterns to line annotations

2025-04-13 21:48:53 +03:00

invalid-theme-name.stderr

Move /src/test to /tests

2023-01-11 09:32:08 +00:00

macro-docs.rs

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

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

macro-docs.stderr

Move /src/test to /tests

2023-01-11 09:32:08 +00:00

mismatched_arg_count.rs

rustdoc: remove excess from rustdoc test

2023-03-30 14:55:03 +02:00

mismatched_arg_count.stderr

Revert suggestion verbosity change

2024-07-22 22:51:53 +00:00

multi-par-footnote.rs

rustdoc: Enable Markdown extensions when looking for doctests

2025-04-09 13:04:57 -04:00

multi-par-footnote.stdout

rustdoc: Enable Markdown extensions when looking for doctests

2025-04-09 13:04:57 -04:00

nested-extern-crate-46271.rs

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

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

nested-macro-rules-47639.rs

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

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

normalize-cycle.rs

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

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

normalize-in-inlined-type-alias.rs

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

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

normalize-overflow.rs

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

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

not-wf-ambiguous-normalization.rs

Merge check_mod_impl_wf and check_mod_type_wf

2024-03-07 06:27:09 +00:00

not-wf-ambiguous-normalization.stderr

Merge check_mod_impl_wf and check_mod_type_wf

2024-03-07 06:27:09 +00:00

output-format-html-stable.rs

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

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

private-type-cycle-110629.rs

rustdoc: rename issue-\d+.rs tests to have meaningful names

2024-09-12 13:47:51 -07:00

private-type-cycle-dyn-110629.rs

rustdoc: rename issue-\d+.rs tests to have meaningful names

2024-09-12 13:47:51 -07:00

private-type-cycle-dyn-110629.stderr

rustdoc: re-bless stderrs after renaming the test case

2024-09-12 13:48:51 -07:00

proc_macro_bug.rs

Test rustdoc encountering proc_macro_derive in a non-proc-macro crate

2023-02-23 09:00:33 +00:00

proc_macro_bug.stderr

Bless rustdoc-ui tests

2023-11-24 19:15:52 +01:00

projection-as-union-type-error.rs

rustdoc: add two regression tests

2024-09-09 22:35:10 +02:00

projection-as-union-type-error.stderr

rustdoc: add two regression tests

2024-09-09 22:35:10 +02:00

pub-use-primitive-document-private-items-95633.rs

Move tests into appropriate subdirectories

2024-05-21 21:21:26 -07:00

range-pattern.rs

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

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

recursive-deref-ice.rs

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

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

recursive-type-alias-impl-trait-declaration-too-subtle-2.rs

rustdoc: add two regression tests

2024-09-09 22:35:10 +02:00

redundant-explicit-links-123677.rs

rustdoc: check redundant explicit links with correct itemid

2024-04-13 19:32:39 -07:00

remap-path-prefix-failed-doctest-output.rs

Remove the -test suffix from normalize directives

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

remap-path-prefix-failed-doctest-output.stdout

Try to write the panic message with a single write_all call

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

remap-path-prefix-invalid-doctest.rs

Remove the -test suffix from normalize directives

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

remap-path-prefix-invalid-doctest.stdout

Update rustdoc-ui tests

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

remap-path-prefix-lint.rs

compiletest: Support matching on diagnostics without a span

2025-03-25 17:33:09 +03:00

remap-path-prefix-lint.stderr

Add regression test for #69264

2024-08-06 16:56:48 +02:00

remap-path-prefix-macro.rs

Fix ICE: attempted to remap an already remapped filename

2025-03-16 23:37:09 +01:00

remap-path-prefix-passed-doctest-output.rs

Remove the -test suffix from normalize directives

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

remap-path-prefix-passed-doctest-output.stdout

rustdoc: Add support for --remap-path-prefix

2024-06-09 10:34:54 -07:00

rustc-check-passes.rs

Move /src/test to /tests

2023-01-11 09:32:08 +00:00

rustc-check-passes.stderr

terminology: #[feature] *enables* a feature (instead of "declaring" or "activating" it)

2024-10-22 07:37:54 +01:00

search-index-generics-recursion-bug-issue-59502.rs

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

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

show-coverage-json.rs

Add UI regressions tests for rustdoc --show-coverage option

2024-11-04 14:46:04 +01:00

show-coverage-json.stdout

Do not emit missing_doc_code_examples rustdoc lint on module and a few other items

2024-11-28 21:22:06 +01:00

show-coverage.rs

Add UI regressions tests for rustdoc --show-coverage option

2024-11-04 14:46:04 +01:00

show-coverage.stdout

Do not emit missing_doc_code_examples rustdoc lint on module and a few other items

2024-11-28 21:22:06 +01:00

super-glob-40936.rs

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

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

target-feature-stability.rs

rustdoc: {Meta,Pointee,}Sized in non-minicore

2025-06-16 23:04:36 +00:00

track-diagnostics.rs

refactor: Make -Ztrack-diagnostics emit like a note

2025-07-03 07:19:25 -06:00

track-diagnostics.stderr

refactor: Make -Ztrack-diagnostics emit like a note

2025-07-03 07:19:25 -06:00

tuple-variadic-check.rs

Move /src/test to /tests

2023-01-11 09:32:08 +00:00

tuple-variadic-check.stderr

Bless rustdoc-ui tests

2023-11-24 19:15:52 +01:00

unable-fulfill-trait.rs

Dont create trait object if it has errors in it

2024-11-23 23:31:30 +00:00

unable-fulfill-trait.stderr

Dont create trait object if it has errors in it

2024-11-23 23:31:30 +00:00

unescaped_backticks.rs

Remove last vestiges of HybridBitSet.

2024-11-29 17:23:34 +11:00

unescaped_backticks.stderr

rustdoc: improve diagnostics on raw doc fragments

2025-05-22 12:31:28 -05:00

use_both_out_dir_and_output_options.rs

compiletest: Support matching on diagnostics without a span

2025-03-25 17:33:09 +03:00

use_both_out_dir_and_output_options.stderr

Move /src/test to /tests

2023-01-11 09:32:08 +00:00

wasm-safe.rs

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

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