Skip to content

Add "doc(test(...))" attribute checks #87728

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bors merged 3 commits into from
Aug 18, 2021
Merged

Add "doc(test(...))" attribute checks #87728

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cbfe874
Add check for doc(test(...)) attribute
GuillaumeGomez Aug 3, 2021
4ba54ff
Add UI tests for doc(test(...)) attribute checks
GuillaumeGomez Aug 3, 2021
d4293ff
Move working checks into separate test files
GuillaumeGomez Aug 7, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Add check for doc(test(...)) attribute
  • Loading branch information
@GuillaumeGomez
GuillaumeGomez committed Aug 16, 2021
commit cbfe8749c2bef9b4a0b9c1c8637e3ee578caf038
45 changes: 43 additions & 2 deletions compiler/rustc_passes/src/check_attr.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -717,6 +717,42 @@ impl CheckAttrVisitor<'tcx> {
true
}

/// Checks that `doc(test(...))` attribute contains only valid attributes. Returns `true` if
/// valid.
fn check_test_attr(&self, meta: &NestedMetaItem, hir_id: HirId) -> bool {
let mut is_valid = true;
if let Some(metas) = meta.meta_item_list() {
for i_meta in metas {
Comment thread
GuillaumeGomez marked this conversation as resolved.
Outdated
match i_meta.name_or_empty() {
sym::attr | sym::no_crate_inject => {}
_ => {
self.tcx.struct_span_lint_hir(
INVALID_DOC_ATTRIBUTES,
hir_id,
i_meta.span(),
|lint| {
lint.build(&format!(
"unknown `doc(test)` attribute `{}`",
rustc_ast_pretty::pprust::path_to_string(
&i_meta.meta_item().unwrap().path
),
))
.emit();
},
);
is_valid = false;
}
}
}
} else {
self.tcx.struct_span_lint_hir(INVALID_DOC_ATTRIBUTES, hir_id, meta.span(), |lint| {
lint.build("`#[doc(test(...)]` takes a list of attributes").emit();
});
is_valid = false;
}
is_valid
}

/// Runs various checks on `#[doc]` attributes. Returns `true` if valid.
///
/// `specified_inline` should be initialized to `None` and kept for the scope
Expand Down Expand Up @@ -793,8 +829,13 @@ impl CheckAttrVisitor<'tcx> {
| sym::no_inline
| sym::notable_trait
| sym::passes
| sym::plugins
| sym::test => {}
| sym::plugins => {}

sym::test => {
if !self.check_test_attr(&meta, hir_id) {
is_valid = false;
}
}

sym::primitive => {
if !self.tcx.features().doc_primitive {
Expand Down