<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>README.md - fork/rust @ master</title>
<meta name="description" content="README.md in fork/rust at master.">
<meta property="og:title" content="README.md - fork/rust @ master">
<meta property="og:description" content="README.md in fork/rust at master.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="master" data-tip="3bcad65fbf67b6edf87c949531fbc13435882e6b">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/rust</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/rust</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">bors</span><span class="commit-message" data-commit="3bcad65fbf67b6edf87c949531fbc13435882e6b">Auto merge of #103046 - JanBeh:PR_clarify_cmp_terminology, r=workingjubilee</span><span class="snapshot-sha sha" data-commit="3bcad65fbf67b6edf87c949531fbc13435882e6b">3bcad65fbf6</span><time datetime="2023-10-05T15:24:54+00:00" title="2023-10-05 15:24:54 +0000">2023-10-05</time></p>
<header class="topbar"><details class="switcher"><summary>master</summary><div class="menu"><strong>branches</strong><a class="current" href="/fork/rust/ref/master/">master</a><strong>tags</strong><a href="/fork/rust/ref/1.39.0/">1.39.0</a><a href="/fork/rust/ref/1.40.0/">1.40.0</a><a href="/fork/rust/ref/1.41.0/">1.41.0</a><a href="/fork/rust/ref/1.41.1/">1.41.1</a><a href="/fork/rust/ref/1.42.0/">1.42.0</a><a href="/fork/rust/ref/1.43.0/">1.43.0</a><a href="/fork/rust/ref/1.43.1/">1.43.1</a><a href="/fork/rust/ref/1.44.0/">1.44.0</a><a class="all" href="/fork/rust/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/rust/">rust</a> / <span class="cur">README.md</span></nav>
<span class="view-stats"><span>10.1 KiB</span><span>301 lines</span></span><span class="actions"><a class="raw" href="/fork/rust/raw/8a6c559b0b3120dfb2d81423f0f8ff6d2af33315/README.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered"><h1>The Rust Programming Language</h1>
<p><a href="https://www.rust-lang.org/community"><img src="https://img.shields.io/badge/Rust_Community%20-Join_us-brightgreen?style=plastic&amp;logo=rust" alt="Rust Community" /></a></p>
<p>This is the main source code repository for <a href="https://www.rust-lang.org/">Rust</a>. It contains the compiler,
standard library, and documentation.</p>
<p><strong>Note: this README is for <em>users</em> rather than <em>contributors</em>.</strong>
If you wish to <em>contribute</em> to the compiler, you should read
<a href="/fork/rust/ref/master/blob/CONTRIBUTING.md">CONTRIBUTING.md</a> instead.</p>
<h2>Quick Start</h2>
<p>Read <a href="https://doc.rust-lang.org/book/ch01-01-installation.html">"Installation"</a> from <a href="https://doc.rust-lang.org/book/index.html">The Book</a>.</p>
<h2>Installing from Source</h2>
<p>The Rust build system uses a Python script called <code>x.py</code> to build the compiler,
which manages the bootstrapping process. It lives at the root of the project.
It also uses a file named <code>config.toml</code> to determine various configuration
settings for the build. You can see a full list of options in
<code>config.example.toml</code>.</p>
<p>The <code>x.py</code> command can be run directly on most Unix systems in the following
format:</p>
<pre class="language-bash"><a-f>./x.py</a-f> <a-o>&lt;</a-o>subcommand<a-o>&gt;</a-o> [flags]</pre>
<p>This is how the documentation and examples assume you are running <code>x.py</code>.
See the <a href="https://rustc-dev-guide.rust-lang.org/building/how-to-build-and-run.html#what-is-xpy">rustc dev guide</a> if this does not work on your
platform.</p>
<p>More information about <code>x.py</code> can be found by running it with the <code>--help</code> flag
or reading the <a href="https://rustc-dev-guide.rust-lang.org/building/how-to-build-and-run.html#what-is-xpy">rustc dev guide</a>.</p>
<h3>Dependencies</h3>
<p>Make sure you have installed the dependencies:</p>
<ul>
<li><code>python</code> 3 or 2.7</li>
<li><code>git</code></li>
<li>A C compiler (when building for the host, <code>cc</code> is enough; cross-compiling may
need additional compilers)</li>
<li><code>curl</code> (not needed on Windows)</li>
<li><code>pkg-config</code> if you are compiling on Linux and targeting Linux</li>
<li><code>libiconv</code> (already included with glibc on Debian-based distros)</li>
</ul>
<p>To build Cargo, you'll also need OpenSSL (<code>libssl-dev</code> or <code>openssl-devel</code> on
most Unix distros).</p>
<p>If building LLVM from source, you'll need additional tools:</p>
<ul>
<li><code>g++</code>, <code>clang++</code>, or MSVC with versions listed on
<a href="https://llvm.org/docs/GettingStarted.html#host-c-toolchain-both-compiler-and-standard-library">LLVM's documentation</a></li>
<li><code>ninja</code>, or GNU <code>make</code> 3.81 or later (Ninja is recommended, especially on
Windows)</li>
<li><code>cmake</code> 3.13.4 or later</li>
<li><code>libstdc++-static</code> may be required on some Linux distributions such as Fedora
and Ubuntu</li>
</ul>
<p>On tier 1 or tier 2 with host tools platforms, you can also choose to download
LLVM by setting <code>llvm.download-ci-llvm = true</code>.
Otherwise, you'll need LLVM installed and <code>llvm-config</code> in your path.
See <a href="https://rustc-dev-guide.rust-lang.org/building/new-target.html#using-pre-built-llvm">the rustc-dev-guide for more info</a>.</p>
<h3>Building on a Unix-like system</h3>
<h4>Build steps</h4>
<ol>
<li>
<p>Clone the <a href="https://github.com/rust-lang/rust">source</a> with <code>git</code>:</p>
<pre class="language-bash"><a-f>git</a-f> clone https://github.com/rust-lang/rust.git
<a-f>cd</a-f> rust</pre>
</li>
</ol>
<ol start="2">
<li>
<p>Configure the build settings:</p>
<pre class="language-bash"><a-f>./configure</a-f></pre>
<p>If you plan to use <code>x.py install</code> to create an installation, it is
recommended that you set the <code>prefix</code> value in the <code>[install]</code> section to a
directory: <code>./configure --set install.prefix=&lt;path&gt;</code></p>
</li>
<li>
<p>Build and install:</p>
<pre class="language-bash"><a-f>./x.py</a-f> build <a-o>&amp;&amp;</a-o> <a-f>./x.py</a-f> install</pre>
<p>When complete, <code>./x.py install</code> will place several programs into
<code>$PREFIX/bin</code>: <code>rustc</code>, the Rust compiler, and <code>rustdoc</code>, the
API-documentation tool. By default, it will also include <a href="https://github.com/rust-lang/cargo">Cargo</a>, Rust's
package manager. You can disable this behavior by passing
<code>--set build.extended=false</code> to <code>./configure</code>.</p>
</li>
</ol>
<h4>Configure and Make</h4>
<p>This project provides a configure script and makefile (the latter of which just
invokes <code>x.py</code>). <code>./configure</code> is the recommended way to programatically
generate a <code>config.toml</code>. <code>make</code> is not recommended (we suggest using <code>x.py</code>
directly), but it is supported and we try not to break it unnecessarily.</p>
<pre class="language-bash"><a-f>./configure</a-f>
<a-f>make</a-f> <a-o>&amp;&amp;</a-o> <a-f>sudo</a-f> make install</pre>
<p><code>configure</code> generates a <code>config.toml</code> which can also be used with normal <code>x.py</code>
invocations.</p>
<h3>Building on Windows</h3>
<p>On Windows, we suggest using <a href="https://github.com/microsoft/winget-cli">winget</a> to install dependencies by running the
following in a terminal:</p>
<pre class="language-powershell"><a-f>winget</a-f> install -e Python.Python.3
<a-f>winget</a-f> install -e Kitware.CMake
<a-f>winget</a-f> install -e Git.Git</pre>
<p>Then edit your system's <code>PATH</code> variable and add: <code>C:\Program Files\CMake\bin</code>.
See
<a href="https://www.java.com/en/download/help/path.html">this guide on editing the system <code>PATH</code></a>
from the Java documentation.</p>
<p>There are two prominent ABIs in use on Windows: the native (MSVC) ABI used by
Visual Studio and the GNU ABI used by the GCC toolchain. Which version of Rust
you need depends largely on what C/C++ libraries you want to interoperate with.
Use the MSVC build of Rust to interop with software produced by Visual Studio
and the GNU build to interop with GNU software built using the MinGW/MSYS2
toolchain.</p>
<h4>MinGW</h4>
<p><a href="https://www.msys2.org/">MSYS2</a> can be used to easily build Rust on Windows:</p>
<ol>
<li>
<p>Download the latest <a href="https://www.msys2.org/">MSYS2 installer</a> and go through the installer.</p>
</li>
<li>
<p>Run <code>mingw32_shell.bat</code> or <code>mingw64_shell.bat</code> from the MSYS2 installation
directory (e.g. <code>C:\msys64</code>), depending on whether you want 32-bit or 64-bit
Rust. (As of the latest version of MSYS2 you have to run <code>msys2_shell.cmd -mingw32</code> or <code>msys2_shell.cmd -mingw64</code> from the command line instead.)</p>
</li>
<li>
<p>From this terminal, install the required tools:</p>
<pre class="language-bash"><a-c># Update package mirrors (may be needed if you have a fresh install of MSYS2)</a-c>
<a-f>pacman</a-f> <a-co>-Sy</a-co> pacman-mirrors

<a-c># Install build tools needed for Rust. If you&#39;re building a 32-bit compiler,</a-c>
<a-c># then replace &quot;x86_64&quot; below with &quot;i686&quot;. If you&#39;ve already got Git, Python,</a-c>
<a-c># or CMake installed and in PATH you can remove them from this list.</a-c>
<a-c># Note that it is important that you do **not** use the &#39;python2&#39;, &#39;cmake&#39;,</a-c>
<a-c># and &#39;ninja&#39; packages from the &#39;msys2&#39; subsystem.</a-c>
<a-c># The build has historically been known to fail with these packages.</a-c>
<a-f>pacman</a-f> <a-co>-S</a-co> git \
            make \
            diffutils \
            tar \
            mingw-w64-x86_64-python \
            mingw-w64-x86_64-cmake \
            mingw-w64-x86_64-gcc \
            mingw-w64-x86_64-ninja</pre>
</li>
<li>
<p>Navigate to Rust's source code (or clone it), then build it:</p>
<pre class="language-bash"><a-f>python</a-f> x.py setup user <a-o>&amp;&amp;</a-o> <a-f>python</a-f> x.py build <a-o>&amp;&amp;</a-o> <a-f>python</a-f> x.py install</pre>
</li>
</ol>
<h4>MSVC</h4>
<p>MSVC builds of Rust additionally require an installation of Visual Studio 2017
(or later) so <code>rustc</code> can use its linker. The simplest way is to get
<a href="https://visualstudio.microsoft.com/downloads/">Visual Studio</a>, check the "C++ build tools" and "Windows 10 SDK" workload.</p>
<p>(If you're installing CMake yourself, be careful that "C++ CMake tools for
Windows" doesn't get included under "Individual components".)</p>
<p>With these dependencies installed, you can build the compiler in a <code>cmd.exe</code>
shell with:</p>
<pre class="language-bash"><a-f>python</a-f> x.py setup user
<a-f>python</a-f> x.py build</pre>
<p>Right now, building Rust only works with some known versions of Visual Studio.
If you have a more recent version installed and the build system doesn't
understand, you may need to force rustbuild to use an older version.
This can be done by manually calling the appropriate vcvars file before running
the bootstrap.</p>
<pre class="language-batch"><a-v>CALL</a-v> &quot;<a-v>C</a-v><a-f>:\Program</a-f> <a-v>Files</a-v> (<a-v>x86</a-v>)\<a-v>Microsoft</a-v> <a-v>Visual</a-v> <a-v>Studio</a-v>\<a-n>2019</a-n>\<a-v>Community</a-v>\<a-v>VC</a-v>\<a-v>Auxiliary</a-v>\<a-v>Build</a-v>\<a-v>vcvars64</a-v>.<a-v>bat</a-v>&quot;
<a-v>python</a-v> <a-v>x</a-v>.<a-v>py</a-v> <a-v>build</a-v></pre>
<h4>Specifying an ABI</h4>
<p>Each specific ABI can also be used from either environment (for example, using
the GNU ABI in PowerShell) by using an explicit build triple. The available
Windows build triples are:</p>
<ul>
<li>GNU ABI (using GCC)
<ul>
<li><code>i686-pc-windows-gnu</code></li>
<li><code>x86_64-pc-windows-gnu</code></li>
</ul>
</li>
<li>The MSVC ABI
<ul>
<li><code>i686-pc-windows-msvc</code></li>
<li><code>x86_64-pc-windows-msvc</code></li>
</ul>
</li>
</ul>
<p>The build triple can be specified by either specifying <code>--build=&lt;triple&gt;</code> when
invoking <code>x.py</code> commands, or by creating a <code>config.toml</code> file (as described in
<a href="#building-on-a-unix-like-system">Building on a Unix-like system</a>), and passing
<code>--set build.build=&lt;triple&gt;</code> to <code>./configure</code>.</p>
<h2>Building Documentation</h2>
<p>If you'd like to build the documentation, it's almost the same:</p>
<pre class="language-bash"><a-f>./x.py</a-f> doc</pre>
<p>The generated documentation will appear under <code>doc</code> in the <code>build</code> directory for
the ABI used. That is, if the ABI was <code>x86_64-pc-windows-msvc</code>, the directory
will be <code>build\x86_64-pc-windows-msvc\doc</code>.</p>
<h2>Notes</h2>
<p>Since the Rust compiler is written in Rust, it must be built by a precompiled
"snapshot" version of itself (made in an earlier stage of development).
As such, source builds require an Internet connection to fetch snapshots, and an
OS that can execute the available snapshot binaries.</p>
<p>See https://doc.rust-lang.org/nightly/rustc/platform-support.html for a list of
supported platforms.
Only "host tools" platforms have a pre-compiled snapshot binary available; to
compile for a platform without host tools you must cross-compile.</p>
<p>You may find that other platforms work, but these are our officially supported
build environments that are most likely to work.</p>
<h2>Getting Help</h2>
<p>See https://www.rust-lang.org/community for a list of chat platforms and forums.</p>
<h2>Contributing</h2>
<p>See <a href="/fork/rust/ref/master/blob/CONTRIBUTING.md">CONTRIBUTING.md</a>.</p>
<h2>License</h2>
<p>Rust is primarily distributed under the terms of both the MIT license and the
Apache License (Version 2.0), with portions covered by various BSD-like
licenses.</p>
<p>See <a href="/fork/rust/ref/master/blob/LICENSE-APACHE">LICENSE-APACHE</a>, <a href="/fork/rust/ref/master/blob/LICENSE-MIT">LICENSE-MIT</a>, and
<a href="/fork/rust/ref/master/blob/COPYRIGHT">COPYRIGHT</a> for details.</p>
<h2>Trademark</h2>
<p><a href="https://foundation.rust-lang.org/">The Rust Foundation</a> owns and protects the Rust and Cargo
trademarks and logos (the "Rust Trademarks").</p>
<p>If you want to use these names or brands, please read the
<a href="https://foundation.rust-lang.org/policies/logo-policy-and-media-guide/">media guide</a>.</p>
<p>Third-party logos may be subject to third-party copyrights and trademarks. See
<a href="https://www.rust-lang.org/policies/licenses">Licenses</a> for details.</p>
</section><div class="code-panel"><pre class="code src" data-hl="README.md"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"># The Rust Programming Language</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text">[![Rust Community](https://img.shields.io/badge/Rust_Community%20-Join_us-brightgreen?style=plastic&amp;logo=rust)](https://www.rust-lang.org/community)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text">This is the main source code repository for [Rust]. It contains the compiler,</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text">standard library, and documentation.</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">[Rust]: https://www.rust-lang.org/</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text">**Note: this README is for _users_ rather than _contributors_.**</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text">If you wish to _contribute_ to the compiler, you should read</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text">[CONTRIBUTING.md](CONTRIBUTING.md) instead.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text">## Quick Start</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text">Read [&quot;Installation&quot;] from [The Book].</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text">[&quot;Installation&quot;]: https://doc.rust-lang.org/book/ch01-01-installation.html</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text">[The Book]: https://doc.rust-lang.org/book/index.html</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text">## Installing from Source</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text">The Rust build system uses a Python script called `x.py` to build the compiler,</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text">which manages the bootstrapping process. It lives at the root of the project.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text">It also uses a file named `config.toml` to determine various configuration</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text">settings for the build. You can see a full list of options in</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text">`config.example.toml`.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text">The `x.py` command can be run directly on most Unix systems in the following</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text">format:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text">```sh</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text">./x.py &lt;subcommand&gt; [flags]</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"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text">This is how the documentation and examples assume you are running `x.py`.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text">See the [rustc dev guide][rustcguidebuild] if this does not work on your</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text">platform.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L40" href="#L40">40</a><span class="code-text">More information about `x.py` can be found by running it with the `--help` flag</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text">or reading the [rustc dev guide][rustcguidebuild].</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">[gettingstarted]: https://rustc-dev-guide.rust-lang.org/getting-started.html</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L44" href="#L44">44</a><span class="code-text">[rustcguidebuild]: https://rustc-dev-guide.rust-lang.org/building/how-to-build-and-run.html#what-is-xpy</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">### Dependencies</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L48" href="#L48">48</a><span class="code-text">Make sure you have installed the dependencies:</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">* `python` 3 or 2.7</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L51" href="#L51">51</a><span class="code-text">* `git`</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L52" href="#L52">52</a><span class="code-text">* A C compiler (when building for the host, `cc` is enough; cross-compiling may</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L53" href="#L53">53</a><span class="code-text">  need additional compilers)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L54" href="#L54">54</a><span class="code-text">* `curl` (not needed on Windows)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L55" href="#L55">55</a><span class="code-text">* `pkg-config` if you are compiling on Linux and targeting Linux</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L56" href="#L56">56</a><span class="code-text">* `libiconv` (already included with glibc on Debian-based distros)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L57" href="#L57">57</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L58" href="#L58">58</a><span class="code-text">To build Cargo, you'll also need OpenSSL (`libssl-dev` or `openssl-devel` on</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L59" href="#L59">59</a><span class="code-text">most Unix distros).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L60" href="#L60">60</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L61" href="#L61">61</a><span class="code-text">If building LLVM from source, you'll need additional tools:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L62" href="#L62">62</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L63" href="#L63">63</a><span class="code-text">* `g++`, `clang++`, or MSVC with versions listed on</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L64" href="#L64">64</a><span class="code-text">  [LLVM's documentation](https://llvm.org/docs/GettingStarted.html#host-c-toolchain-both-compiler-and-standard-library)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L65" href="#L65">65</a><span class="code-text">* `ninja`, or GNU `make` 3.81 or later (Ninja is recommended, especially on</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L66" href="#L66">66</a><span class="code-text">  Windows)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L67" href="#L67">67</a><span class="code-text">* `cmake` 3.13.4 or later</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L68" href="#L68">68</a><span class="code-text">* `libstdc++-static` may be required on some Linux distributions such as Fedora</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L69" href="#L69">69</a><span class="code-text">  and Ubuntu</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L70" href="#L70">70</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L71" href="#L71">71</a><span class="code-text">On tier 1 or tier 2 with host tools platforms, you can also choose to download</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L72" href="#L72">72</a><span class="code-text">LLVM by setting `llvm.download-ci-llvm = true`.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L73" href="#L73">73</a><span class="code-text">Otherwise, you'll need LLVM installed and `llvm-config` in your path.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L74" href="#L74">74</a><span class="code-text">See [the rustc-dev-guide for more info][sysllvm].</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">[sysllvm]: https://rustc-dev-guide.rust-lang.org/building/new-target.html#using-pre-built-llvm</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"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L79" href="#L79">79</a><span class="code-text">### Building on a Unix-like system</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L80" href="#L80">80</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L81" href="#L81">81</a><span class="code-text">#### Build steps</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L82" href="#L82">82</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L83" href="#L83">83</a><span class="code-text">1. Clone the [source] with `git`:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L84" href="#L84">84</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L85" href="#L85">85</a><span class="code-text">   ```sh</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L86" href="#L86">86</a><span class="code-text">   git clone https://github.com/rust-lang/rust.git</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L87" href="#L87">87</a><span class="code-text">   cd rust</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L88" href="#L88">88</a><span class="code-text">   ```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L89" href="#L89">89</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L90" href="#L90">90</a><span class="code-text">[source]: https://github.com/rust-lang/rust</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L91" href="#L91">91</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L92" href="#L92">92</a><span class="code-text">2. Configure the build settings:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L93" href="#L93">93</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L94" href="#L94">94</a><span class="code-text">   ```sh</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L95" href="#L95">95</a><span class="code-text">   ./configure</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L96" href="#L96">96</a><span class="code-text">   ```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L97" href="#L97">97</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L98" href="#L98">98</a><span class="code-text">   If you plan to use `x.py install` to create an installation, it is</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L99" href="#L99">99</a><span class="code-text">   recommended that you set the `prefix` value in the `[install]` section to a</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L100" href="#L100">100</a><span class="code-text">   directory: `./configure --set install.prefix=&lt;path&gt;`</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">3. Build and install:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L103" href="#L103">103</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L104" href="#L104">104</a><span class="code-text">   ```sh</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L105" href="#L105">105</a><span class="code-text">   ./x.py build &amp;&amp; ./x.py install</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L106" href="#L106">106</a><span class="code-text">   ```</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">   When complete, `./x.py install` will place several programs into</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L109" href="#L109">109</a><span class="code-text">   `$PREFIX/bin`: `rustc`, the Rust compiler, and `rustdoc`, the</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L110" href="#L110">110</a><span class="code-text">   API-documentation tool. By default, it will also include [Cargo], Rust's</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L111" href="#L111">111</a><span class="code-text">   package manager. You can disable this behavior by passing</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L112" href="#L112">112</a><span class="code-text">   `--set build.extended=false` to `./configure`.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L113" href="#L113">113</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L114" href="#L114">114</a><span class="code-text">[Cargo]: https://github.com/rust-lang/cargo</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L115" href="#L115">115</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L116" href="#L116">116</a><span class="code-text">#### Configure and Make</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L117" href="#L117">117</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L118" href="#L118">118</a><span class="code-text">This project provides a configure script and makefile (the latter of which just</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L119" href="#L119">119</a><span class="code-text">invokes `x.py`). `./configure` is the recommended way to programatically</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L120" href="#L120">120</a><span class="code-text">generate a `config.toml`. `make` is not recommended (we suggest using `x.py`</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L121" href="#L121">121</a><span class="code-text">directly), but it is supported and we try not to break it unnecessarily.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L122" href="#L122">122</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L123" href="#L123">123</a><span class="code-text">```sh</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L124" href="#L124">124</a><span class="code-text">./configure</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L125" href="#L125">125</a><span class="code-text">make &amp;&amp; sudo make install</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L126" href="#L126">126</a><span class="code-text">```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L127" href="#L127">127</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L128" href="#L128">128</a><span class="code-text">`configure` generates a `config.toml` which can also be used with normal `x.py`</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L129" href="#L129">129</a><span class="code-text">invocations.</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">### Building on Windows</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L132" href="#L132">132</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L133" href="#L133">133</a><span class="code-text">On Windows, we suggest using [winget] to install dependencies by running the</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L134" href="#L134">134</a><span class="code-text">following in a terminal:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L135" href="#L135">135</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L136" href="#L136">136</a><span class="code-text">```powershell</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L137" href="#L137">137</a><span class="code-text">winget install -e Python.Python.3</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L138" href="#L138">138</a><span class="code-text">winget install -e Kitware.CMake</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L139" href="#L139">139</a><span class="code-text">winget install -e Git.Git</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L140" href="#L140">140</a><span class="code-text">```</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">Then edit your system's `PATH` variable and add: `C:\Program Files\CMake\bin`.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L143" href="#L143">143</a><span class="code-text">See</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L144" href="#L144">144</a><span class="code-text">[this guide on editing the system `PATH`](https://www.java.com/en/download/help/path.html)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L145" href="#L145">145</a><span class="code-text">from the Java documentation.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L146" href="#L146">146</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L147" href="#L147">147</a><span class="code-text">[winget]: https://github.com/microsoft/winget-cli</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L148" href="#L148">148</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L149" href="#L149">149</a><span class="code-text">There are two prominent ABIs in use on Windows: the native (MSVC) ABI used by</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L150" href="#L150">150</a><span class="code-text">Visual Studio and the GNU ABI used by the GCC toolchain. Which version of Rust</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L151" href="#L151">151</a><span class="code-text">you need depends largely on what C/C++ libraries you want to interoperate with.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L152" href="#L152">152</a><span class="code-text">Use the MSVC build of Rust to interop with software produced by Visual Studio</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L153" href="#L153">153</a><span class="code-text">and the GNU build to interop with GNU software built using the MinGW/MSYS2</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L154" href="#L154">154</a><span class="code-text">toolchain.</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">#### MinGW</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">[MSYS2][msys2] can be used to easily build Rust on Windows:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L159" href="#L159">159</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L160" href="#L160">160</a><span class="code-text">[msys2]: https://www.msys2.org/</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L161" href="#L161">161</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L162" href="#L162">162</a><span class="code-text">1. Download the latest [MSYS2 installer][msys2] and go through the installer.</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">2. Run `mingw32_shell.bat` or `mingw64_shell.bat` from the MSYS2 installation</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L165" href="#L165">165</a><span class="code-text">   directory (e.g. `C:\msys64`), depending on whether you want 32-bit or 64-bit</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L166" href="#L166">166</a><span class="code-text">   Rust. (As of the latest version of MSYS2 you have to run `msys2_shell.cmd</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L167" href="#L167">167</a><span class="code-text">   -mingw32` or `msys2_shell.cmd -mingw64` from the command line instead.)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L168" href="#L168">168</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L169" href="#L169">169</a><span class="code-text">3. From this terminal, install the required tools:</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">   ```sh</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L172" href="#L172">172</a><span class="code-text">   # Update package mirrors (may be needed if you have a fresh install of MSYS2)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L173" href="#L173">173</a><span class="code-text">   pacman -Sy pacman-mirrors</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">   # Install build tools needed for Rust. If you're building a 32-bit compiler,</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L176" href="#L176">176</a><span class="code-text">   # then replace &quot;x86_64&quot; below with &quot;i686&quot;. If you've already got Git, Python,</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L177" href="#L177">177</a><span class="code-text">   # or CMake installed and in PATH you can remove them from this list.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L178" href="#L178">178</a><span class="code-text">   # Note that it is important that you do **not** use the 'python2', 'cmake',</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L179" href="#L179">179</a><span class="code-text">   # and 'ninja' packages from the 'msys2' subsystem.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L180" href="#L180">180</a><span class="code-text">   # The build has historically been known to fail with these packages.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L181" href="#L181">181</a><span class="code-text">   pacman -S git \</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L182" href="#L182">182</a><span class="code-text">               make \</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L183" href="#L183">183</a><span class="code-text">               diffutils \</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L184" href="#L184">184</a><span class="code-text">               tar \</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L185" href="#L185">185</a><span class="code-text">               mingw-w64-x86_64-python \</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L186" href="#L186">186</a><span class="code-text">               mingw-w64-x86_64-cmake \</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L187" href="#L187">187</a><span class="code-text">               mingw-w64-x86_64-gcc \</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L188" href="#L188">188</a><span class="code-text">               mingw-w64-x86_64-ninja</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"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L191" href="#L191">191</a><span class="code-text">4. Navigate to Rust's source code (or clone it), then build it:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L192" href="#L192">192</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L193" href="#L193">193</a><span class="code-text">   ```sh</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L194" href="#L194">194</a><span class="code-text">   python x.py setup user &amp;&amp; python x.py build &amp;&amp; python x.py install</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L195" href="#L195">195</a><span class="code-text">   ```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L196" href="#L196">196</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L197" href="#L197">197</a><span class="code-text">#### MSVC</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L198" href="#L198">198</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L199" href="#L199">199</a><span class="code-text">MSVC builds of Rust additionally require an installation of Visual Studio 2017</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L200" href="#L200">200</a><span class="code-text">(or later) so `rustc` can use its linker. The simplest way is to get</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L201" href="#L201">201</a><span class="code-text">[Visual Studio], check the &quot;C++ build tools&quot; and &quot;Windows 10 SDK&quot; workload.</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">[Visual Studio]: https://visualstudio.microsoft.com/downloads/</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L204" href="#L204">204</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L205" href="#L205">205</a><span class="code-text">(If you're installing CMake yourself, be careful that &quot;C++ CMake tools for</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L206" href="#L206">206</a><span class="code-text">Windows&quot; doesn't get included under &quot;Individual components&quot;.)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L207" href="#L207">207</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L208" href="#L208">208</a><span class="code-text">With these dependencies installed, you can build the compiler in a `cmd.exe`</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L209" href="#L209">209</a><span class="code-text">shell with:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L210" href="#L210">210</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L211" href="#L211">211</a><span class="code-text">```sh</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L212" href="#L212">212</a><span class="code-text">python x.py setup user</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L213" href="#L213">213</a><span class="code-text">python x.py build</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L214" href="#L214">214</a><span class="code-text">```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L215" href="#L215">215</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L216" href="#L216">216</a><span class="code-text">Right now, building Rust only works with some known versions of Visual Studio.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L217" href="#L217">217</a><span class="code-text">If you have a more recent version installed and the build system doesn't</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L218" href="#L218">218</a><span class="code-text">understand, you may need to force rustbuild to use an older version.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L219" href="#L219">219</a><span class="code-text">This can be done by manually calling the appropriate vcvars file before running</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L220" href="#L220">220</a><span class="code-text">the bootstrap.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L221" href="#L221">221</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L222" href="#L222">222</a><span class="code-text">```batch</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L223" href="#L223">223</a><span class="code-text">CALL &quot;C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\VC\Auxiliary\Build\vcvars64.bat&quot;</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L224" href="#L224">224</a><span class="code-text">python x.py build</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L225" href="#L225">225</a><span class="code-text">```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L226" href="#L226">226</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L227" href="#L227">227</a><span class="code-text">#### Specifying an ABI</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L228" href="#L228">228</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L229" href="#L229">229</a><span class="code-text">Each specific ABI can also be used from either environment (for example, using</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L230" href="#L230">230</a><span class="code-text">the GNU ABI in PowerShell) by using an explicit build triple. The available</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L231" href="#L231">231</a><span class="code-text">Windows build triples are:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L232" href="#L232">232</a><span class="code-text">- GNU ABI (using GCC)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L233" href="#L233">233</a><span class="code-text">    - `i686-pc-windows-gnu`</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L234" href="#L234">234</a><span class="code-text">    - `x86_64-pc-windows-gnu`</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L235" href="#L235">235</a><span class="code-text">- The MSVC ABI</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L236" href="#L236">236</a><span class="code-text">    - `i686-pc-windows-msvc`</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L237" href="#L237">237</a><span class="code-text">    - `x86_64-pc-windows-msvc`</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L238" href="#L238">238</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L239" href="#L239">239</a><span class="code-text">The build triple can be specified by either specifying `--build=&lt;triple&gt;` when</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L240" href="#L240">240</a><span class="code-text">invoking `x.py` commands, or by creating a `config.toml` file (as described in</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L241" href="#L241">241</a><span class="code-text">[Building on a Unix-like system](#building-on-a-unix-like-system)), and passing</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L242" href="#L242">242</a><span class="code-text">`--set build.build=&lt;triple&gt;` to `./configure`.</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">## Building Documentation</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">If you'd like to build the documentation, it's almost the same:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L247" href="#L247">247</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L248" href="#L248">248</a><span class="code-text">```sh</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L249" href="#L249">249</a><span class="code-text">./x.py doc</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L250" href="#L250">250</a><span class="code-text">```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L251" href="#L251">251</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L252" href="#L252">252</a><span class="code-text">The generated documentation will appear under `doc` in the `build` directory for</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L253" href="#L253">253</a><span class="code-text">the ABI used. That is, if the ABI was `x86_64-pc-windows-msvc`, the directory</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L254" href="#L254">254</a><span class="code-text">will be `build\x86_64-pc-windows-msvc\doc`.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L255" href="#L255">255</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L256" href="#L256">256</a><span class="code-text">## Notes</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L257" href="#L257">257</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L258" href="#L258">258</a><span class="code-text">Since the Rust compiler is written in Rust, it must be built by a precompiled</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L259" href="#L259">259</a><span class="code-text">&quot;snapshot&quot; version of itself (made in an earlier stage of development).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L260" href="#L260">260</a><span class="code-text">As such, source builds require an Internet connection to fetch snapshots, and an</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L261" href="#L261">261</a><span class="code-text">OS that can execute the available snapshot binaries.</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">See https://doc.rust-lang.org/nightly/rustc/platform-support.html for a list of</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L264" href="#L264">264</a><span class="code-text">supported platforms.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L265" href="#L265">265</a><span class="code-text">Only &quot;host tools&quot; platforms have a pre-compiled snapshot binary available; to</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L266" href="#L266">266</a><span class="code-text">compile for a platform without host tools you must cross-compile.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L267" href="#L267">267</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L268" href="#L268">268</a><span class="code-text">You may find that other platforms work, but these are our officially supported</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L269" href="#L269">269</a><span class="code-text">build environments that are most likely to work.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L270" href="#L270">270</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L271" href="#L271">271</a><span class="code-text">## Getting Help</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L272" href="#L272">272</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L273" href="#L273">273</a><span class="code-text">See https://www.rust-lang.org/community for a list of chat platforms and forums.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L274" href="#L274">274</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L275" href="#L275">275</a><span class="code-text">## Contributing</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L276" href="#L276">276</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L277" href="#L277">277</a><span class="code-text">See [CONTRIBUTING.md](CONTRIBUTING.md).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L278" href="#L278">278</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L279" href="#L279">279</a><span class="code-text">## License</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L280" href="#L280">280</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L281" href="#L281">281</a><span class="code-text">Rust is primarily distributed under the terms of both the MIT license and the</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L282" href="#L282">282</a><span class="code-text">Apache License (Version 2.0), with portions covered by various BSD-like</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L283" href="#L283">283</a><span class="code-text">licenses.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L284" href="#L284">284</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L285" href="#L285">285</a><span class="code-text">See [LICENSE-APACHE](LICENSE-APACHE), [LICENSE-MIT](LICENSE-MIT), and</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L286" href="#L286">286</a><span class="code-text">[COPYRIGHT](COPYRIGHT) for details.</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">## Trademark</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L289" href="#L289">289</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L290" href="#L290">290</a><span class="code-text">[The Rust Foundation][rust-foundation] owns and protects the Rust and Cargo</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L291" href="#L291">291</a><span class="code-text">trademarks and logos (the &quot;Rust Trademarks&quot;).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L292" href="#L292">292</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L293" href="#L293">293</a><span class="code-text">If you want to use these names or brands, please read the</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L294" href="#L294">294</a><span class="code-text">[media guide][media-guide].</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">Third-party logos may be subject to third-party copyrights and trademarks. See</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L297" href="#L297">297</a><span class="code-text">[Licenses][policies-licenses] for details.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L298" href="#L298">298</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L299" href="#L299">299</a><span class="code-text">[rust-foundation]: https://foundation.rust-lang.org/</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L300" href="#L300">300</a><span class="code-text">[media-guide]: https://foundation.rust-lang.org/policies/logo-policy-and-media-guide/</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L301" href="#L301">301</a><span class="code-text">[policies-licenses]: https://www.rust-lang.org/policies/licenses</span></span></pre></div></div>
</main>
</body>
</html>
