mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Rollup merge of #130219 - ogoffart:missing-docs-test, r=Urgau

Browse Source 
Fix false positive with `missing_docs` and `#[test]`

Since #130025, the compiler don't ignore missing_docs when compiling the tests. But there is now a false positive warning for every `#[test]`

For example, this code
```rust
//! Crate docs

fn just_a_test() {}
```

Would emit this warning when running `cargo test`

```
warning: missing documentation for a constant
 --> src/lib.rs:5:1
  |
4 | #[test]
  | ------- in this procedural macro expansion
5 | fn just_a_test() {}
  | ^^^^^^^^^^^^^^^^^^^
```
This commit is contained in:
Matthias Krüger 2024-09-11 20:04:25 +02:00 committed by GitHub
commit 66727ea1a2
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 15 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
compiler/rustc_builtin_macros/src/test.rs
View File

@ -277,6 +277,8 @@ pub(crate) fn expand_test_or_bench(
cx.attr_nested_word(sym::cfg, sym::test, attr_sp), cx.attr_nested_word(sym::cfg, sym::test, attr_sp),
// #[rustc_test_marker = "test_case_sort_key"] // #[rustc_test_marker = "test_case_sort_key"]
cx.attr_name_value_str(sym::rustc_test_marker, test_path_symbol, attr_sp), cx.attr_name_value_str(sym::rustc_test_marker, test_path_symbol, attr_sp),
// #[doc(hidden)]
cx.attr_nested_word(sym::doc, sym::hidden, attr_sp),
], ],
// const $ident: test::TestDescAndFn = // const $ident: test::TestDescAndFn =
ast::ItemKind::Const( ast::ItemKind::Const(

6
compiler/rustc_builtin_macros/src/test_harness.rs
View File

@ -326,8 +326,8 @@ fn mk_main(cx: &mut TestCtxt<'_>) -> P<ast::Item> {
let main_attr = ecx.attr_word(sym::rustc_main, sp); let main_attr = ecx.attr_word(sym::rustc_main, sp);
// #[coverage(off)] // #[coverage(off)]
let coverage_attr = ecx.attr_nested_word(sym::coverage, sym::off, sp); let coverage_attr = ecx.attr_nested_word(sym::coverage, sym::off, sp);
// #[allow(missing_docs)] // #[doc(hidden)]
let missing_docs_attr = ecx.attr_nested_word(sym::allow, sym::missing_docs, sp); let doc_hidden_attr = ecx.attr_nested_word(sym::doc, sym::hidden, sp);
// pub fn main() { ... } // pub fn main() { ... }
let main_ret_ty = ecx.ty(sp, ast::TyKind::Tup(ThinVec::new())); let main_ret_ty = ecx.ty(sp, ast::TyKind::Tup(ThinVec::new()));
@ -357,7 +357,7 @@ fn mk_main(cx: &mut TestCtxt<'_>) -> P<ast::Item> {
let main = P(ast::Item { let main = P(ast::Item {
ident: main_id, ident: main_id,
attrs: thin_vec![main_attr, coverage_attr, missing_docs_attr], attrs: thin_vec![main_attr, coverage_attr, doc_hidden_attr],
id: ast::DUMMY_NODE_ID, id: ast::DUMMY_NODE_ID,
kind: main, kind: main,
vis: ast::Visibility { span: sp, kind: ast::VisibilityKind::Public, tokens: None }, vis: ast::Visibility { span: sp, kind: ast::VisibilityKind::Public, tokens: None },

1
compiler/rustc_span/src/symbol.rs
View File

@ -1236,7 +1236,6 @@
mir_unwind_unreachable, mir_unwind_unreachable,
mir_variant, mir_variant,
miri, miri,
missing_docs,
mmx_reg, mmx_reg,
modifiers, modifiers,
module, module,

5
tests/pretty/tests-are-sorted.pp
View File

@ -12,6 +12,7 @@ extern crate std;
extern crate test; extern crate test;
#[cfg(test)] #[cfg(test)]
#[rustc_test_marker = "m_test"] #[rustc_test_marker = "m_test"]
#[doc(hidden)]
pub const m_test: test::TestDescAndFn = pub const m_test: test::TestDescAndFn =
test::TestDescAndFn { test::TestDescAndFn {
desc: test::TestDesc { desc: test::TestDesc {
@ -36,6 +37,7 @@ fn m_test() {}
extern crate test; extern crate test;
#[cfg(test)] #[cfg(test)]
#[rustc_test_marker = "z_test"] #[rustc_test_marker = "z_test"]
#[doc(hidden)]
pub const z_test: test::TestDescAndFn = pub const z_test: test::TestDescAndFn =
test::TestDescAndFn { test::TestDescAndFn {
desc: test::TestDesc { desc: test::TestDesc {
@ -61,6 +63,7 @@ fn z_test() {}
extern crate test; extern crate test;
#[cfg(test)] #[cfg(test)]
#[rustc_test_marker = "a_test"] #[rustc_test_marker = "a_test"]
#[doc(hidden)]
pub const a_test: test::TestDescAndFn = pub const a_test: test::TestDescAndFn =
test::TestDescAndFn { test::TestDescAndFn {
desc: test::TestDesc { desc: test::TestDesc {
@ -83,7 +86,7 @@ pub const a_test: test::TestDescAndFn =
fn a_test() {} fn a_test() {}
#[rustc_main] #[rustc_main]
#[coverage(off)] #[coverage(off)]
#[allow(missing_docs)] #[doc(hidden)]
pub fn main() -> () { pub fn main() -> () {
extern crate test; extern crate test;
test::test_main_static(&[&a_test, &m_test, &z_test]) test::test_main_static(&[&a_test, &m_test, &z_test])

7
tests/ui/lint/lint-missing-doc-test.rs
View File

@ -2,4 +2,9 @@
//! on the generated test harness. //! on the generated test harness.
//@ check-pass //@ check-pass
//@ compile-flags: --test -Dmissing_docs //@ compile-flags: --test
#![forbid(missing_docs)]
#[test]
fn test() {}