<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>src/tools/clippy/README.md - fork/rust @ master</title>
<meta name="description" content="src/tools/clippy/README.md in fork/rust at master.">
<meta property="og:title" content="src/tools/clippy/README.md - fork/rust @ master">
<meta property="og:description" content="src/tools/clippy/README.md in fork/rust at master.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="master" data-tip="3bcad65fbf67b6edf87c949531fbc13435882e6b">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/rust</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/rust</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">bors</span><span class="commit-message" data-commit="3bcad65fbf67b6edf87c949531fbc13435882e6b">Auto merge of #103046 - JanBeh:PR_clarify_cmp_terminology, r=workingjubilee</span><span class="snapshot-sha sha" data-commit="3bcad65fbf67b6edf87c949531fbc13435882e6b">3bcad65fbf6</span><time datetime="2023-10-05T15:24:54+00:00" title="2023-10-05 15:24:54 +0000">2023-10-05</time></p>
<header class="topbar"><details class="switcher"><summary>master</summary><div class="menu"><strong>branches</strong><a class="current" href="/fork/rust/ref/master/">master</a><strong>tags</strong><a href="/fork/rust/ref/1.39.0/">1.39.0</a><a href="/fork/rust/ref/1.40.0/">1.40.0</a><a href="/fork/rust/ref/1.41.0/">1.41.0</a><a href="/fork/rust/ref/1.41.1/">1.41.1</a><a href="/fork/rust/ref/1.42.0/">1.42.0</a><a href="/fork/rust/ref/1.43.0/">1.43.0</a><a href="/fork/rust/ref/1.43.1/">1.43.1</a><a href="/fork/rust/ref/1.44.0/">1.44.0</a><a class="all" href="/fork/rust/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/rust/">rust</a> / <a href="/fork/rust/ref/master/tree/src/">src</a> / <a href="/fork/rust/ref/master/tree/src/tools/">tools</a> / <a href="/fork/rust/ref/master/tree/src/tools/clippy/">clippy</a> / <span class="cur">README.md</span></nav>
<span class="view-stats"><span>10.8 KiB</span><span>289 lines</span></span><span class="actions"><a class="raw" href="/fork/rust/raw/5d490645d8979e88d12cd183a73fe0b35f8ffdba/src/tools/clippy/README.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered"><h1>Clippy</h1>
<p><a href="https://github.com/rust-lang/rust-clippy/actions?query=workflow%3A%22Clippy+Test+(bors)%22+event%3Apush+branch%3Aauto"><img src="https://github.com/rust-lang/rust-clippy/workflows/Clippy%20Test%20(bors)/badge.svg?branch=auto&amp;event=push" alt="Clippy Test" /></a>
<a href="#license"><img src="https://img.shields.io/crates/l/clippy.svg" alt="License: MIT OR Apache-2.0" /></a></p>
<p>A collection of lints to catch common mistakes and improve your <a href="https://github.com/rust-lang/rust">Rust</a> code.</p>
<p><a href="https://rust-lang.github.io/rust-clippy/master/index.html">There are over 650 lints included in this crate!</a></p>
<p>Lints are divided into categories, each with a default <a href="https://doc.rust-lang.org/rustc/lints/levels.html">lint level</a>.
You can choose how much Clippy is supposed to <del>annoy</del> help you by changing the lint level by category.</p>
<table><thead><tr><th>Category</th><th>Description</th><th>Default level</th></tr></thead><tbody>
<tr><td><code>clippy::all</code></td><td>all lints that are on by default (correctness, suspicious, style, complexity, perf)</td><td><strong>warn/deny</strong></td></tr>
<tr><td><code>clippy::correctness</code></td><td>code that is outright wrong or useless</td><td><strong>deny</strong></td></tr>
<tr><td><code>clippy::suspicious</code></td><td>code that is most likely wrong or useless</td><td><strong>warn</strong></td></tr>
<tr><td><code>clippy::style</code></td><td>code that should be written in a more idiomatic way</td><td><strong>warn</strong></td></tr>
<tr><td><code>clippy::complexity</code></td><td>code that does something simple but in a complex way</td><td><strong>warn</strong></td></tr>
<tr><td><code>clippy::perf</code></td><td>code that can be written to run faster</td><td><strong>warn</strong></td></tr>
<tr><td><code>clippy::pedantic</code></td><td>lints which are rather strict or have occasional false positives</td><td>allow</td></tr>
<tr><td><code>clippy::restriction</code></td><td>lints which prevent the use of language and library features<sup class="footnote-reference"><a href="#restrict">1</a></sup></td><td>allow</td></tr>
<tr><td><code>clippy::nursery</code></td><td>new lints that are still under development</td><td>allow</td></tr>
<tr><td><code>clippy::cargo</code></td><td>lints for the cargo manifest</td><td>allow</td></tr>
</tbody></table>
<p>More to come, please <a href="https://github.com/rust-lang/rust-clippy/issues">file an issue</a> if you have ideas!</p>
<p>The <code>restriction</code> category should, <em>emphatically</em>, not be enabled as a whole. The contained
lints may lint against perfectly reasonable code, may not have an alternative suggestion,
and may contradict any other lints (including other categories). Lints should be considered
on a case-by-case basis before enabling.</p>
<div class="footnote-definition" id="restrict"><sup class="footnote-definition-label">1</sup>
<p>Some use cases for <code>restriction</code> lints include:</p>
<ul>
<li>Strict coding styles (e.g. <a href="https://rust-lang.github.io/rust-clippy/master/index.html#else_if_without_else"><code>clippy::else_if_without_else</code></a>).</li>
<li>Additional restrictions on CI (e.g. <a href="https://rust-lang.github.io/rust-clippy/master/index.html#todo"><code>clippy::todo</code></a>).</li>
<li>Preventing panicking in certain functions (e.g. <a href="https://rust-lang.github.io/rust-clippy/master/index.html#unwrap_used"><code>clippy::unwrap_used</code></a>).</li>
<li>Running a lint only on a subset of code (e.g. <code>#[forbid(clippy::float_arithmetic)]</code> on a module).</li>
</ul>
</div>
<hr />
<p>Table of contents:</p>
<ul>
<li><a href="#usage">Usage instructions</a></li>
<li><a href="#configuration">Configuration</a></li>
<li><a href="#contributing">Contributing</a></li>
<li><a href="#license">License</a></li>
</ul>
<h2>Usage</h2>
<p>Below are instructions on how to use Clippy as a cargo subcommand,
in projects that do not use cargo, or in Travis CI.</p>
<h3>As a cargo subcommand (<code>cargo clippy</code>)</h3>
<p>One way to use Clippy is by installing Clippy through rustup as a cargo
subcommand.</p>
<h4>Step 1: Install Rustup</h4>
<p>You can install <a href="https://rustup.rs/">Rustup</a> on supported platforms. This will help
us install Clippy and its dependencies.</p>
<p>If you already have Rustup installed, update to ensure you have the latest
Rustup and compiler:</p>
<pre>rustup update
</pre>
<h4>Step 2: Install Clippy</h4>
<p>Once you have rustup and the latest stable release (at least Rust 1.29) installed, run the following command:</p>
<pre>rustup component add clippy
</pre>
<p>If it says that it can't find the <code>clippy</code> component, please run <code>rustup self update</code>.</p>
<h4>Step 3: Run Clippy</h4>
<p>Now you can run Clippy by invoking the following command:</p>
<pre>cargo clippy
</pre>
<h4>Automatically applying Clippy suggestions</h4>
<p>Clippy can automatically apply some lint suggestions, just like the compiler. Note that <code>--fix</code> implies
<code>--all-targets</code>, so it can fix as much code as it can.</p>
<pre>cargo clippy --fix
</pre>
<h4>Workspaces</h4>
<p>All the usual workspace options should work with Clippy. For example the following command
will run Clippy on the <code>example</code> crate:</p>
<pre>cargo clippy -p example
</pre>
<p>As with <code>cargo check</code>, this includes dependencies that are members of the workspace, like path dependencies.
If you want to run Clippy <strong>only</strong> on the given crate, use the <code>--no-deps</code> option like this:</p>
<pre>cargo clippy -p example -- --no-deps
</pre>
<h3>Using <code>clippy-driver</code></h3>
<p>Clippy can also be used in projects that do not use cargo. To do so, run <code>clippy-driver</code>
with the same arguments you use for <code>rustc</code>. For example:</p>
<pre>clippy-driver --edition 2018 -Cpanic=abort foo.rs
</pre>
<p>Note that <code>clippy-driver</code> is designed for running Clippy only and should not be used as a general
replacement for <code>rustc</code>. <code>clippy-driver</code> may produce artifacts that are not optimized as expected,
for example.</p>
<h3>Travis CI</h3>
<p>You can add Clippy to Travis CI in the same way you use it locally:</p>
<pre class="language-yaml"><a-pr>language</a-pr><a-p>:</a-p> <a-s>rust</a-s>
<a-pr>rust</a-pr><a-p>:</a-p>
  <a-p>-</a-p> <a-s>stable</a-s>
  <a-p>-</a-p> <a-s>beta</a-s>
<a-pr>before_script</a-pr><a-p>:</a-p>
  <a-p>-</a-p> <a-s>rustup component add clippy</a-s>
<a-pr>script</a-pr><a-p>:</a-p>
  <a-p>-</a-p> <a-s>cargo clippy</a-s>
  <a-c># if you want the build job to fail when encountering warnings, use</a-c>
  <a-p>-</a-p> <a-s>cargo clippy -- -D warnings</a-s>
  <a-c># in order to also check tests and non-default crate features, use</a-c>
  <a-p>-</a-p> <a-s>cargo clippy --all-targets --all-features -- -D warnings</a-s>
  <a-p>-</a-p> <a-s>cargo test</a-s>
  <a-c># etc.</a-c></pre>
<p>Note that adding <code>-D warnings</code> will cause your build to fail if <strong>any</strong> warnings are found in your code.
That includes warnings found by rustc (e.g. <code>dead_code</code>, etc.). If you want to avoid this and only cause
an error for Clippy warnings, use <code>#![deny(clippy::all)]</code> in your code or <code>-D clippy::all</code> on the command
line. (You can swap <code>clippy::all</code> with the specific lint category you are targeting.)</p>
<h2>Configuration</h2>
<h3>Allowing/denying lints</h3>
<p>You can add options to your code to <code>allow</code>/<code>warn</code>/<code>deny</code> Clippy lints:</p>
<ul>
<li>
<p>the whole set of <code>Warn</code> lints using the <code>clippy</code> lint group (<code>#![deny(clippy::all)]</code>).
Note that <code>rustc</code> has additional <a href="https://doc.rust-lang.org/rustc/lints/groups.html">lint groups</a>.</p>
</li>
<li>
<p>all lints using both the <code>clippy</code> and <code>clippy::pedantic</code> lint groups (<code>#![deny(clippy::all)]</code>,
<code>#![deny(clippy::pedantic)]</code>). Note that <code>clippy::pedantic</code> contains some very aggressive
lints prone to false positives.</p>
</li>
<li>
<p>only some lints (<code>#![deny(clippy::single_match, clippy::box_vec)]</code>, etc.)</p>
</li>
<li>
<p><code>allow</code>/<code>warn</code>/<code>deny</code> can be limited to a single function or module using <code>#[allow(...)]</code>, etc.</p>
</li>
</ul>
<p>Note: <code>allow</code> means to suppress the lint for your code. With <code>warn</code> the lint
will only emit a warning, while with <code>deny</code> the lint will emit an error, when
triggering for your code. An error causes clippy to exit with an error code, so
is useful in scripts like CI/CD.</p>
<p>If you do not want to include your lint levels in your code, you can globally
enable/disable lints by passing extra flags to Clippy during the run:</p>
<p>To allow <code>lint_name</code>, run</p>
<pre>cargo clippy -- -A clippy::lint_name
</pre>
<p>And to warn on <code>lint_name</code>, run</p>
<pre>cargo clippy -- -W clippy::lint_name
</pre>
<p>This also works with lint groups. For example, you
can run Clippy with warnings for all lints enabled:</p>
<pre>cargo clippy -- -W clippy::pedantic
</pre>
<p>If you care only about a single lint, you can allow all others and then explicitly warn on
the lint(s) you are interested in:</p>
<pre>cargo clippy -- -A clippy::all -W clippy::useless_format -W clippy::...
</pre>
<h3>Configure the behavior of some lints</h3>
<p>Some lints can be configured in a TOML file named <code>clippy.toml</code> or <code>.clippy.toml</code>. It contains a basic <code>variable = value</code> mapping e.g.</p>
<pre class="language-toml"><a-pr>avoid-breaking-exported-api</a-pr> <a-o>=</a-o> <a-co>false</a-co>
<a-pr>disallowed-names</a-pr> <a-o>=</a-o> <a-p>[</a-p><a-s>&quot;toto&quot;</a-s><a-p>,</a-p> <a-s>&quot;tata&quot;</a-s><a-p>,</a-p> <a-s>&quot;titi&quot;</a-s><a-p>]</a-p></pre>
<p>The <a href="https://doc.rust-lang.org/nightly/clippy/lint_configuration.html">table of configurations</a>
contains all config values, their default, and a list of lints they affect.
Each <a href="https://rust-lang.github.io/rust-clippy/master/index.html#Configuration">configurable lint</a>
, also contains information about these values.</p>
<p>For configurations that are a list type with default values such as
<a href="https://rust-lang.github.io/rust-clippy/master/index.html#disallowed_names">disallowed-names</a>,
you can use the unique value <code>".."</code> to extend the default values instead of replacing them.</p>
<pre class="language-toml"><a-c># default of disallowed-names is [&quot;foo&quot;, &quot;baz&quot;, &quot;quux&quot;]</a-c>
<a-pr>disallowed-names</a-pr> <a-o>=</a-o> <a-p>[</a-p><a-s>&quot;bar&quot;</a-s><a-p>,</a-p> <a-s>&quot;..&quot;</a-s><a-p>]</a-p> <a-c># -&gt; [&quot;bar&quot;, &quot;foo&quot;, &quot;baz&quot;, &quot;quux&quot;]</a-c></pre>
<blockquote>
<p><strong>Note</strong></p>
<p><code>clippy.toml</code> or <code>.clippy.toml</code> cannot be used to allow/deny lints.</p>
</blockquote>
<p>To deactivate the “for further information visit <em>lint-link</em>” message you can
define the <code>CLIPPY_DISABLE_DOCS_LINKS</code> environment variable.</p>
<h3>Specifying the minimum supported Rust version</h3>
<p>Projects that intend to support old versions of Rust can disable lints pertaining to newer features by
specifying the minimum supported Rust version (MSRV) in the clippy configuration file.</p>
<pre class="language-toml"><a-pr>msrv</a-pr> <a-o>=</a-o> <a-s>&quot;1.30.0&quot;</a-s></pre>
<p>Alternatively, the <a href="https://doc.rust-lang.org/cargo/reference/manifest.html#the-rust-version-field"><code>rust-version</code> field</a>
in the <code>Cargo.toml</code> can be used.</p>
<pre class="language-toml"><a-c># Cargo.toml</a-c>
<a-pr>rust-version</a-pr> <a-o>=</a-o> <a-s>&quot;1.30&quot;</a-s></pre>
<p>The MSRV can also be specified as an attribute, like below.</p>
<pre class="language-rust"><a-at>#!</a-at><a-p>[</a-p><a-at>feature</a-at><a-p>(</a-p><a-at>custom_inner_attributes</a-at><a-p>)]</a-p>
<a-at>#!</a-at><a-p>[</a-p><a-at>clippy</a-at><a-p>::</a-p><a-at>msrv = </a-at><a-s>&quot;1.30.0&quot;</a-s><a-p>]</a-p>

<a-k>fn</a-k> <a-f>main</a-f><a-p>()</a-p> <a-p>{</a-p>
  ..<a-p>.</a-p><a-pr>
</a-pr><a-p>}</a-p></pre>
<p>You can also omit the patch version when specifying the MSRV, so <code>msrv = 1.30</code>
is equivalent to <code>msrv = 1.30.0</code>.</p>
<p>Note: <code>custom_inner_attributes</code> is an unstable feature, so it has to be enabled explicitly.</p>
<p>Lints that recognize this configuration option can be found <a href="https://rust-lang.github.io/rust-clippy/master/index.html#msrv">here</a></p>
<h2>Contributing</h2>
<p>If you want to contribute to Clippy, you can find more information in <a href="https://github.com/rust-lang/rust-clippy/blob/master/CONTRIBUTING.md">CONTRIBUTING.md</a>.</p>
<h2>License</h2>
&lt;!-- REUSE-IgnoreStart --&gt;
<p>Copyright 2014-2023 The Rust Project Developers</p>
<p>Licensed under the Apache License, Version 2.0 &lt;LICENSE-APACHE or
<a href="https://www.apache.org/licenses/LICENSE-2.0">https://www.apache.org/licenses/LICENSE-2.0</a>&gt; or the MIT license
&lt;LICENSE-MIT or <a href="https://opensource.org/licenses/MIT">https://opensource.org/licenses/MIT</a>&gt;, at your
option. Files in the project may not be
copied, modified, or distributed except according to those terms.</p>
&lt;!-- REUSE-IgnoreEnd --&gt;
</section><div class="code-panel"><pre class="code src" data-hl="src/tools/clippy/README.md"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"># Clippy</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text">[![Clippy Test](https://github.com/rust-lang/rust-clippy/workflows/Clippy%20Test%20(bors)/badge.svg?branch=auto&amp;event=push)](https://github.com/rust-lang/rust-clippy/actions?query=workflow%3A%22Clippy+Test+(bors)%22+event%3Apush+branch%3Aauto)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text">[![License: MIT OR Apache-2.0](https://img.shields.io/crates/l/clippy.svg)](#license)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text">A collection of lints to catch common mistakes and improve your [Rust](https://github.com/rust-lang/rust) code.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text">[There are over 650 lints included in this crate!](https://rust-lang.github.io/rust-clippy/master/index.html)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text">Lints are divided into categories, each with a default [lint level](https://doc.rust-lang.org/rustc/lints/levels.html).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text">You can choose how much Clippy is supposed to ~~annoy~~ help you by changing the lint level by category.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text">| Category              | Description                                                                         | Default level |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text">|-----------------------|-------------------------------------------------------------------------------------|---------------|</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text">| `clippy::all`         | all lints that are on by default (correctness, suspicious, style, complexity, perf) | **warn/deny** |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text">| `clippy::correctness` | code that is outright wrong or useless                                              | **deny**      |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text">| `clippy::suspicious`  | code that is most likely wrong or useless                                           | **warn**      |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text">| `clippy::style`       | code that should be written in a more idiomatic way                                 | **warn**      |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text">| `clippy::complexity`  | code that does something simple but in a complex way                                | **warn**      |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text">| `clippy::perf`        | code that can be written to run faster                                              | **warn**      |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text">| `clippy::pedantic`    | lints which are rather strict or have occasional false positives                    | allow         |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text">| `clippy::restriction` | lints which prevent the use of language and library features[^restrict]             | allow         |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text">| `clippy::nursery`     | new lints that are still under development                                          | allow         |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text">| `clippy::cargo`       | lints for the cargo manifest                                                        | allow         |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text">More to come, please [file an issue](https://github.com/rust-lang/rust-clippy/issues) if you have ideas!</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text">The `restriction` category should, *emphatically*, not be enabled as a whole. The contained</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text">lints may lint against perfectly reasonable code, may not have an alternative suggestion,</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text">and may contradict any other lints (including other categories). Lints should be considered</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text">on a case-by-case basis before enabling.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text">[^restrict]: Some use cases for `restriction` lints include:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text">    - Strict coding styles (e.g. [`clippy::else_if_without_else`]).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text">    - Additional restrictions on CI (e.g. [`clippy::todo`]).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text">    - Preventing panicking in certain functions (e.g. [`clippy::unwrap_used`]).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text">    - Running a lint only on a subset of code (e.g. `#[forbid(clippy::float_arithmetic)]` on a module).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text">[`clippy::else_if_without_else`]: https://rust-lang.github.io/rust-clippy/master/index.html#else_if_without_else</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L40" href="#L40">40</a><span class="code-text">[`clippy::todo`]: https://rust-lang.github.io/rust-clippy/master/index.html#todo</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text">[`clippy::unwrap_used`]: https://rust-lang.github.io/rust-clippy/master/index.html#unwrap_used</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L43" href="#L43">43</a><span class="code-text">---</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L44" href="#L44">44</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L45" href="#L45">45</a><span class="code-text">Table of contents:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L46" href="#L46">46</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text">* [Usage instructions](#usage)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L48" href="#L48">48</a><span class="code-text">* [Configuration](#configuration)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L49" href="#L49">49</a><span class="code-text">* [Contributing](#contributing)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L50" href="#L50">50</a><span class="code-text">* [License](#license)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L51" href="#L51">51</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L52" href="#L52">52</a><span class="code-text">## Usage</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L53" href="#L53">53</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L54" href="#L54">54</a><span class="code-text">Below are instructions on how to use Clippy as a cargo subcommand,</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L55" href="#L55">55</a><span class="code-text">in projects that do not use cargo, or in Travis CI.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L56" href="#L56">56</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L57" href="#L57">57</a><span class="code-text">### As a cargo subcommand (`cargo clippy`)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L58" href="#L58">58</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L59" href="#L59">59</a><span class="code-text">One way to use Clippy is by installing Clippy through rustup as a cargo</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L60" href="#L60">60</a><span class="code-text">subcommand.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L61" href="#L61">61</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L62" href="#L62">62</a><span class="code-text">#### Step 1: Install Rustup</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L63" href="#L63">63</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L64" href="#L64">64</a><span class="code-text">You can install [Rustup](https://rustup.rs/) on supported platforms. This will help</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L65" href="#L65">65</a><span class="code-text">us install Clippy and its dependencies.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L66" href="#L66">66</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L67" href="#L67">67</a><span class="code-text">If you already have Rustup installed, update to ensure you have the latest</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L68" href="#L68">68</a><span class="code-text">Rustup and compiler:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L69" href="#L69">69</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L70" href="#L70">70</a><span class="code-text">```terminal</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L71" href="#L71">71</a><span class="code-text">rustup update</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L72" href="#L72">72</a><span class="code-text">```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L73" href="#L73">73</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L74" href="#L74">74</a><span class="code-text">#### Step 2: Install Clippy</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L75" href="#L75">75</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L76" href="#L76">76</a><span class="code-text">Once you have rustup and the latest stable release (at least Rust 1.29) installed, run the following command:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L77" href="#L77">77</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L78" href="#L78">78</a><span class="code-text">```terminal</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L79" href="#L79">79</a><span class="code-text">rustup component add clippy</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L80" href="#L80">80</a><span class="code-text">```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L81" href="#L81">81</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L82" href="#L82">82</a><span class="code-text">If it says that it can't find the `clippy` component, please run `rustup self update`.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L83" href="#L83">83</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L84" href="#L84">84</a><span class="code-text">#### Step 3: Run Clippy</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L85" href="#L85">85</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L86" href="#L86">86</a><span class="code-text">Now you can run Clippy by invoking the following command:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L87" href="#L87">87</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L88" href="#L88">88</a><span class="code-text">```terminal</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L89" href="#L89">89</a><span class="code-text">cargo clippy</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L90" href="#L90">90</a><span class="code-text">```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L91" href="#L91">91</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L92" href="#L92">92</a><span class="code-text">#### Automatically applying Clippy suggestions</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L93" href="#L93">93</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L94" href="#L94">94</a><span class="code-text">Clippy can automatically apply some lint suggestions, just like the compiler. Note that `--fix` implies</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L95" href="#L95">95</a><span class="code-text">`--all-targets`, so it can fix as much code as it can.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L96" href="#L96">96</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L97" href="#L97">97</a><span class="code-text">```terminal</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L98" href="#L98">98</a><span class="code-text">cargo clippy --fix</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L99" href="#L99">99</a><span class="code-text">```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L100" href="#L100">100</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L101" href="#L101">101</a><span class="code-text">#### Workspaces</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L102" href="#L102">102</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L103" href="#L103">103</a><span class="code-text">All the usual workspace options should work with Clippy. For example the following command</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L104" href="#L104">104</a><span class="code-text">will run Clippy on the `example` crate:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L105" href="#L105">105</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L106" href="#L106">106</a><span class="code-text">```terminal</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L107" href="#L107">107</a><span class="code-text">cargo clippy -p example</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L108" href="#L108">108</a><span class="code-text">```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L109" href="#L109">109</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L110" href="#L110">110</a><span class="code-text">As with `cargo check`, this includes dependencies that are members of the workspace, like path dependencies.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L111" href="#L111">111</a><span class="code-text">If you want to run Clippy **only** on the given crate, use the `--no-deps` option like this:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L112" href="#L112">112</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L113" href="#L113">113</a><span class="code-text">```terminal</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L114" href="#L114">114</a><span class="code-text">cargo clippy -p example -- --no-deps</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L115" href="#L115">115</a><span class="code-text">```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L116" href="#L116">116</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L117" href="#L117">117</a><span class="code-text">### Using `clippy-driver`</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L118" href="#L118">118</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L119" href="#L119">119</a><span class="code-text">Clippy can also be used in projects that do not use cargo. To do so, run `clippy-driver`</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L120" href="#L120">120</a><span class="code-text">with the same arguments you use for `rustc`. For example:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L121" href="#L121">121</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L122" href="#L122">122</a><span class="code-text">```terminal</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L123" href="#L123">123</a><span class="code-text">clippy-driver --edition 2018 -Cpanic=abort foo.rs</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L124" href="#L124">124</a><span class="code-text">```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L125" href="#L125">125</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L126" href="#L126">126</a><span class="code-text">Note that `clippy-driver` is designed for running Clippy only and should not be used as a general</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L127" href="#L127">127</a><span class="code-text">replacement for `rustc`. `clippy-driver` may produce artifacts that are not optimized as expected,</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L128" href="#L128">128</a><span class="code-text">for example.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L129" href="#L129">129</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L130" href="#L130">130</a><span class="code-text">### Travis CI</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L131" href="#L131">131</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L132" href="#L132">132</a><span class="code-text">You can add Clippy to Travis CI in the same way you use it locally:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L133" href="#L133">133</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L134" href="#L134">134</a><span class="code-text">```yaml</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L135" href="#L135">135</a><span class="code-text">language: rust</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L136" href="#L136">136</a><span class="code-text">rust:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L137" href="#L137">137</a><span class="code-text">  - stable</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L138" href="#L138">138</a><span class="code-text">  - beta</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L139" href="#L139">139</a><span class="code-text">before_script:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L140" href="#L140">140</a><span class="code-text">  - rustup component add clippy</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L141" href="#L141">141</a><span class="code-text">script:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L142" href="#L142">142</a><span class="code-text">  - cargo clippy</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L143" href="#L143">143</a><span class="code-text">  # if you want the build job to fail when encountering warnings, use</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L144" href="#L144">144</a><span class="code-text">  - cargo clippy -- -D warnings</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L145" href="#L145">145</a><span class="code-text">  # in order to also check tests and non-default crate features, use</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L146" href="#L146">146</a><span class="code-text">  - cargo clippy --all-targets --all-features -- -D warnings</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L147" href="#L147">147</a><span class="code-text">  - cargo test</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L148" href="#L148">148</a><span class="code-text">  # etc.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L149" href="#L149">149</a><span class="code-text">```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L150" href="#L150">150</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L151" href="#L151">151</a><span class="code-text">Note that adding `-D warnings` will cause your build to fail if **any** warnings are found in your code.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L152" href="#L152">152</a><span class="code-text">That includes warnings found by rustc (e.g. `dead_code`, etc.). If you want to avoid this and only cause</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L153" href="#L153">153</a><span class="code-text">an error for Clippy warnings, use `#![deny(clippy::all)]` in your code or `-D clippy::all` on the command</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L154" href="#L154">154</a><span class="code-text">line. (You can swap `clippy::all` with the specific lint category you are targeting.)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L155" href="#L155">155</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L156" href="#L156">156</a><span class="code-text">## Configuration</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L157" href="#L157">157</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L158" href="#L158">158</a><span class="code-text">### Allowing/denying lints</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L159" href="#L159">159</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L160" href="#L160">160</a><span class="code-text">You can add options to your code to `allow`/`warn`/`deny` Clippy lints:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L161" href="#L161">161</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L162" href="#L162">162</a><span class="code-text">* the whole set of `Warn` lints using the `clippy` lint group (`#![deny(clippy::all)]`).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L163" href="#L163">163</a><span class="code-text">    Note that `rustc` has additional [lint groups](https://doc.rust-lang.org/rustc/lints/groups.html).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L164" href="#L164">164</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L165" href="#L165">165</a><span class="code-text">* all lints using both the `clippy` and `clippy::pedantic` lint groups (`#![deny(clippy::all)]`,</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L166" href="#L166">166</a><span class="code-text">    `#![deny(clippy::pedantic)]`). Note that `clippy::pedantic` contains some very aggressive</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L167" href="#L167">167</a><span class="code-text">    lints prone to false positives.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L168" href="#L168">168</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L169" href="#L169">169</a><span class="code-text">* only some lints (`#![deny(clippy::single_match, clippy::box_vec)]`, etc.)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L170" href="#L170">170</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L171" href="#L171">171</a><span class="code-text">* `allow`/`warn`/`deny` can be limited to a single function or module using `#[allow(...)]`, etc.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L172" href="#L172">172</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L173" href="#L173">173</a><span class="code-text">Note: `allow` means to suppress the lint for your code. With `warn` the lint</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L174" href="#L174">174</a><span class="code-text">will only emit a warning, while with `deny` the lint will emit an error, when</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L175" href="#L175">175</a><span class="code-text">triggering for your code. An error causes clippy to exit with an error code, so</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L176" href="#L176">176</a><span class="code-text">is useful in scripts like CI/CD.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L177" href="#L177">177</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L178" href="#L178">178</a><span class="code-text">If you do not want to include your lint levels in your code, you can globally</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L179" href="#L179">179</a><span class="code-text">enable/disable lints by passing extra flags to Clippy during the run:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L180" href="#L180">180</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L181" href="#L181">181</a><span class="code-text">To allow `lint_name`, run</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L182" href="#L182">182</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L183" href="#L183">183</a><span class="code-text">```terminal</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L184" href="#L184">184</a><span class="code-text">cargo clippy -- -A clippy::lint_name</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L185" href="#L185">185</a><span class="code-text">```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L186" href="#L186">186</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L187" href="#L187">187</a><span class="code-text">And to warn on `lint_name`, run</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L188" href="#L188">188</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L189" href="#L189">189</a><span class="code-text">```terminal</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L190" href="#L190">190</a><span class="code-text">cargo clippy -- -W clippy::lint_name</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L191" href="#L191">191</a><span class="code-text">```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L192" href="#L192">192</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L193" href="#L193">193</a><span class="code-text">This also works with lint groups. For example, you</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L194" href="#L194">194</a><span class="code-text">can run Clippy with warnings for all lints enabled:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L195" href="#L195">195</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L196" href="#L196">196</a><span class="code-text">```terminal</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L197" href="#L197">197</a><span class="code-text">cargo clippy -- -W clippy::pedantic</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L198" href="#L198">198</a><span class="code-text">```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L199" href="#L199">199</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L200" href="#L200">200</a><span class="code-text">If you care only about a single lint, you can allow all others and then explicitly warn on</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L201" href="#L201">201</a><span class="code-text">the lint(s) you are interested in:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L202" href="#L202">202</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L203" href="#L203">203</a><span class="code-text">```terminal</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L204" href="#L204">204</a><span class="code-text">cargo clippy -- -A clippy::all -W clippy::useless_format -W clippy::...</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L205" href="#L205">205</a><span class="code-text">```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L206" href="#L206">206</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L207" href="#L207">207</a><span class="code-text">### Configure the behavior of some lints</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L208" href="#L208">208</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L209" href="#L209">209</a><span class="code-text">Some lints can be configured in a TOML file named `clippy.toml` or `.clippy.toml`. It contains a basic `variable =</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L210" href="#L210">210</a><span class="code-text">value` mapping e.g.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L211" href="#L211">211</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L212" href="#L212">212</a><span class="code-text">```toml</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L213" href="#L213">213</a><span class="code-text">avoid-breaking-exported-api = false</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L214" href="#L214">214</a><span class="code-text">disallowed-names = [&quot;toto&quot;, &quot;tata&quot;, &quot;titi&quot;]</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L215" href="#L215">215</a><span class="code-text">```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L216" href="#L216">216</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L217" href="#L217">217</a><span class="code-text">The [table of configurations](https://doc.rust-lang.org/nightly/clippy/lint_configuration.html)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L218" href="#L218">218</a><span class="code-text">contains all config values, their default, and a list of lints they affect.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L219" href="#L219">219</a><span class="code-text">Each [configurable lint](https://rust-lang.github.io/rust-clippy/master/index.html#Configuration)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L220" href="#L220">220</a><span class="code-text">, also contains information about these values.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L221" href="#L221">221</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L222" href="#L222">222</a><span class="code-text">For configurations that are a list type with default values such as</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L223" href="#L223">223</a><span class="code-text">[disallowed-names](https://rust-lang.github.io/rust-clippy/master/index.html#disallowed_names),</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L224" href="#L224">224</a><span class="code-text">you can use the unique value `&quot;..&quot;` to extend the default values instead of replacing them.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L225" href="#L225">225</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L226" href="#L226">226</a><span class="code-text">```toml</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L227" href="#L227">227</a><span class="code-text"># default of disallowed-names is [&quot;foo&quot;, &quot;baz&quot;, &quot;quux&quot;]</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L228" href="#L228">228</a><span class="code-text">disallowed-names = [&quot;bar&quot;, &quot;..&quot;] # -&gt; [&quot;bar&quot;, &quot;foo&quot;, &quot;baz&quot;, &quot;quux&quot;]</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L229" href="#L229">229</a><span class="code-text">```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L230" href="#L230">230</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L231" href="#L231">231</a><span class="code-text">&gt; **Note**</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L232" href="#L232">232</a><span class="code-text">&gt;</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L233" href="#L233">233</a><span class="code-text">&gt; `clippy.toml` or `.clippy.toml` cannot be used to allow/deny lints.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L234" href="#L234">234</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L235" href="#L235">235</a><span class="code-text">To deactivate the “for further information visit *lint-link*” message you can</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L236" href="#L236">236</a><span class="code-text">define the `CLIPPY_DISABLE_DOCS_LINKS` environment variable.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L237" href="#L237">237</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L238" href="#L238">238</a><span class="code-text">### Specifying the minimum supported Rust version</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L239" href="#L239">239</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L240" href="#L240">240</a><span class="code-text">Projects that intend to support old versions of Rust can disable lints pertaining to newer features by</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L241" href="#L241">241</a><span class="code-text">specifying the minimum supported Rust version (MSRV) in the clippy configuration file.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L242" href="#L242">242</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L243" href="#L243">243</a><span class="code-text">```toml</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L244" href="#L244">244</a><span class="code-text">msrv = &quot;1.30.0&quot;</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L245" href="#L245">245</a><span class="code-text">```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L246" href="#L246">246</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L247" href="#L247">247</a><span class="code-text">Alternatively, the [`rust-version` field](https://doc.rust-lang.org/cargo/reference/manifest.html#the-rust-version-field)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L248" href="#L248">248</a><span class="code-text">in the `Cargo.toml` can be used.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L249" href="#L249">249</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L250" href="#L250">250</a><span class="code-text">```toml</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L251" href="#L251">251</a><span class="code-text"># Cargo.toml</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L252" href="#L252">252</a><span class="code-text">rust-version = &quot;1.30&quot;</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L253" href="#L253">253</a><span class="code-text">```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L254" href="#L254">254</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L255" href="#L255">255</a><span class="code-text">The MSRV can also be specified as an attribute, like below.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L256" href="#L256">256</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L257" href="#L257">257</a><span class="code-text">```rust,ignore</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L258" href="#L258">258</a><span class="code-text">#![feature(custom_inner_attributes)]</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L259" href="#L259">259</a><span class="code-text">#![clippy::msrv = &quot;1.30.0&quot;]</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L260" href="#L260">260</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L261" href="#L261">261</a><span class="code-text">fn main() {</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L262" href="#L262">262</a><span class="code-text">  ...</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L263" href="#L263">263</a><span class="code-text">}</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L264" href="#L264">264</a><span class="code-text">```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L265" href="#L265">265</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L266" href="#L266">266</a><span class="code-text">You can also omit the patch version when specifying the MSRV, so `msrv = 1.30`</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L267" href="#L267">267</a><span class="code-text">is equivalent to `msrv = 1.30.0`.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L268" href="#L268">268</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L269" href="#L269">269</a><span class="code-text">Note: `custom_inner_attributes` is an unstable feature, so it has to be enabled explicitly.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L270" href="#L270">270</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L271" href="#L271">271</a><span class="code-text">Lints that recognize this configuration option can be found [here](https://rust-lang.github.io/rust-clippy/master/index.html#msrv)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L272" href="#L272">272</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L273" href="#L273">273</a><span class="code-text">## Contributing</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L274" href="#L274">274</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L275" href="#L275">275</a><span class="code-text">If you want to contribute to Clippy, you can find more information in [CONTRIBUTING.md](https://github.com/rust-lang/rust-clippy/blob/master/CONTRIBUTING.md).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L276" href="#L276">276</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L277" href="#L277">277</a><span class="code-text">## License</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L278" href="#L278">278</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L279" href="#L279">279</a><span class="code-text">&lt;!-- REUSE-IgnoreStart --&gt;</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L280" href="#L280">280</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L281" href="#L281">281</a><span class="code-text">Copyright 2014-2023 The Rust Project Developers</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L282" href="#L282">282</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L283" href="#L283">283</a><span class="code-text">Licensed under the Apache License, Version 2.0 &lt;LICENSE-APACHE or</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L284" href="#L284">284</a><span class="code-text">[https://www.apache.org/licenses/LICENSE-2.0](https://www.apache.org/licenses/LICENSE-2.0)&gt; or the MIT license</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L285" href="#L285">285</a><span class="code-text">&lt;LICENSE-MIT or [https://opensource.org/licenses/MIT](https://opensource.org/licenses/MIT)&gt;, at your</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L286" href="#L286">286</a><span class="code-text">option. Files in the project may not be</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L287" href="#L287">287</a><span class="code-text">copied, modified, or distributed except according to those terms.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L288" href="#L288">288</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L289" href="#L289">289</a><span class="code-text">&lt;!-- REUSE-IgnoreEnd --&gt;</span></span></pre></div></div>
</main>
</body>
</html>
