-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
68 changed files
with
1,434 additions
and
273 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| [alias] | ||
| uitest = "test --test compile-test" | ||
| dev = "run --package clippy_dev --bin clippy_dev --manifest-path clippy_dev/Cargo.toml --" | ||
| dev = "run --target-dir clippy_dev/target --package clippy_dev --bin clippy_dev --manifest-path clippy_dev/Cargo.toml --" | ||
|
|
||
| [build] | ||
| rustflags = ["-Zunstable-options"] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -189,6 +189,35 @@ Clippy in the `rust-lang/rust` repository. | |
| For general information about `subtree`s in the Rust repository see [Rust's | ||
| `CONTRIBUTING.md`][subtree]. | ||
|
|
||
| ### Patching git-subtree to work with big repos | ||
|
|
||
| Currently there's a bug in `git-subtree` that prevents it from working properly | ||
| with the [`rust-lang/rust`] repo. There's an open PR to fix that, but it's stale. | ||
| Before continuing with the following steps, we need to manually apply that fix to | ||
| our local copy of `git-subtree`. | ||
|
|
||
| You can get the patched version of `git-subtree` from [here][gitgitgadget-pr]. | ||
| Put this file under `/usr/lib/git-core` (taking a backup of the previous file) | ||
| and make sure it has the proper permissions: | ||
|
|
||
| ```bash | ||
| sudo cp --backup /path/to/patched/git-subtree.sh /usr/lib/git-core/git-subtree | ||
| sudo chmod --reference=/usr/lib/git-core/git-subtree~ /usr/lib/git-core/git-subtree | ||
| sudo chown --reference=/usr/lib/git-core/git-subtree~ /usr/lib/git-core/git-subtree | ||
| ``` | ||
|
|
||
| _Note:_ The first time running `git subtree push` a cache has to be built. This | ||
| involves going through the complete Clippy history once. For this you have to | ||
| increase the stack limit though, which you can do with `ulimit -s 60000`. | ||
| Make sure to run the `ulimit` command from the same session you call git subtree. | ||
|
|
||
| _Note:_ If you are a Debian user, `dash` is the shell used by default for scripts instead of `sh`. | ||
| This shell has a hardcoded recursion limit set to 1000. In order to make this process work, | ||
| you need to force the script to run `bash` instead. You can do this by editing the first | ||
| line of the `git-subtree` script and changing `sh` to `bash`. | ||
|
|
||
| ### Performing the sync | ||
|
|
||
| Here is a TL;DR version of the sync process (all of the following commands have | ||
| to be run inside the `rust` directory): | ||
|
|
||
|
|
@@ -198,6 +227,7 @@ to be run inside the `rust` directory): | |
| # Make sure to change `your-github-name` to your github name in the following command | ||
| git subtree push -P src/tools/clippy [email protected]:your-github-name/rust-clippy sync-from-rust | ||
| ``` | ||
|
|
||
| _Note:_ This will directly push to the remote repository. You can also push | ||
| to your local copy by replacing the remote address with `/path/to/rust-clippy` | ||
| directory. | ||
|
|
@@ -213,14 +243,30 @@ to be run inside the `rust` directory): | |
| 3. Open a PR to `rust-lang/rust-clippy` and wait for it to get merged (to | ||
| accelerate the process ping the `@rust-lang/clippy` team in your PR and/or | ||
| ~~annoy~~ ask them in the [Discord] channel.) | ||
| 4. Sync the `rust-lang/rust-clippy` master to the rust-copy of Clippy: | ||
|
|
||
| ### Syncing back changes in Clippy to [`rust-lang/rust`] | ||
|
|
||
| To avoid flooding the [`rust-lang/rust`] PR queue, changes in Clippy's repo are synced back | ||
| in a bi-weekly basis if there's no urgent changes. This is done starting on the day of | ||
| the Rust stable release and then every other week. That way we guarantee that | ||
| every feature in Clippy is available for 2 weeks in nightly, before it can get to beta. | ||
| For reference, the first sync following this cadence was performed the 2020-08-27. | ||
|
|
||
| All of the following commands have to be run inside the `rust` directory. | ||
|
|
||
| 1. Make sure Clippy itself is up-to-date by following the steps outlined in the previous | ||
| section if necessary. | ||
|
|
||
| 2. Sync the `rust-lang/rust-clippy` master to the rust-copy of Clippy: | ||
| ```bash | ||
| git checkout -b sync-from-clippy | ||
| git subtree pull -P src/tools/clippy https://github.com/rust-lang/rust-clippy master | ||
| ``` | ||
| 5. Open a PR to [`rust-lang/rust`] | ||
| 3. Open a PR to [`rust-lang/rust`] | ||
|
|
||
| ### Defining remotes | ||
|
|
||
| Also, you may want to define remotes, so you don't have to type out the remote | ||
| You may want to define remotes, so you don't have to type out the remote | ||
| addresses on every sync. You can do this with the following commands (these | ||
| commands still have to be run inside the `rust` directory): | ||
|
|
@@ -241,12 +287,6 @@ You can then sync with the remote names from above, e.g.: | |
| $ git subtree push -P src/tools/clippy clippy-local sync-from-rust | ||
| ``` | ||
| _Note:_ The first time running `git subtree push` a cache has to be built. This | ||
| involves going through the complete Clippy history once. For this you have to | ||
| increase the stack limit though, which you can do with `ulimit -s 60000`. For | ||
| this to work, you will need the fix of `git subtree` available | ||
| [here][gitgitgadget-pr]. | ||
| [gitgitgadget-pr]: https://github.com/gitgitgadget/git/pull/493 | ||
| [subtree]: https://rustc-dev-guide.rust-lang.org/contributing.html#external-dependencies-subtree | ||
| [`rust-lang/rust`]: https://github.com/rust-lang/rust | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,110 @@ | ||
| use crate::utils::{match_qpath, paths, span_lint_and_then, sugg}; | ||
| use if_chain::if_chain; | ||
| use rustc_ast::util::parser::AssocOp; | ||
| use rustc_errors::Applicability; | ||
| use rustc_hir::{BinOpKind, Expr, ExprKind}; | ||
| use rustc_lint::{LateContext, LateLintPass}; | ||
| use rustc_middle::ty; | ||
| use rustc_session::{declare_lint_pass, declare_tool_lint}; | ||
| use rustc_span::source_map::Spanned; | ||
|
|
||
| declare_clippy_lint! { | ||
| /// **What it does:** Checks for statements of the form `(a - b) < f32::EPSILON` or | ||
| /// `(a - b) < f64::EPSILON`. Notes the missing `.abs()`. | ||
| /// | ||
| /// **Why is this bad?** The code without `.abs()` is more likely to have a bug. | ||
| /// | ||
| /// **Known problems:** If the user can ensure that b is larger than a, the `.abs()` is | ||
| /// technically unneccessary. However, it will make the code more robust and doesn't have any | ||
| /// large performance implications. If the abs call was deliberately left out for performance | ||
| /// reasons, it is probably better to state this explicitly in the code, which then can be done | ||
| /// with an allow. | ||
| /// | ||
| /// **Example:** | ||
| /// | ||
| /// ```rust | ||
| /// pub fn is_roughly_equal(a: f32, b: f32) -> bool { | ||
| /// (a - b) < f32::EPSILON | ||
| /// } | ||
| /// ``` | ||
| /// Use instead: | ||
| /// ```rust | ||
| /// pub fn is_roughly_equal(a: f32, b: f32) -> bool { | ||
| /// (a - b).abs() < f32::EPSILON | ||
| /// } | ||
| /// ``` | ||
| pub FLOAT_EQUALITY_WITHOUT_ABS, | ||
| correctness, | ||
| "float equality check without `.abs()`" | ||
| } | ||
|
|
||
| declare_lint_pass!(FloatEqualityWithoutAbs => [FLOAT_EQUALITY_WITHOUT_ABS]); | ||
|
|
||
| impl<'tcx> LateLintPass<'tcx> for FloatEqualityWithoutAbs { | ||
| fn check_expr(&mut self, cx: &LateContext<'tcx>, expr: &'tcx Expr<'_>) { | ||
| let lhs; | ||
| let rhs; | ||
|
|
||
| // check if expr is a binary expression with a lt or gt operator | ||
| if let ExprKind::Binary(op, ref left, ref right) = expr.kind { | ||
| match op.node { | ||
| BinOpKind::Lt => { | ||
| lhs = left; | ||
| rhs = right; | ||
| }, | ||
| BinOpKind::Gt => { | ||
| lhs = right; | ||
| rhs = left; | ||
| }, | ||
| _ => return, | ||
| }; | ||
| } else { | ||
| return; | ||
| } | ||
|
|
||
| if_chain! { | ||
|
|
||
| // left hand side is a substraction | ||
| if let ExprKind::Binary( | ||
| Spanned { | ||
| node: BinOpKind::Sub, | ||
| .. | ||
| }, | ||
| val_l, | ||
| val_r, | ||
| ) = lhs.kind; | ||
|
|
||
| // right hand side matches either f32::EPSILON or f64::EPSILON | ||
| if let ExprKind::Path(ref epsilon_path) = rhs.kind; | ||
| if match_qpath(epsilon_path, &paths::F32_EPSILON) || match_qpath(epsilon_path, &paths::F64_EPSILON); | ||
|
|
||
| // values of the substractions on the left hand side are of the type float | ||
| let t_val_l = cx.typeck_results().expr_ty(val_l); | ||
| let t_val_r = cx.typeck_results().expr_ty(val_r); | ||
| if let ty::Float(_) = t_val_l.kind; | ||
| if let ty::Float(_) = t_val_r.kind; | ||
|
|
||
| then { | ||
| let sug_l = sugg::Sugg::hir(cx, &val_l, ".."); | ||
| let sug_r = sugg::Sugg::hir(cx, &val_r, ".."); | ||
| // format the suggestion | ||
| let suggestion = format!("{}.abs()", sugg::make_assoc(AssocOp::Subtract, &sug_l, &sug_r).maybe_par()); | ||
| // spans the lint | ||
| span_lint_and_then( | ||
| cx, | ||
| FLOAT_EQUALITY_WITHOUT_ABS, | ||
| expr.span, | ||
| "float equality check without `.abs()`", | ||
| | diag | { | ||
| diag.span_suggestion( | ||
| lhs.span, | ||
| "add `.abs()`", | ||
| suggestion, | ||
| Applicability::MaybeIncorrect, | ||
| ); | ||
| } | ||
| ); | ||
| } | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.