diff --git a/.cargo/config b/.cargo/config new file mode 100644 index 000000000000..7cb41d979a6a --- /dev/null +++ b/.cargo/config @@ -0,0 +1,2 @@ +[alias] +uitest = "test --test compile-test" diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5619ee00f8d9..7ae8f3936a48 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -101,7 +101,7 @@ fn main() { } ``` -Now you run `TESTNAME=ui/my_lint cargo test --test compile-test` to produce +Now you run `TESTNAME=ui/my_lint cargo uitest` to produce a `.stdout` file with the generated code: ```rust @@ -151,7 +151,7 @@ Use `cargo test` to run the whole testsuite. If you don't want to wait for all tests to finish, you can also execute a single test file by using `TESTNAME` to specify the test to run: ```bash -TESTNAME=ui/empty_line_after_outer_attr cargo test --test compile-test +TESTNAME=ui/empty_line_after_outer_attr cargo uitest ``` Clippy uses UI tests. UI tests check that the output of the compiler is exactly as expected. diff --git a/clippy_lints/src/utils/author.rs b/clippy_lints/src/utils/author.rs index 264a5463225d..4e2d4de85188 100644 --- a/clippy_lints/src/utils/author.rs +++ b/clippy_lints/src/utils/author.rs @@ -25,7 +25,7 @@ use syntax::ast::{Attribute, LitKind, DUMMY_NODE_ID}; /// } /// ``` /// -/// Running `TESTNAME=ui/my_lint cargo test --test compile-test` will produce +/// Running `TESTNAME=ui/my_lint cargo uitest` will produce /// a `./tests/ui/new_lint.stdout` file with the generated code: /// /// ```rust