<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>CONTRIBUTING.md - fork/rust @ 1.41.1</title>
<meta name="description" content="CONTRIBUTING.md in fork/rust at 1.41.1.">
<meta property="og:title" content="CONTRIBUTING.md - fork/rust @ 1.41.1">
<meta property="og:description" content="CONTRIBUTING.md in fork/rust at 1.41.1.">
<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="1.41.1" data-tip="f3e1a954d2ead4e2fc197c7da7d71e6c61bad196">
<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="f3e1a954d2ead4e2fc197c7da7d71e6c61bad196">Auto merge of #69444 - pietroalbini:stable-next-final-v2-new, r=pietroalbini</span><span class="snapshot-sha sha" data-commit="f3e1a954d2ead4e2fc197c7da7d71e6c61bad196">f3e1a954d2e</span><time datetime="2020-02-24T22:43:10+00:00" title="2020-02-24 22:43:10 +0000">2020-02-24</time></p>
<header class="topbar"><details class="switcher"><summary>1.41.1</summary><div class="menu"><strong>branches</strong><a 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 class="current" 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> / <span class="cur">CONTRIBUTING.md</span></nav>
<span class="view-stats"><span>20.8 KiB</span><span>457 lines</span></span><span class="actions"><a class="raw" href="/fork/rust/raw/8fbbd7c4a2e49b0ac2e86dae076ce6e6248ad21e/CONTRIBUTING.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>Contributing to Rust</h1>
<p>Thank you for your interest in contributing to Rust! There are many ways to
contribute, and we appreciate all of them. This document is a bit long, so here's
links to the major sections:</p>
<ul>
<li><a href="#feature-requests">Feature Requests</a></li>
<li><a href="#bug-reports">Bug Reports</a></li>
<li><a href="#the-build-system">The Build System</a></li>
<li><a href="#pull-requests">Pull Requests</a></li>
<li><a href="#writing-documentation">Writing Documentation</a></li>
<li><a href="#issue-triage">Issue Triage</a></li>
<li><a href="#out-of-tree-contributions">Out-of-tree Contributions</a></li>
<li><a href="#helpful-links-and-information">Helpful Links and Information</a></li>
</ul>
<p>If you have questions, please make a post on <a href="https://internals.rust-lang.org">internals.rust-lang.org</a> or
hop on the <a href="http://discord.gg/rust-lang">Rust Discord server</a> or <a href="https://rust-lang.zulipchat.com">Rust Zulip server</a>.</p>
<p>As a reminder, all contributors are expected to follow our <a href="https://www.rust-lang.org/conduct.html">Code of Conduct</a>.</p>
<p>The <a href="https://rust-lang.github.io/rustc-guide/">rustc-guide</a> is your friend! It describes how the compiler works and how
to contribute to it in more detail than this document.</p>
<p>If this is your first time contributing, the <a href="https://rust-lang.github.io/rustc-guide/walkthrough.html">walkthrough</a> chapter of the guide
can give you a good example of how a typical contribution would go.</p>
<h2>Feature Requests</h2>
<p>To request a change to the way the Rust language works, please head over
to the <a href="https://github.com/rust-lang/rfcs">RFCs repository</a> and view the
<a href="https://github.com/rust-lang/rfcs/blob/master/README.md">README</a>
for instructions.</p>
<h2>Bug Reports</h2>
<p>While bugs are unfortunate, they're a reality in software. We can't fix what we
don't know about, so please report liberally. If you're not sure if something
is a bug or not, feel free to file a bug anyway.</p>
<p><strong>If you believe reporting your bug publicly represents a security risk to Rust users,
please follow our <a href="https://www.rust-lang.org/policies/security">instructions for reporting security vulnerabilities</a></strong>.</p>
<p>If you have the chance, before reporting a bug, please <a href="https://github.com/rust-lang/rust/search?q=&amp;type=Issues&amp;utf8=%E2%9C%93">search existing
issues</a>,
as it's possible that someone else has already reported your error. This doesn't
always work, and sometimes it's hard to know what to search for, so consider this
extra credit. We won't mind if you accidentally file a duplicate report.</p>
<p>Similarly, to help others who encountered the bug find your issue,
consider filing an issue with a descriptive title, which contains information that might be unique to it.
This can be the language or compiler feature used, the conditions that trigger the bug,
or part of the error message if there is any.
An example could be: <strong>"impossible case reached" on lifetime inference for impl Trait in return position</strong>.</p>
<p>Opening an issue is as easy as following <a href="https://github.com/rust-lang/rust/issues/new">this
link</a> and filling out the fields.
Here's a template that you can use to file a bug, though it's not necessary to
use it exactly:</p>
<pre><code>&lt;short summary of the bug&gt;

I tried this code:

&lt;code sample that causes the bug&gt;

I expected to see this happen: &lt;explanation&gt;

Instead, this happened: &lt;explanation&gt;

## Meta

`rustc --version --verbose`:

Backtrace:
</code></pre>
<p>All three components are important: what you did, what you expected, what
happened instead. Please include the output of <code>rustc --version --verbose</code>,
which includes important information about what platform you're on, what
version of Rust you're using, etc.</p>
<p>Sometimes, a backtrace is helpful, and so including that is nice. To get
a backtrace, set the <code>RUST_BACKTRACE</code> environment variable to a value
other than <code>0</code>. The easiest way
to do this is to invoke <code>rustc</code> like this:</p>
<pre class="language-bash"><a-o>$</a-o><a-f> </a-f><a-pr>RUST_BACKTRACE</a-pr><a-f>=1</a-f> rustc ...</pre>
<h2>The Build System</h2>
<p>For info on how to configure and build the compiler, please see <a href="https://rust-lang.github.io/rustc-guide/building/how-to-build-and-run.html">this
chapter</a> of the rustc-guide. This chapter contains info for
contributions to the compiler and the standard library. It also lists some
really useful commands to the build system (<code>./x.py</code>), which could save you a
lot of time.</p>
<h2>Pull Requests</h2>
<p>Pull requests are the primary mechanism we use to change Rust. GitHub itself
has some <a href="https://help.github.com/articles/about-pull-requests/">great documentation</a> on using the Pull Request feature.
We use the "fork and pull" model <a href="https://help.github.com/articles/about-collaborative-development-models/">described here</a>, where
contributors push changes to their personal fork and create pull requests to
bring those changes into the source repository.</p>
<p>Please make pull requests against the <code>master</code> branch.</p>
<p>Rust follows a no merge policy, meaning, when you encounter merge
conflicts you are expected to always rebase instead of merge.
E.g. always use rebase when bringing the latest changes from
the master branch to your feature branch.
Also, please make sure that fixup commits are squashed into other related
commits with meaningful commit messages.</p>
<p>GitHub allows <a href="https://help.github.com/en/articles/closing-issues-using-keywords">closing issues using keywords</a>. This feature
should be used to keep the issue tracker tidy. However, it is generally preferred
to put the "closes #123" text in the PR description rather than the issue commit;
particularly during rebasing, citing the issue number in the commit can "spam"
the issue in question.</p>
<p>Please make sure your pull request is in compliance with Rust's style
guidelines by running</p>
<pre><code>$ python x.py test src/tools/tidy
</code></pre>
<p>Make this check before every pull request (and every new commit in a pull
request); you can add <a href="https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks">git hooks</a>
before every push to make sure you never forget to make this check.</p>
<p>All pull requests are reviewed by another person. We have a bot,
<a href="https://github.com/rust-highfive">@rust-highfive</a>, that will automatically assign a random person to review your
request.</p>
<p>If you want to request that a specific person reviews your pull request,
you can add an <code>r?</code> to the pull request description. For example, <a href="https://github.com/steveklabnik">Steve</a> usually reviews
documentation changes. So if you were to make a documentation change, add</p>
<pre><code>r? @steveklabnik
</code></pre>
<p>to the end of the pull request description, and <a href="https://github.com/rust-highfive">@rust-highfive</a> will assign
<a href="https://github.com/steveklabnik">@steveklabnik</a> instead of a random person. This is entirely optional.</p>
<p>After someone has reviewed your pull request, they will leave an annotation
on the pull request with an <code>r+</code>. It will look something like this:</p>
<pre><code>@bors r+
</code></pre>
<p>This tells <a href="https://github.com/bors">@bors</a>, our lovable integration bot, that your pull request has
been approved. The PR then enters the <a href="https://buildbot2.rust-lang.org/homu/queue/rust">merge queue</a>, where <a href="https://github.com/bors">@bors</a>
will run all the tests on every platform we support. If it all works out,
<a href="https://github.com/bors">@bors</a> will merge your code into <code>master</code> and close the pull request.</p>
<p>Depending on the scale of the change, you may see a slightly different form of <code>r+</code>:</p>
<pre><code>@bors r+ rollup
</code></pre>
<p>The additional <code>rollup</code> tells <a href="https://github.com/bors">@bors</a> that this change is eligible for to be
"rolled up". Changes that are rolled up are tested and merged at the same time, to
speed the process up. Typically only small changes that are expected not to conflict
with one another are rolled up.</p>
<p>Speaking of tests, Rust has a comprehensive test suite. More information about
it can be found <a href="https://rust-lang.github.io/rustc-guide/tests/intro.html">here</a>.</p>
<h3>External Dependencies</h3>
<p>Currently building Rust will also build the following external projects:</p>
<ul>
<li><a href="https://github.com/rust-lang/rust-clippy">clippy</a></li>
<li><a href="https://github.com/rust-lang/miri">miri</a></li>
<li><a href="https://github.com/rust-lang/rustfmt">rustfmt</a></li>
<li><a href="https://github.com/rust-lang/rls/">rls</a></li>
</ul>
<p>We allow breakage of these tools in the nightly channel. Maintainers of these
projects will be notified of the breakages and should fix them as soon as
possible.</p>
<p>After the external is fixed, one could add the changes with</p>
<pre class="language-bash"><a-f>git</a-f> add path/to/submodule</pre>
<p>outside the submodule.</p>
<p>In order to prepare your tool-fixing PR, you can run the build locally by doing
<code>./x.py build src/tools/TOOL</code>. If you will be editing the sources
there, you may wish to set <code>submodules = false</code> in the <code>config.toml</code>
to prevent <code>x.py</code> from resetting to the original branch.</p>
<p>Breakage is not allowed in the beta and stable channels, and must be addressed
before the PR is merged.</p>
<h4>Breaking Tools Built With The Compiler</h4>
<p>Rust's build system builds a number of tools that make use of the
internals of the compiler. This includes
<a href="https://github.com/rust-lang/rust-clippy">Clippy</a>,
<a href="https://github.com/rust-lang/rls">RLS</a> and
<a href="https://github.com/rust-lang/rustfmt">rustfmt</a>. If these tools
break because of your changes, you may run into a sort of "chicken and egg"
problem. These tools rely on the latest compiler to be built so you can't update
them to reflect your changes to the compiler until those changes are merged into
the compiler. At the same time, you can't get your changes merged into the compiler
because the rust-lang/rust build won't pass until those tools build and pass their
tests.</p>
<p>That means that, in the default state, you can't update the compiler without first
fixing rustfmt, rls and the other tools that the compiler builds.</p>
<p>Luckily, a feature was <a href="https://github.com/rust-lang/rust/issues/45861">added to Rust's build</a>
to make all of this easy to handle. The idea is that we allow these tools to be "broken",
so that the rust-lang/rust build passes without trying to build them, then land the change
in the compiler, wait for a nightly, and go update the tools that you broke. Once you're done
and the tools are working again, you go back in the compiler and update the tools
so they can be distributed again.</p>
<p>This should avoid a bunch of synchronization dances and is also much easier on contributors as
there's no need to block on rls/rustfmt/other tools changes going upstream.</p>
<p>Here are those same steps in detail:</p>
<ol>
<li>(optional) First, if it doesn't exist already, create a <code>config.toml</code> by copying
<code>config.toml.example</code> in the root directory of the Rust repository.
Set <code>submodules = false</code> in the <code>[build]</code> section. This will prevent <code>x.py</code>
from resetting to the original branch after you make your changes. If you
need to <a href="#updating-submodules">update any submodules to their latest versions</a>,
see the section of this file about that for more information.</li>
<li>(optional) Run <code>./x.py test src/tools/rustfmt</code> (substituting the submodule
that broke for <code>rustfmt</code>). Fix any errors in the submodule (and possibly others).</li>
<li>(optional) Make commits for your changes and send them to upstream repositories as a PR.</li>
<li>(optional) Maintainers of these submodules will <strong>not</strong> merge the PR. The PR can't be
merged because CI will be broken. You'll want to write a message on the PR referencing
your change, and how the PR should be merged once your change makes it into a nightly.</li>
<li>Wait for your PR to merge.</li>
<li>Wait for a nightly</li>
<li>(optional) Help land your PR on the upstream repository now that your changes are in nightly.</li>
<li>(optional) Send a PR to rust-lang/rust updating the submodule.</li>
</ol>
<h4>Updating submodules</h4>
<p>These instructions are specific to updating <code>rustfmt</code>, however they may apply
to the other submodules as well. Please help by improving these instructions
if you find any discrepancies or special cases that need to be addressed.</p>
<p>To update the <code>rustfmt</code> submodule, start by running the appropriate
<a href="https://git-scm.com/book/en/v2/Git-Tools-Submodules"><code>git submodule</code> command</a>.
For example, to update to the latest commit on the remote master branch,
you may want to run:</p>
<pre>git submodule update --remote src/tools/rustfmt
</pre>
<p>If you run <code>./x.py build</code> now, and you are lucky, it may just work. If you see
an error message about patches that did not resolve to any crates, you will need
to complete a few more steps which are outlined with their rationale below.</p>
<p><em>(This error may change in the future to include more information.)</em></p>
<pre>error: failed to resolve patches for `https://github.com/rust-lang/rustfmt`

Caused by:
  patch for `rustfmt-nightly` in `https://github.com/rust-lang/rustfmt` did not resolve to any crates
failed to run: ~/rust/build/x86_64-unknown-linux-gnu/stage0/bin/cargo build --manifest-path ~/rust/src/bootstrap/Cargo.toml
</pre>
<p>If you haven't used the <code>[patch]</code>
section of <code>Cargo.toml</code> before, there is <a href="http://doc.crates.io/manifest.html#the-patch-section">some relevant documentation about it
in the cargo docs</a>. In
addition to that, you should read the
<a href="http://doc.crates.io/specifying-dependencies.html#overriding-dependencies">Overriding dependencies</a>
section of the documentation as well.</p>
<p>Specifically, the following <a href="http://doc.crates.io/specifying-dependencies.html#testing-a-bugfix">section in Overriding dependencies</a> reveals what the problem is:</p>
<blockquote>
<p>Next up we need to ensure that our lock file is updated to use this new version of uuid so our project uses the locally checked out copy instead of one from crates.io. The way [patch] works is that it'll load the dependency at ../path/to/uuid and then whenever crates.io is queried for versions of uuid it'll also return the local version.</p>
<p>This means that the version number of the local checkout is significant and will affect whether the patch is used. Our manifest declared uuid = "1.0" which means we'll only resolve to &gt;= 1.0.0, &lt; 2.0.0, and Cargo's greedy resolution algorithm also means that we'll resolve to the maximum version within that range. Typically this doesn't matter as the version of the git repository will already be greater or match the maximum version published on crates.io, but it's important to keep this in mind!</p>
</blockquote>
<p>This says that when we updated the submodule, the version number in our
<code>src/tools/rustfmt/Cargo.toml</code> changed. The new version is different from
the version in <code>Cargo.lock</code>, so the build can no longer continue.</p>
<p>To resolve this, we need to update <code>Cargo.lock</code>. Luckily, cargo provides a
command to do this easily.</p>
<pre>$ cargo update -p rustfmt-nightly
</pre>
<p>This should change the version listed in <code>Cargo.lock</code> to the new version you updated
the submodule to. Running <code>./x.py build</code> should work now.</p>
<h2>Writing Documentation</h2>
<p>Documentation improvements are very welcome. The source of <code>doc.rust-lang.org</code>
is located in <code>src/doc</code> in the tree, and standard API documentation is generated
from the source code itself. Documentation pull requests function in the same way
as other pull requests.</p>
<p>To find documentation-related issues, sort by the <a href="https://github.com/rust-lang/rust/issues?q=is%3Aopen%20is%3Aissue%20label%3AT-doc">T-doc label</a>.</p>
<p>You can find documentation style guidelines in <a href="https://github.com/rust-lang/rfcs/blob/master/text/1574-more-api-documentation-conventions.md#appendix-a-full-conventions-text">RFC 1574</a>.</p>
<p>In many cases, you don't need a full <code>./x.py doc</code>. You can use <code>rustdoc</code> directly
to check small fixes. For example, <code>rustdoc src/doc/reference.md</code> will render
reference to <code>doc/reference.html</code>. The CSS might be messed up, but you can
verify that the HTML is right.</p>
<p>Additionally, contributions to the <a href="https://rust-lang.github.io/rustc-guide/">rustc-guide</a> are always welcome. Contributions
can be made directly at <a href="https://github.com/rust-lang/rustc-guide">the
rust-lang/rustc-guide</a> repo. The issue
tracker in that repo is also a great way to find things that need doing. There
are issues for beginners and advanced compiler devs alike!</p>
<h2>Issue Triage</h2>
<p>Sometimes, an issue will stay open, even though the bug has been fixed. And
sometimes, the original bug may go stale because something has changed in the
meantime.</p>
<p>It can be helpful to go through older bug reports and make sure that they are
still valid. Load up an older issue, double check that it's still true, and
leave a comment letting us know if it is or is not. The <a href="https://github.com/rust-lang/rust/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-asc">least recently
updated sort</a> is good for finding issues like this.</p>
<p>Contributors with sufficient permissions on the Rust repo can help by adding
labels to triage issues:</p>
<ul>
<li>
<p>Yellow, <strong>A</strong>-prefixed labels state which <strong>area</strong> of the project an issue
relates to.</p>
</li>
<li>
<p>Magenta, <strong>B</strong>-prefixed labels identify bugs which are <strong>blockers</strong>.</p>
</li>
<li>
<p>Dark blue, <strong>beta-</strong> labels track changes which need to be backported into
the beta branches.</p>
</li>
<li>
<p>Light purple, <strong>C</strong>-prefixed labels represent the <strong>category</strong> of an issue.</p>
</li>
<li>
<p>Green, <strong>E</strong>-prefixed labels explain the level of <strong>experience</strong> necessary
to fix the issue.</p>
</li>
<li>
<p>The dark blue <strong>final-comment-period</strong> label marks bugs that are using the
RFC signoff functionality of <a href="https://github.com/anp/rfcbot-rs/">rfcbot</a> and are currently in the final
comment period.</p>
</li>
<li>
<p>Red, <strong>I</strong>-prefixed labels indicate the <strong>importance</strong> of the issue. The
<a href="https://github.com/rust-lang/rust/issues?q=is%3Aopen+is%3Aissue+label%3AI-nominated">I-nominated</a> label indicates that an issue has been nominated for
prioritizing at the next triage meeting.</p>
</li>
<li>
<p>The purple <strong>metabug</strong> label marks lists of bugs collected by other
categories.</p>
</li>
<li>
<p>Purple gray, <strong>O</strong>-prefixed labels are the <strong>operating system</strong> or platform
that this issue is specific to.</p>
</li>
<li>
<p>Orange, <strong>P</strong>-prefixed labels indicate a bug's <strong>priority</strong>. These labels
are only assigned during triage meetings, and replace the <a href="https://github.com/rust-lang/rust/issues?q=is%3Aopen+is%3Aissue+label%3AI-nominated">I-nominated</a>
label.</p>
</li>
<li>
<p>The gray <strong>proposed-final-comment-period</strong> label marks bugs that are using
the RFC signoff functionality of <a href="https://github.com/anp/rfcbot-rs/">rfcbot</a> and are currently awaiting
signoff of all team members in order to enter the final comment period.</p>
</li>
<li>
<p>Pink, <strong>regression</strong>-prefixed labels track regressions from stable to the
release channels.</p>
</li>
<li>
<p>The light orange <strong>relnotes</strong> label marks issues that should be documented in
the release notes of the next release.</p>
</li>
<li>
<p>Gray, <strong>S</strong>-prefixed labels are used for tracking the <strong>status</strong> of pull
requests.</p>
</li>
<li>
<p>Blue, <strong>T</strong>-prefixed bugs denote which <strong>team</strong> the issue belongs to.</p>
</li>
</ul>
<p>If you're looking for somewhere to start, check out the <a href="https://github.com/rust-lang/rust/issues?q=is%3Aopen+is%3Aissue+label%3AE-easy">E-easy</a> tag.</p>
<h2>Out-of-tree Contributions</h2>
<p>There are a number of other ways to contribute to Rust that don't deal with
this repository.</p>
<p>Answer questions in the <em>Get Help!</em> channels from the <a href="http://discord.gg/rust-lang">Rust Discord server</a>, on <a href="https://users.rust-lang.org/">users.rust-lang.org</a>,
or on <a href="http://stackoverflow.com/questions/tagged/rust">StackOverflow</a>.</p>
<p>Participate in the <a href="https://github.com/rust-lang/rfcs">RFC process</a>.</p>
<p>Find a <a href="https://github.com/rust-lang/rfcs/labels/A-community-library">requested community library</a>, build it, and publish
it to <a href="http://crates.io">Crates.io</a>. Easier said than done, but very, very
valuable!</p>
<h2>Helpful Links and Information</h2>
<p>For people new to Rust, and just starting to contribute, or even for
more seasoned developers, some useful places to look for information
are:</p>
<ul>
<li>The <a href="https://rust-lang.github.io/rustc-guide/about-this-guide.html">rustc guide</a> contains information about how various parts of the compiler work and how to contribute to the compiler</li>
<li><a href="https://forge.rust-lang.org/">Rust Forge</a> contains additional documentation, including write-ups of how to achieve common tasks</li>
<li>The <a href="http://internals.rust-lang.org">Rust Internals forum</a>, a place to ask questions and
discuss Rust's internals</li>
<li>The <a href="https://doc.rust-lang.org/nightly/nightly-rustc/rustc/">generated documentation for rust's compiler</a></li>
<li>The <a href="https://doc.rust-lang.org/book/README.html">rust reference</a>, even though it doesn't specifically talk about Rust's internals, it's a great resource nonetheless</li>
<li>Although out of date, <a href="http://tomlee.co/2014/04/a-more-detailed-tour-of-the-rust-compiler/">Tom Lee's great blog article</a> is very helpful</li>
<li><a href="http://www.rustaceans.org/">rustaceans.org</a> is helpful, but mostly dedicated to IRC</li>
<li>The <a href="https://rust-lang.github.io/rustc-guide/tests/intro.html">Rust Compiler Testing Docs</a></li>
<li>For <a href="https://github.com/bors">@bors</a>, <a href="https://buildbot2.rust-lang.org/homu/">this cheat sheet</a> is helpful
(though you'll need to replace <code>@homu</code> with <code>@bors</code> in any commands)</li>
<li><strong>Google!</strong> (<a href="https://www.google.com/search?q=site:doc.rust-lang.org+your+query+here">search only in Rust Documentation</a> to find types, traits, etc. quickly)</li>
<li>Don't be afraid to ask! The Rust community is friendly and helpful.</li>
</ul>
</section><div class="code-panel"><pre class="code src" data-hl="CONTRIBUTING.md"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"># Contributing to Rust</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text">[contributing-to-rust]: #contributing-to-rust</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text">Thank you for your interest in contributing to Rust! There are many ways to</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text">contribute, and we appreciate all of them. This document is a bit long, so here's</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text">links to the major sections:</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">* [Feature Requests](#feature-requests)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text">* [Bug Reports](#bug-reports)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text">* [The Build System](#the-build-system)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text">* [Pull Requests](#pull-requests)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text">* [Writing Documentation](#writing-documentation)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text">* [Issue Triage](#issue-triage)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text">* [Out-of-tree Contributions](#out-of-tree-contributions)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text">* [Helpful Links and Information](#helpful-links-and-information)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text">If you have questions, please make a post on [internals.rust-lang.org][internals] or</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text">hop on the [Rust Discord server][rust-discord] or [Rust Zulip server][rust-zulip].</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text">As a reminder, all contributors are expected to follow our [Code of Conduct][coc].</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text">The [rustc-guide] is your friend! It describes how the compiler works and how</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text">to contribute to it in more detail than this document.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text">If this is your first time contributing, the [walkthrough] chapter of the guide</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text">can give you a good example of how a typical contribution would go.</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">[internals]: https://internals.rust-lang.org</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text">[rust-discord]: http://discord.gg/rust-lang</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text">[rust-zulip]: https://rust-lang.zulipchat.com</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text">[coc]: https://www.rust-lang.org/conduct.html</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text">[rustc-guide]: https://rust-lang.github.io/rustc-guide/</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text">[walkthrough]: https://rust-lang.github.io/rustc-guide/walkthrough.html</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text">## Feature Requests</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text">[feature-requests]: #feature-requests</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text">To request a change to the way the Rust language works, please head over</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text">to the [RFCs repository](https://github.com/rust-lang/rfcs) and view the</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L40" href="#L40">40</a><span class="code-text">[README](https://github.com/rust-lang/rfcs/blob/master/README.md)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text">for instructions.</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">## Bug Reports</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L44" href="#L44">44</a><span class="code-text">[bug-reports]: #bug-reports</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L45" href="#L45">45</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L46" href="#L46">46</a><span class="code-text">While bugs are unfortunate, they're a reality in software. We can't fix what we</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text">don't know about, so please report liberally. If you're not sure if something</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L48" href="#L48">48</a><span class="code-text">is a bug or not, feel free to file a bug anyway.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L49" href="#L49">49</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L50" href="#L50">50</a><span class="code-text">**If you believe reporting your bug publicly represents a security risk to Rust users,</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L51" href="#L51">51</a><span class="code-text">please follow our [instructions for reporting security vulnerabilities](https://www.rust-lang.org/policies/security)**.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L52" href="#L52">52</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L53" href="#L53">53</a><span class="code-text">If you have the chance, before reporting a bug, please [search existing</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L54" href="#L54">54</a><span class="code-text">issues](https://github.com/rust-lang/rust/search?q=&amp;type=Issues&amp;utf8=%E2%9C%93),</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L55" href="#L55">55</a><span class="code-text">as it's possible that someone else has already reported your error. This doesn't</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L56" href="#L56">56</a><span class="code-text">always work, and sometimes it's hard to know what to search for, so consider this</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L57" href="#L57">57</a><span class="code-text">extra credit. We won't mind if you accidentally file a duplicate report.</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">Similarly, to help others who encountered the bug find your issue,</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L60" href="#L60">60</a><span class="code-text">consider filing an issue with a descriptive title, which contains information that might be unique to it.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L61" href="#L61">61</a><span class="code-text">This can be the language or compiler feature used, the conditions that trigger the bug,</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L62" href="#L62">62</a><span class="code-text">or part of the error message if there is any.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L63" href="#L63">63</a><span class="code-text">An example could be: **&quot;impossible case reached&quot; on lifetime inference for impl Trait in return position**.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L64" href="#L64">64</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L65" href="#L65">65</a><span class="code-text">Opening an issue is as easy as following [this</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L66" href="#L66">66</a><span class="code-text">link](https://github.com/rust-lang/rust/issues/new) and filling out the fields.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L67" href="#L67">67</a><span class="code-text">Here's a template that you can use to file a bug, though it's not necessary to</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L68" href="#L68">68</a><span class="code-text">use it exactly:</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">    &lt;short summary of the bug&gt;</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L71" href="#L71">71</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L72" href="#L72">72</a><span class="code-text">    I tried this code:</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">    &lt;code sample that causes the bug&gt;</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">    I expected to see this happen: &lt;explanation&gt;</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">    Instead, this happened: &lt;explanation&gt;</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L79" href="#L79">79</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L80" href="#L80">80</a><span class="code-text">    ## Meta</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">    `rustc --version --verbose`:</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">    Backtrace:</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">All three components are important: what you did, what you expected, what</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L87" href="#L87">87</a><span class="code-text">happened instead. Please include the output of `rustc --version --verbose`,</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L88" href="#L88">88</a><span class="code-text">which includes important information about what platform you're on, what</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L89" href="#L89">89</a><span class="code-text">version of Rust you're using, etc.</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">Sometimes, a backtrace is helpful, and so including that is nice. To get</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L92" href="#L92">92</a><span class="code-text">a backtrace, set the `RUST_BACKTRACE` environment variable to a value</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L93" href="#L93">93</a><span class="code-text">other than `0`. The easiest way</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L94" href="#L94">94</a><span class="code-text">to do this is to invoke `rustc` like this:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L95" href="#L95">95</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L96" href="#L96">96</a><span class="code-text">```bash</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L97" href="#L97">97</a><span class="code-text">$ RUST_BACKTRACE=1 rustc ...</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L98" href="#L98">98</a><span class="code-text">```</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">## The Build System</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L101" href="#L101">101</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L102" href="#L102">102</a><span class="code-text">For info on how to configure and build the compiler, please see [this</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L103" href="#L103">103</a><span class="code-text">chapter][rustcguidebuild] of the rustc-guide. This chapter contains info for</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L104" href="#L104">104</a><span class="code-text">contributions to the compiler and the standard library. It also lists some</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L105" href="#L105">105</a><span class="code-text">really useful commands to the build system (`./x.py`), which could save you a</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L106" href="#L106">106</a><span class="code-text">lot of time.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L107" href="#L107">107</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L108" href="#L108">108</a><span class="code-text">[rustcguidebuild]: https://rust-lang.github.io/rustc-guide/building/how-to-build-and-run.html</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">## Pull Requests</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L111" href="#L111">111</a><span class="code-text">[pull-requests]: #pull-requests</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">Pull requests are the primary mechanism we use to change Rust. GitHub itself</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L114" href="#L114">114</a><span class="code-text">has some [great documentation][about-pull-requests] on using the Pull Request feature.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L115" href="#L115">115</a><span class="code-text">We use the &quot;fork and pull&quot; model [described here][development-models], where</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L116" href="#L116">116</a><span class="code-text">contributors push changes to their personal fork and create pull requests to</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L117" href="#L117">117</a><span class="code-text">bring those changes into the source repository.</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">[about-pull-requests]: https://help.github.com/articles/about-pull-requests/</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L120" href="#L120">120</a><span class="code-text">[development-models]: https://help.github.com/articles/about-collaborative-development-models/</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">Please make pull requests against the `master` branch.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L123" href="#L123">123</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L124" href="#L124">124</a><span class="code-text">Rust follows a no merge policy, meaning, when you encounter merge</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L125" href="#L125">125</a><span class="code-text">conflicts you are expected to always rebase instead of merge.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L126" href="#L126">126</a><span class="code-text">E.g. always use rebase when bringing the latest changes from</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L127" href="#L127">127</a><span class="code-text">the master branch to your feature branch.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L128" href="#L128">128</a><span class="code-text">Also, please make sure that fixup commits are squashed into other related</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L129" href="#L129">129</a><span class="code-text">commits with meaningful commit messages.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L130" href="#L130">130</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L131" href="#L131">131</a><span class="code-text">GitHub allows [closing issues using keywords][closing-keywords]. This feature</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L132" href="#L132">132</a><span class="code-text">should be used to keep the issue tracker tidy. However, it is generally preferred</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L133" href="#L133">133</a><span class="code-text">to put the &quot;closes #123&quot; text in the PR description rather than the issue commit;</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L134" href="#L134">134</a><span class="code-text">particularly during rebasing, citing the issue number in the commit can &quot;spam&quot;</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L135" href="#L135">135</a><span class="code-text">the issue in question.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L136" href="#L136">136</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L137" href="#L137">137</a><span class="code-text">[closing-keywords]: https://help.github.com/en/articles/closing-issues-using-keywords</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L138" href="#L138">138</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L139" href="#L139">139</a><span class="code-text">Please make sure your pull request is in compliance with Rust's style</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L140" href="#L140">140</a><span class="code-text">guidelines by running</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L141" href="#L141">141</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L142" href="#L142">142</a><span class="code-text">    $ python x.py test src/tools/tidy</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L143" href="#L143">143</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L144" href="#L144">144</a><span class="code-text">Make this check before every pull request (and every new commit in a pull</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L145" href="#L145">145</a><span class="code-text">request); you can add [git hooks](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L146" href="#L146">146</a><span class="code-text">before every push to make sure you never forget to make this check.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L147" href="#L147">147</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L148" href="#L148">148</a><span class="code-text">All pull requests are reviewed by another person. We have a bot,</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L149" href="#L149">149</a><span class="code-text">[@rust-highfive][rust-highfive], that will automatically assign a random person to review your</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L150" href="#L150">150</a><span class="code-text">request.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L151" href="#L151">151</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L152" href="#L152">152</a><span class="code-text">If you want to request that a specific person reviews your pull request,</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L153" href="#L153">153</a><span class="code-text">you can add an `r?` to the pull request description. For example, [Steve][steveklabnik] usually reviews</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L154" href="#L154">154</a><span class="code-text">documentation changes. So if you were to make a documentation change, add</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">    r? @steveklabnik</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">to the end of the pull request description, and [@rust-highfive][rust-highfive] will assign</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L159" href="#L159">159</a><span class="code-text">[@steveklabnik][steveklabnik] instead of a random person. This is entirely optional.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L160" href="#L160">160</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L161" href="#L161">161</a><span class="code-text">After someone has reviewed your pull request, they will leave an annotation</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L162" href="#L162">162</a><span class="code-text">on the pull request with an `r+`. It will look something like this:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L163" href="#L163">163</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L164" href="#L164">164</a><span class="code-text">    @bors r+</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L165" href="#L165">165</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L166" href="#L166">166</a><span class="code-text">This tells [@bors][bors], our lovable integration bot, that your pull request has</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L167" href="#L167">167</a><span class="code-text">been approved. The PR then enters the [merge queue][merge-queue], where [@bors][bors]</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L168" href="#L168">168</a><span class="code-text">will run all the tests on every platform we support. If it all works out,</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L169" href="#L169">169</a><span class="code-text">[@bors][bors] will merge your code into `master` and close the pull request.</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">Depending on the scale of the change, you may see a slightly different form of `r+`:</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">    @bors r+ rollup</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L174" href="#L174">174</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L175" href="#L175">175</a><span class="code-text">The additional `rollup` tells [@bors][bors] that this change is eligible for to be</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L176" href="#L176">176</a><span class="code-text">&quot;rolled up&quot;. Changes that are rolled up are tested and merged at the same time, to</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L177" href="#L177">177</a><span class="code-text">speed the process up. Typically only small changes that are expected not to conflict</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L178" href="#L178">178</a><span class="code-text">with one another are rolled up.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L179" href="#L179">179</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L180" href="#L180">180</a><span class="code-text">[rust-highfive]: https://github.com/rust-highfive</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L181" href="#L181">181</a><span class="code-text">[steveklabnik]: https://github.com/steveklabnik</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L182" href="#L182">182</a><span class="code-text">[bors]: https://github.com/bors</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L183" href="#L183">183</a><span class="code-text">[merge-queue]: https://buildbot2.rust-lang.org/homu/queue/rust</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L184" href="#L184">184</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L185" href="#L185">185</a><span class="code-text">Speaking of tests, Rust has a comprehensive test suite. More information about</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L186" href="#L186">186</a><span class="code-text">it can be found [here][rctd].</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L187" href="#L187">187</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L188" href="#L188">188</a><span class="code-text">### External Dependencies</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L189" href="#L189">189</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L190" href="#L190">190</a><span class="code-text">Currently building Rust will also build the following external projects:</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">* [clippy](https://github.com/rust-lang/rust-clippy)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L193" href="#L193">193</a><span class="code-text">* [miri](https://github.com/rust-lang/miri)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L194" href="#L194">194</a><span class="code-text">* [rustfmt](https://github.com/rust-lang/rustfmt)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L195" href="#L195">195</a><span class="code-text">* [rls](https://github.com/rust-lang/rls/)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L196" href="#L196">196</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L197" href="#L197">197</a><span class="code-text">We allow breakage of these tools in the nightly channel. Maintainers of these</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L198" href="#L198">198</a><span class="code-text">projects will be notified of the breakages and should fix them as soon as</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L199" href="#L199">199</a><span class="code-text">possible.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L200" href="#L200">200</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L201" href="#L201">201</a><span class="code-text">After the external is fixed, one could add the changes with</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">```sh</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L204" href="#L204">204</a><span class="code-text">git add path/to/submodule</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">outside the submodule.</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">In order to prepare your tool-fixing PR, you can run the build locally by doing</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L210" href="#L210">210</a><span class="code-text">`./x.py build src/tools/TOOL`. If you will be editing the sources</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L211" href="#L211">211</a><span class="code-text">there, you may wish to set `submodules = false` in the `config.toml`</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L212" href="#L212">212</a><span class="code-text">to prevent `x.py` from resetting to the original branch.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L213" href="#L213">213</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L214" href="#L214">214</a><span class="code-text">Breakage is not allowed in the beta and stable channels, and must be addressed</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L215" href="#L215">215</a><span class="code-text">before the PR is merged.</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">#### Breaking Tools Built With The Compiler</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L218" href="#L218">218</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L219" href="#L219">219</a><span class="code-text">Rust's build system builds a number of tools that make use of the</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L220" href="#L220">220</a><span class="code-text">internals of the compiler. This includes</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L221" href="#L221">221</a><span class="code-text">[Clippy](https://github.com/rust-lang/rust-clippy),</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L222" href="#L222">222</a><span class="code-text">[RLS](https://github.com/rust-lang/rls) and</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L223" href="#L223">223</a><span class="code-text">[rustfmt](https://github.com/rust-lang/rustfmt). If these tools</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L224" href="#L224">224</a><span class="code-text">break because of your changes, you may run into a sort of &quot;chicken and egg&quot;</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L225" href="#L225">225</a><span class="code-text">problem. These tools rely on the latest compiler to be built so you can't update</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L226" href="#L226">226</a><span class="code-text">them to reflect your changes to the compiler until those changes are merged into</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L227" href="#L227">227</a><span class="code-text">the compiler. At the same time, you can't get your changes merged into the compiler</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L228" href="#L228">228</a><span class="code-text">because the rust-lang/rust build won't pass until those tools build and pass their</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L229" href="#L229">229</a><span class="code-text">tests.</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">That means that, in the default state, you can't update the compiler without first</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L232" href="#L232">232</a><span class="code-text">fixing rustfmt, rls and the other tools that the compiler builds.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L233" href="#L233">233</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L234" href="#L234">234</a><span class="code-text">Luckily, a feature was [added to Rust's build](https://github.com/rust-lang/rust/issues/45861)</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 make all of this easy to handle. The idea is that we allow these tools to be &quot;broken&quot;,</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L236" href="#L236">236</a><span class="code-text">so that the rust-lang/rust build passes without trying to build them, then land the change</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L237" href="#L237">237</a><span class="code-text">in the compiler, wait for a nightly, and go update the tools that you broke. Once you're done</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L238" href="#L238">238</a><span class="code-text">and the tools are working again, you go back in the compiler and update the tools</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L239" href="#L239">239</a><span class="code-text">so they can be distributed again.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L240" href="#L240">240</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L241" href="#L241">241</a><span class="code-text">This should avoid a bunch of synchronization dances and is also much easier on contributors as</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L242" href="#L242">242</a><span class="code-text">there's no need to block on rls/rustfmt/other tools changes going upstream.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L243" href="#L243">243</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L244" href="#L244">244</a><span class="code-text">Here are those same steps in detail:</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">1. (optional) First, if it doesn't exist already, create a `config.toml` by copying</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L247" href="#L247">247</a><span class="code-text">   `config.toml.example` in the root directory of the Rust repository.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L248" href="#L248">248</a><span class="code-text">   Set `submodules = false` in the `[build]` section. This will prevent `x.py`</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L249" href="#L249">249</a><span class="code-text">   from resetting to the original branch after you make your changes. If you</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L250" href="#L250">250</a><span class="code-text">   need to [update any submodules to their latest versions](#updating-submodules),</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L251" href="#L251">251</a><span class="code-text">   see the section of this file about that for more information.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L252" href="#L252">252</a><span class="code-text">2. (optional) Run `./x.py test src/tools/rustfmt` (substituting the submodule</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L253" href="#L253">253</a><span class="code-text">   that broke for `rustfmt`). Fix any errors in the submodule (and possibly others).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L254" href="#L254">254</a><span class="code-text">3. (optional) Make commits for your changes and send them to upstream repositories as a PR.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L255" href="#L255">255</a><span class="code-text">4. (optional) Maintainers of these submodules will **not** merge the PR. The PR can't be</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L256" href="#L256">256</a><span class="code-text">   merged because CI will be broken. You'll want to write a message on the PR referencing</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L257" href="#L257">257</a><span class="code-text">   your change, and how the PR should be merged once your change makes it into a nightly.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L258" href="#L258">258</a><span class="code-text">5. Wait for your PR to merge.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L259" href="#L259">259</a><span class="code-text">6. Wait for a nightly</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L260" href="#L260">260</a><span class="code-text">7. (optional) Help land your PR on the upstream repository now that your changes are in nightly.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L261" href="#L261">261</a><span class="code-text">8. (optional) Send a PR to rust-lang/rust updating the submodule.</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">#### Updating submodules</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">These instructions are specific to updating `rustfmt`, however they may apply</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L266" href="#L266">266</a><span class="code-text">to the other submodules as well. Please help by improving these instructions</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L267" href="#L267">267</a><span class="code-text">if you find any discrepancies or special cases that need to be addressed.</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">To update the `rustfmt` submodule, start by running the appropriate</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L270" href="#L270">270</a><span class="code-text">[`git submodule` command](https://git-scm.com/book/en/v2/Git-Tools-Submodules).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L271" href="#L271">271</a><span class="code-text">For example, to update to the latest commit on the remote master branch,</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L272" href="#L272">272</a><span class="code-text">you may want to run:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L273" href="#L273">273</a><span class="code-text">```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L274" href="#L274">274</a><span class="code-text">git submodule update --remote src/tools/rustfmt</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L275" href="#L275">275</a><span class="code-text">```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L276" href="#L276">276</a><span class="code-text">If you run `./x.py build` now, and you are lucky, it may just work. If you see</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L277" href="#L277">277</a><span class="code-text">an error message about patches that did not resolve to any crates, you will need</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L278" href="#L278">278</a><span class="code-text">to complete a few more steps which are outlined with their rationale below.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L279" href="#L279">279</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L280" href="#L280">280</a><span class="code-text">*(This error may change in the future to include more information.)*</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L281" href="#L281">281</a><span class="code-text">```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L282" href="#L282">282</a><span class="code-text">error: failed to resolve patches for `https://github.com/rust-lang/rustfmt`</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L283" href="#L283">283</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L284" href="#L284">284</a><span class="code-text">Caused by:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L285" href="#L285">285</a><span class="code-text">  patch for `rustfmt-nightly` in `https://github.com/rust-lang/rustfmt` did not resolve to any crates</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L286" href="#L286">286</a><span class="code-text">failed to run: ~/rust/build/x86_64-unknown-linux-gnu/stage0/bin/cargo build --manifest-path ~/rust/src/bootstrap/Cargo.toml</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L287" href="#L287">287</a><span class="code-text">```</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">If you haven't used the `[patch]`</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L290" href="#L290">290</a><span class="code-text">section of `Cargo.toml` before, there is [some relevant documentation about it</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L291" href="#L291">291</a><span class="code-text">in the cargo docs](http://doc.crates.io/manifest.html#the-patch-section). In</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L292" href="#L292">292</a><span class="code-text">addition to that, you should read the</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L293" href="#L293">293</a><span class="code-text">[Overriding dependencies](http://doc.crates.io/specifying-dependencies.html#overriding-dependencies)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L294" href="#L294">294</a><span class="code-text">section of the documentation as well.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L295" href="#L295">295</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L296" href="#L296">296</a><span class="code-text">Specifically, the following [section in Overriding dependencies](http://doc.crates.io/specifying-dependencies.html#testing-a-bugfix) reveals what the problem is:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L297" href="#L297">297</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L298" href="#L298">298</a><span class="code-text">&gt; Next up we need to ensure that our lock file is updated to use this new version of uuid so our project uses the locally checked out copy instead of one from crates.io. The way [patch] works is that it'll load the dependency at ../path/to/uuid and then whenever crates.io is queried for versions of uuid it'll also return the local version.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L299" href="#L299">299</a><span class="code-text">&gt;</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L300" href="#L300">300</a><span class="code-text">&gt; This means that the version number of the local checkout is significant and will affect whether the patch is used. Our manifest declared uuid = &quot;1.0&quot; which means we'll only resolve to &gt;= 1.0.0, &lt; 2.0.0, and Cargo's greedy resolution algorithm also means that we'll resolve to the maximum version within that range. Typically this doesn't matter as the version of the git repository will already be greater or match the maximum version published on crates.io, but it's important to keep this in mind!</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L301" href="#L301">301</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L302" href="#L302">302</a><span class="code-text">This says that when we updated the submodule, the version number in our</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L303" href="#L303">303</a><span class="code-text">`src/tools/rustfmt/Cargo.toml` changed. The new version is different from</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L304" href="#L304">304</a><span class="code-text">the version in `Cargo.lock`, so the build can no longer continue.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L305" href="#L305">305</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L306" href="#L306">306</a><span class="code-text">To resolve this, we need to update `Cargo.lock`. Luckily, cargo provides a</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L307" href="#L307">307</a><span class="code-text">command to do this easily.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L308" href="#L308">308</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L309" href="#L309">309</a><span class="code-text">```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L310" href="#L310">310</a><span class="code-text">$ cargo update -p rustfmt-nightly</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L311" href="#L311">311</a><span class="code-text">```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L312" href="#L312">312</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L313" href="#L313">313</a><span class="code-text">This should change the version listed in `Cargo.lock` to the new version you updated</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L314" href="#L314">314</a><span class="code-text">the submodule to. Running `./x.py build` should work now.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L315" href="#L315">315</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L316" href="#L316">316</a><span class="code-text">## Writing Documentation</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L317" href="#L317">317</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L318" href="#L318">318</a><span class="code-text">Documentation improvements are very welcome. The source of `doc.rust-lang.org`</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L319" href="#L319">319</a><span class="code-text">is located in `src/doc` in the tree, and standard API documentation is generated</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L320" href="#L320">320</a><span class="code-text">from the source code itself. Documentation pull requests function in the same way</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L321" href="#L321">321</a><span class="code-text">as other pull requests.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L322" href="#L322">322</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L323" href="#L323">323</a><span class="code-text">To find documentation-related issues, sort by the [T-doc label][tdoc].</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L324" href="#L324">324</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L325" href="#L325">325</a><span class="code-text">[tdoc]: https://github.com/rust-lang/rust/issues?q=is%3Aopen%20is%3Aissue%20label%3AT-doc</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L326" href="#L326">326</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L327" href="#L327">327</a><span class="code-text">You can find documentation style guidelines in [RFC 1574][rfc1574].</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L328" href="#L328">328</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L329" href="#L329">329</a><span class="code-text">[rfc1574]: https://github.com/rust-lang/rfcs/blob/master/text/1574-more-api-documentation-conventions.md#appendix-a-full-conventions-text</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L330" href="#L330">330</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L331" href="#L331">331</a><span class="code-text">In many cases, you don't need a full `./x.py doc`. You can use `rustdoc` directly</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L332" href="#L332">332</a><span class="code-text">to check small fixes. For example, `rustdoc src/doc/reference.md` will render</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L333" href="#L333">333</a><span class="code-text">reference to `doc/reference.html`. The CSS might be messed up, but you can</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L334" href="#L334">334</a><span class="code-text">verify that the HTML is right.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L335" href="#L335">335</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L336" href="#L336">336</a><span class="code-text">Additionally, contributions to the [rustc-guide] are always welcome. Contributions</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L337" href="#L337">337</a><span class="code-text">can be made directly at [the</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L338" href="#L338">338</a><span class="code-text">rust-lang/rustc-guide](https://github.com/rust-lang/rustc-guide) repo. The issue</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L339" href="#L339">339</a><span class="code-text">tracker in that repo is also a great way to find things that need doing. There</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L340" href="#L340">340</a><span class="code-text">are issues for beginners and advanced compiler devs alike!</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L341" href="#L341">341</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L342" href="#L342">342</a><span class="code-text">## Issue Triage</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L343" href="#L343">343</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L344" href="#L344">344</a><span class="code-text">Sometimes, an issue will stay open, even though the bug has been fixed. And</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L345" href="#L345">345</a><span class="code-text">sometimes, the original bug may go stale because something has changed in the</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L346" href="#L346">346</a><span class="code-text">meantime.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L347" href="#L347">347</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L348" href="#L348">348</a><span class="code-text">It can be helpful to go through older bug reports and make sure that they are</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L349" href="#L349">349</a><span class="code-text">still valid. Load up an older issue, double check that it's still true, and</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L350" href="#L350">350</a><span class="code-text">leave a comment letting us know if it is or is not. The [least recently</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L351" href="#L351">351</a><span class="code-text">updated sort][lru] is good for finding issues like this.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L352" href="#L352">352</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L353" href="#L353">353</a><span class="code-text">Contributors with sufficient permissions on the Rust repo can help by adding</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L354" href="#L354">354</a><span class="code-text">labels to triage issues:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L355" href="#L355">355</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L356" href="#L356">356</a><span class="code-text">* Yellow, **A**-prefixed labels state which **area** of the project an issue</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L357" href="#L357">357</a><span class="code-text">  relates to.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L358" href="#L358">358</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L359" href="#L359">359</a><span class="code-text">* Magenta, **B**-prefixed labels identify bugs which are **blockers**.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L360" href="#L360">360</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L361" href="#L361">361</a><span class="code-text">* Dark blue, **beta-** labels track changes which need to be backported into</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L362" href="#L362">362</a><span class="code-text">  the beta branches.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L363" href="#L363">363</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L364" href="#L364">364</a><span class="code-text">* Light purple, **C**-prefixed labels represent the **category** of an issue.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L365" href="#L365">365</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L366" href="#L366">366</a><span class="code-text">* Green, **E**-prefixed labels explain the level of **experience** necessary</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L367" href="#L367">367</a><span class="code-text">  to fix the issue.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L368" href="#L368">368</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L369" href="#L369">369</a><span class="code-text">* The dark blue **final-comment-period** label marks bugs that are using the</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L370" href="#L370">370</a><span class="code-text">  RFC signoff functionality of [rfcbot][rfcbot] and are currently in the final</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L371" href="#L371">371</a><span class="code-text">  comment period.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L372" href="#L372">372</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L373" href="#L373">373</a><span class="code-text">* Red, **I**-prefixed labels indicate the **importance** of the issue. The</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L374" href="#L374">374</a><span class="code-text">  [I-nominated][inom] label indicates that an issue has been nominated for</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L375" href="#L375">375</a><span class="code-text">  prioritizing at the next triage meeting.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L376" href="#L376">376</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L377" href="#L377">377</a><span class="code-text">* The purple **metabug** label marks lists of bugs collected by other</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L378" href="#L378">378</a><span class="code-text">  categories.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L379" href="#L379">379</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L380" href="#L380">380</a><span class="code-text">* Purple gray, **O**-prefixed labels are the **operating system** or platform</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L381" href="#L381">381</a><span class="code-text">  that this issue is specific to.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L382" href="#L382">382</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L383" href="#L383">383</a><span class="code-text">* Orange, **P**-prefixed labels indicate a bug's **priority**. These labels</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L384" href="#L384">384</a><span class="code-text">  are only assigned during triage meetings, and replace the [I-nominated][inom]</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L385" href="#L385">385</a><span class="code-text">  label.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L386" href="#L386">386</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L387" href="#L387">387</a><span class="code-text">* The gray **proposed-final-comment-period** label marks bugs that are using</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L388" href="#L388">388</a><span class="code-text">  the RFC signoff functionality of [rfcbot][rfcbot] and are currently awaiting</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L389" href="#L389">389</a><span class="code-text">  signoff of all team members in order to enter the final comment period.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L390" href="#L390">390</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L391" href="#L391">391</a><span class="code-text">* Pink, **regression**-prefixed labels track regressions from stable to the</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L392" href="#L392">392</a><span class="code-text">  release channels.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L393" href="#L393">393</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L394" href="#L394">394</a><span class="code-text">* The light orange **relnotes** label marks issues that should be documented in</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L395" href="#L395">395</a><span class="code-text">  the release notes of the next release.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L396" href="#L396">396</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L397" href="#L397">397</a><span class="code-text">* Gray, **S**-prefixed labels are used for tracking the **status** of pull</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L398" href="#L398">398</a><span class="code-text">  requests.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L399" href="#L399">399</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L400" href="#L400">400</a><span class="code-text">* Blue, **T**-prefixed bugs denote which **team** the issue belongs to.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L401" href="#L401">401</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L402" href="#L402">402</a><span class="code-text">If you're looking for somewhere to start, check out the [E-easy][eeasy] tag.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L403" href="#L403">403</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L404" href="#L404">404</a><span class="code-text">[inom]: https://github.com/rust-lang/rust/issues?q=is%3Aopen+is%3Aissue+label%3AI-nominated</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L405" href="#L405">405</a><span class="code-text">[eeasy]: https://github.com/rust-lang/rust/issues?q=is%3Aopen+is%3Aissue+label%3AE-easy</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L406" href="#L406">406</a><span class="code-text">[lru]: https://github.com/rust-lang/rust/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-asc</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L407" href="#L407">407</a><span class="code-text">[rfcbot]: https://github.com/anp/rfcbot-rs/</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L408" href="#L408">408</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L409" href="#L409">409</a><span class="code-text">## Out-of-tree Contributions</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L410" href="#L410">410</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L411" href="#L411">411</a><span class="code-text">There are a number of other ways to contribute to Rust that don't deal with</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L412" href="#L412">412</a><span class="code-text">this repository.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L413" href="#L413">413</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L414" href="#L414">414</a><span class="code-text">Answer questions in the _Get Help!_ channels from the [Rust Discord server][rust-discord], on [users.rust-lang.org][users],</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L415" href="#L415">415</a><span class="code-text">or on [StackOverflow][so].</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L416" href="#L416">416</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L417" href="#L417">417</a><span class="code-text">Participate in the [RFC process](https://github.com/rust-lang/rfcs).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L418" href="#L418">418</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L419" href="#L419">419</a><span class="code-text">Find a [requested community library][community-library], build it, and publish</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L420" href="#L420">420</a><span class="code-text">it to [Crates.io](http://crates.io). Easier said than done, but very, very</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L421" href="#L421">421</a><span class="code-text">valuable!</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L422" href="#L422">422</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L423" href="#L423">423</a><span class="code-text">[rust-discord]: https://discord.gg/rust-lang</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L424" href="#L424">424</a><span class="code-text">[users]: https://users.rust-lang.org/</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L425" href="#L425">425</a><span class="code-text">[so]: http://stackoverflow.com/questions/tagged/rust</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L426" href="#L426">426</a><span class="code-text">[community-library]: https://github.com/rust-lang/rfcs/labels/A-community-library</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L427" href="#L427">427</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L428" href="#L428">428</a><span class="code-text">## Helpful Links and Information</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L429" href="#L429">429</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L430" href="#L430">430</a><span class="code-text">For people new to Rust, and just starting to contribute, or even for</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L431" href="#L431">431</a><span class="code-text">more seasoned developers, some useful places to look for information</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L432" href="#L432">432</a><span class="code-text">are:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L433" href="#L433">433</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L434" href="#L434">434</a><span class="code-text">* The [rustc guide] contains information about how various parts of the compiler work and how to contribute to the compiler</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L435" href="#L435">435</a><span class="code-text">* [Rust Forge][rustforge] contains additional documentation, including write-ups of how to achieve common tasks</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L436" href="#L436">436</a><span class="code-text">* The [Rust Internals forum][rif], a place to ask questions and</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L437" href="#L437">437</a><span class="code-text">  discuss Rust's internals</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L438" href="#L438">438</a><span class="code-text">* The [generated documentation for rust's compiler][gdfrustc]</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L439" href="#L439">439</a><span class="code-text">* The [rust reference][rr], even though it doesn't specifically talk about Rust's internals, it's a great resource nonetheless</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L440" href="#L440">440</a><span class="code-text">* Although out of date, [Tom Lee's great blog article][tlgba] is very helpful</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L441" href="#L441">441</a><span class="code-text">* [rustaceans.org][ro] is helpful, but mostly dedicated to IRC</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L442" href="#L442">442</a><span class="code-text">* The [Rust Compiler Testing Docs][rctd]</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L443" href="#L443">443</a><span class="code-text">* For [@bors][bors], [this cheat sheet][cheatsheet] is helpful</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L444" href="#L444">444</a><span class="code-text">(though you'll need to replace `@homu` with `@bors` in any commands)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L445" href="#L445">445</a><span class="code-text">* **Google!** ([search only in Rust Documentation][gsearchdocs] to find types, traits, etc. quickly)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L446" href="#L446">446</a><span class="code-text">* Don't be afraid to ask! The Rust community is friendly and helpful.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L447" href="#L447">447</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L448" href="#L448">448</a><span class="code-text">[rustc guide]: https://rust-lang.github.io/rustc-guide/about-this-guide.html</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L449" href="#L449">449</a><span class="code-text">[gdfrustc]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc/</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L450" href="#L450">450</a><span class="code-text">[gsearchdocs]: https://www.google.com/search?q=site:doc.rust-lang.org+your+query+here</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L451" href="#L451">451</a><span class="code-text">[rif]: http://internals.rust-lang.org</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L452" href="#L452">452</a><span class="code-text">[rr]: https://doc.rust-lang.org/book/README.html</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L453" href="#L453">453</a><span class="code-text">[rustforge]: https://forge.rust-lang.org/</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L454" href="#L454">454</a><span class="code-text">[tlgba]: http://tomlee.co/2014/04/a-more-detailed-tour-of-the-rust-compiler/</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L455" href="#L455">455</a><span class="code-text">[ro]: http://www.rustaceans.org/</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L456" href="#L456">456</a><span class="code-text">[rctd]: https://rust-lang.github.io/rustc-guide/tests/intro.html</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L457" href="#L457">457</a><span class="code-text">[cheatsheet]: https://buildbot2.rust-lang.org/homu/</span></span></pre></div></div>
</main>
</body>
</html>
