| <!DOCTYPE HTML> |
| <html lang="en" class="light sidebar-visible" dir="ltr"> |
| <head> |
| <!-- Book generated using mdBook --> |
| <meta charset="UTF-8"> |
| <title>Suggested workflows - Rust Compiler Development Guide</title> |
| |
| |
| <!-- Custom HTML head --> |
| |
| <meta name="description" content="A guide to developing the Rust compiler (rustc)"> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta name="theme-color" content="#ffffff"> |
| |
| <link rel="icon" href="../favicon-de23e50b.svg"> |
| <link rel="shortcut icon" href="../favicon-8114d1fc.png"> |
| <link rel="stylesheet" href="../css/variables-8adf115d.css"> |
| <link rel="stylesheet" href="../css/general-e96d0476.css"> |
| <link rel="stylesheet" href="../css/chrome-d279d366.css"> |
| <link rel="stylesheet" href="../css/print-9e4910d8.css" media="print"> |
| |
| <!-- Fonts --> |
| <link rel="stylesheet" href="../fonts/fonts-9644e21d.css"> |
| |
| <!-- Highlight.js Stylesheets --> |
| <link rel="stylesheet" id="mdbook-highlight-css" href="../highlight-493f70e1.css"> |
| <link rel="stylesheet" id="mdbook-tomorrow-night-css" href="../tomorrow-night-4c0ae647.css"> |
| <link rel="stylesheet" id="mdbook-ayu-highlight-css" href="../ayu-highlight-3fdfc3ac.css"> |
| |
| <!-- Custom theme stylesheets --> |
| |
| |
| <!-- Provide site root and default themes to javascript --> |
| <script> |
| const path_to_root = "../"; |
| const default_light_theme = "light"; |
| const default_dark_theme = "navy"; |
| window.path_to_searchindex_js = "../searchindex-e98c7681.js"; |
| </script> |
| <!-- Start loading toc.js asap --> |
| <script src="../toc-02332530.js"></script> |
| </head> |
| <body> |
| <div id="mdbook-help-container"> |
| <div id="mdbook-help-popup"> |
| <h2 class="mdbook-help-title">Keyboard shortcuts</h2> |
| <div> |
| <p>Press <kbd>←</kbd> or <kbd>→</kbd> to navigate between chapters</p> |
| <p>Press <kbd>S</kbd> or <kbd>/</kbd> to search in the book</p> |
| <p>Press <kbd>?</kbd> to show this help</p> |
| <p>Press <kbd>Esc</kbd> to hide this help</p> |
| </div> |
| </div> |
| </div> |
| <div id="mdbook-body-container"> |
| <!-- Work around some values being stored in localStorage wrapped in quotes --> |
| <script> |
| try { |
| let theme = localStorage.getItem('mdbook-theme'); |
| let sidebar = localStorage.getItem('mdbook-sidebar'); |
| |
| if (theme.startsWith('"') && theme.endsWith('"')) { |
| localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1)); |
| } |
| |
| if (sidebar.startsWith('"') && sidebar.endsWith('"')) { |
| localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1)); |
| } |
| } catch (e) { } |
| </script> |
| |
| <!-- Set the theme before any content is loaded, prevents flash --> |
| <script> |
| const default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? default_dark_theme : default_light_theme; |
| let theme; |
| try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { } |
| if (theme === null || theme === undefined) { theme = default_theme; } |
| const html = document.documentElement; |
| html.classList.remove('light') |
| html.classList.add(theme); |
| html.classList.add("js"); |
| </script> |
| |
| <input type="checkbox" id="mdbook-sidebar-toggle-anchor" class="hidden"> |
| |
| <!-- Hide / unhide sidebar before it is displayed --> |
| <script> |
| let sidebar = null; |
| const sidebar_toggle = document.getElementById("mdbook-sidebar-toggle-anchor"); |
| if (document.body.clientWidth >= 1080) { |
| try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { } |
| sidebar = sidebar || 'visible'; |
| } else { |
| sidebar = 'hidden'; |
| sidebar_toggle.checked = false; |
| } |
| if (sidebar === 'visible') { |
| sidebar_toggle.checked = true; |
| } else { |
| html.classList.remove('sidebar-visible'); |
| } |
| </script> |
| |
| <nav id="mdbook-sidebar" class="sidebar" aria-label="Table of contents"> |
| <!-- populated by js --> |
| <mdbook-sidebar-scrollbox class="sidebar-scrollbox"></mdbook-sidebar-scrollbox> |
| <noscript> |
| <iframe class="sidebar-iframe-outer" src="../toc.html"></iframe> |
| </noscript> |
| <div id="mdbook-sidebar-resize-handle" class="sidebar-resize-handle"> |
| <div class="sidebar-resize-indicator"></div> |
| </div> |
| </nav> |
| |
| <div id="mdbook-page-wrapper" class="page-wrapper"> |
| |
| <div class="page"> |
| <div id="mdbook-menu-bar-hover-placeholder"></div> |
| <div id="mdbook-menu-bar" class="menu-bar sticky"> |
| <div class="left-buttons"> |
| <label id="mdbook-sidebar-toggle" class="icon-button" for="mdbook-sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="mdbook-sidebar"> |
| <span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M0 96C0 78.3 14.3 64 32 64H416c17.7 0 32 14.3 32 32s-14.3 32-32 32H32C14.3 128 0 113.7 0 96zM0 256c0-17.7 14.3-32 32-32H416c17.7 0 32 14.3 32 32s-14.3 32-32 32H32c-17.7 0-32-14.3-32-32zM448 416c0 17.7-14.3 32-32 32H32c-17.7 0-32-14.3-32-32s14.3-32 32-32H416c17.7 0 32 14.3 32 32z"/></svg></span> |
| </label> |
| <button id="mdbook-theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="mdbook-theme-list"> |
| <span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M371.3 367.1c27.3-3.9 51.9-19.4 67.2-42.9L600.2 74.1c12.6-19.5 9.4-45.3-7.6-61.2S549.7-4.4 531.1 9.6L294.4 187.2c-24 18-38.2 46.1-38.4 76.1L371.3 367.1zm-19.6 25.4l-116-104.4C175.9 290.3 128 339.6 128 400c0 3.9 .2 7.8 .6 11.6c1.8 17.5-10.2 36.4-27.8 36.4H96c-17.7 0-32 14.3-32 32s14.3 32 32 32H240c61.9 0 112-50.1 112-112c0-2.5-.1-5-.2-7.5z"/></svg></span> |
| </button> |
| <ul id="mdbook-theme-list" class="theme-popup" aria-label="Themes" role="menu"> |
| <li role="none"><button role="menuitem" class="theme" id="mdbook-theme-default_theme">Auto</button></li> |
| <li role="none"><button role="menuitem" class="theme" id="mdbook-theme-light">Light</button></li> |
| <li role="none"><button role="menuitem" class="theme" id="mdbook-theme-rust">Rust</button></li> |
| <li role="none"><button role="menuitem" class="theme" id="mdbook-theme-coal">Coal</button></li> |
| <li role="none"><button role="menuitem" class="theme" id="mdbook-theme-navy">Navy</button></li> |
| <li role="none"><button role="menuitem" class="theme" id="mdbook-theme-ayu">Ayu</button></li> |
| </ul> |
| <button id="mdbook-search-toggle" class="icon-button" type="button" title="Search (`/`)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="/ s" aria-controls="mdbook-searchbar"> |
| <span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M416 208c0 45.9-14.9 88.3-40 122.7L502.6 457.4c12.5 12.5 12.5 32.8 0 45.3s-32.8 12.5-45.3 0L330.7 376c-34.4 25.2-76.8 40-122.7 40C93.1 416 0 322.9 0 208S93.1 0 208 0S416 93.1 416 208zM208 352c79.5 0 144-64.5 144-144s-64.5-144-144-144S64 128.5 64 208s64.5 144 144 144z"/></svg></span> |
| </button> |
| </div> |
| |
| <h1 class="menu-title">Rust Compiler Development Guide</h1> |
| |
| <div class="right-buttons"> |
| <a href="../print.html" title="Print this book" aria-label="Print this book"> |
| <span class=fa-svg id="print-button"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M128 0C92.7 0 64 28.7 64 64v96h64V64H354.7L384 93.3V160h64V93.3c0-17-6.7-33.3-18.7-45.3L400 18.7C388 6.7 371.7 0 354.7 0H128zM384 352v32 64H128V384 368 352H384zm64 32h32c17.7 0 32-14.3 32-32V256c0-35.3-28.7-64-64-64H64c-35.3 0-64 28.7-64 64v96c0 17.7 14.3 32 32 32H64v64c0 35.3 28.7 64 64 64H384c35.3 0 64-28.7 64-64V384zm-16-88c-13.3 0-24-10.7-24-24s10.7-24 24-24s24 10.7 24 24s-10.7 24-24 24z"/></svg></span> |
| </a> |
| <a href="https://github.com/rust-lang/rustc-dev-guide" title="Git repository" aria-label="Git repository"> |
| <span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"/></svg></span> |
| </a> |
| <a href="https://github.com/rust-lang/rustc-dev-guide/edit/main/src/building/suggested.md" title="Suggest an edit" aria-label="Suggest an edit" rel="edit"> |
| <span class=fa-svg id="git-edit-button"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M421.7 220.3l-11.3 11.3-22.6 22.6-205 205c-6.6 6.6-14.8 11.5-23.8 14.1L30.8 511c-8.4 2.5-17.5 .2-23.7-6.1S-1.5 489.7 1 481.2L38.7 353.1c2.6-9 7.5-17.2 14.1-23.8l205-205 22.6-22.6 11.3-11.3 33.9 33.9 62.1 62.1 33.9 33.9zM96 353.9l-9.3 9.3c-.9 .9-1.6 2.1-2 3.4l-25.3 86 86-25.3c1.3-.4 2.5-1.1 3.4-2l9.3-9.3H112c-8.8 0-16-7.2-16-16V353.9zM453.3 19.3l39.4 39.4c25 25 25 65.5 0 90.5l-14.5 14.5-22.6 22.6-11.3 11.3-33.9-33.9-62.1-62.1L314.3 67.7l11.3-11.3 22.6-22.6 14.5-14.5c25-25 65.5-25 90.5 0z"/></svg></span> |
| </a> |
| |
| </div> |
| </div> |
| |
| <div id="mdbook-search-wrapper" class="hidden"> |
| <form id="mdbook-searchbar-outer" class="searchbar-outer"> |
| <div class="search-wrapper"> |
| <input type="search" id="mdbook-searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="mdbook-searchresults-outer" aria-describedby="searchresults-header"> |
| <div class="spinner-wrapper"> |
| <span class=fa-svg id="fa-spin"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M304 48c0-26.5-21.5-48-48-48s-48 21.5-48 48s21.5 48 48 48s48-21.5 48-48zm0 416c0-26.5-21.5-48-48-48s-48 21.5-48 48s21.5 48 48 48s48-21.5 48-48zM48 304c26.5 0 48-21.5 48-48s-21.5-48-48-48s-48 21.5-48 48s21.5 48 48 48zm464-48c0-26.5-21.5-48-48-48s-48 21.5-48 48s21.5 48 48 48s48-21.5 48-48zM142.9 437c18.7-18.7 18.7-49.1 0-67.9s-49.1-18.7-67.9 0s-18.7 49.1 0 67.9s49.1 18.7 67.9 0zm0-294.2c18.7-18.7 18.7-49.1 0-67.9S93.7 56.2 75 75s-18.7 49.1 0 67.9s49.1 18.7 67.9 0zM369.1 437c18.7 18.7 49.1 18.7 67.9 0s18.7-49.1 0-67.9s-49.1-18.7-67.9 0s-18.7 49.1 0 67.9z"/></svg></span> |
| </div> |
| </div> |
| </form> |
| <div id="mdbook-searchresults-outer" class="searchresults-outer hidden"> |
| <div id="mdbook-searchresults-header" class="searchresults-header"></div> |
| <ul id="mdbook-searchresults"> |
| </ul> |
| </div> |
| </div> |
| |
| <!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM --> |
| <script> |
| document.getElementById('mdbook-sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible'); |
| document.getElementById('mdbook-sidebar').setAttribute('aria-hidden', sidebar !== 'visible'); |
| Array.from(document.querySelectorAll('#mdbook-sidebar a')).forEach(function(link) { |
| link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1); |
| }); |
| </script> |
| |
| <div id="mdbook-content" class="content"> |
| <main> |
| <h1 id="suggested-workflows"><a class="header" href="#suggested-workflows">Suggested workflows</a></h1> |
| <p>The full bootstrapping process takes quite a while. |
| Here are some suggestions to make your life easier.</p> |
| <h2 id="installing-a-pre-push-hook"><a class="header" href="#installing-a-pre-push-hook">Installing a pre-push hook</a></h2> |
| <p>CI will automatically fail your build if it doesn’t pass <code>tidy</code>, our internal |
| tool for ensuring code quality. |
| If you’d like, you can install a <a href="https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks">Git |
| hook</a> that will |
| automatically run <code>./x test tidy</code> on each push, to ensure your code is up to par. |
| If the hook fails then run <code>./x test tidy --bless</code> and commit the changes. |
| If you decide later that the pre-push behavior is undesirable, you can delete |
| the <code>pre-push</code> file in <code>.git/hooks</code>.</p> |
| <p>A prebuilt git hook lives at <a href="https://github.com/rust-lang/rust/blob/HEAD/src/etc/pre-push.sh"><code>src/etc/pre-push.sh</code></a>. |
| It can be copied into your <code>.git/hooks</code> folder as <code>pre-push</code> (without the <code>.sh</code> extension!).</p> |
| <p>You can also install the hook as a step of running <code>./x setup</code>!</p> |
| <h2 id="config-extensions"><a class="header" href="#config-extensions">Config extensions</a></h2> |
| <p>When working on different tasks, you might need to switch between different bootstrap configurations. |
| Sometimes you may want to keep an old configuration for future use. |
| But saving raw config values in |
| random files and manually copying and pasting them can quickly become messy, especially if you have a |
| long history of different configurations.</p> |
| <p>To simplify managing multiple configurations, you can create config extensions.</p> |
| <p>For example, you can create a simple config file named <code>cross.toml</code>:</p> |
| <pre><code class="language-toml">[build] |
| build = "x86_64-unknown-linux-gnu" |
| host = ["i686-unknown-linux-gnu"] |
| target = ["i686-unknown-linux-gnu"] |
| |
| |
| [llvm] |
| download-ci-llvm = false |
| |
| [target.x86_64-unknown-linux-gnu] |
| llvm-config = "/path/to/llvm-19/bin/llvm-config" |
| </code></pre> |
| <p>Then, include this in your <code>bootstrap.toml</code>:</p> |
| <pre><code class="language-toml">include = ["cross.toml"] |
| </code></pre> |
| <p>You can also include extensions within extensions recursively.</p> |
| <p><strong>Note:</strong> In the <code>include</code> field, the overriding logic follows a right-to-left order. |
| For example, |
| in <code>include = ["a.toml", "b.toml"]</code>, extension <code>b.toml</code> overrides <code>a.toml</code>. |
| Also, parent extensions always override the inner ones.</p> |
| <h2 id="configuring-rust-analyzer-for-rustc"><a class="header" href="#configuring-rust-analyzer-for-rustc">Configuring <code>rust-analyzer</code> for <code>rustc</code></a></h2> |
| <h3 id="checking-the-library-tree"><a class="header" href="#checking-the-library-tree">Checking the “library” tree</a></h3> |
| <p>Checking the “library” tree requires a stage1 compiler, which can be a heavy process on some computers. |
| For this reason, bootstrap has a flag called <code>--skip-std-check-if-no-download-rustc</code> that skips checking the |
| “library” tree if <code>rust.download-rustc</code> isn’t available. |
| If you want to avoid putting a heavy load on your computer |
| with <code>rust-analyzer</code>, you can add the <code>--skip-std-check-if-no-download-rustc</code> flag to your <code>./x check</code> command in |
| the <code>rust-analyzer</code> configuration.</p> |
| <h3 id="project-local-rust-analyzer-setup"><a class="header" href="#project-local-rust-analyzer-setup">Project-local rust-analyzer setup</a></h3> |
| <p><code>rust-analyzer</code> can help you check and format your code whenever you save a file. |
| By default, <code>rust-analyzer</code> runs the <code>cargo check</code> and <code>rustfmt</code> commands, |
| but you can override these commands to use more adapted versions of these tools |
| when hacking on <code>rustc</code>. |
| With custom setup, <code>rust-analyzer</code> can use <code>./x check</code> |
| to check the sources, and the stage 0 rustfmt to format them.</p> |
| <p>The default <code>rust-analyzer.check.overrideCommand</code> command line will check all |
| the crates and tools in the repository. |
| If you are working on a specific part, |
| you can override the command to only check the part you are working on to save checking time. |
| For example, if you are working on the compiler, you can override |
| the command to <code>x check compiler --json-output</code> to only check the compiler part. |
| You can run <code>x check --help --verbose</code> to see the available parts.</p> |
| <p>Running <code>./x setup editor</code> will prompt you to create a project-local LSP config |
| file for one of the supported editors. |
| You can also create the config file as a step of running <code>./x setup</code>.</p> |
| <h3 id="using-a-shared-build-directory-for-rust-analyzer"><a class="header" href="#using-a-shared-build-directory-for-rust-analyzer">Using a shared build directory for rust-analyzer</a></h3> |
| <p>By default, when rust-analyzer runs a bootstrap command, |
| it will use a separate build directory from manual command-line builds. |
| You can override this your generated LSP config file if you want to save disk space.</p> |
| <p>However, this is not recommended:</p> |
| <ul> |
| <li>Each build will lock the build directory and force the other to wait, so it |
| becomes impossible to run command-line builds while rust-analyzer is running |
| commands in the background.</li> |
| <li>There is an increased risk of one of the builds deleting previously-built |
| artifacts due to conflicting compiler flags or other settings, forcing |
| additional rebuilds in some cases.</li> |
| </ul> |
| <h3 id="visual-studio-code"><a class="header" href="#visual-studio-code">Visual Studio Code</a></h3> |
| <p>Selecting <code>vscode</code> in <code>./x setup editor</code> will prompt you to create a |
| <code>.vscode/settings.json</code> file which will configure Visual Studio code. |
| The recommended <code>rust-analyzer</code> settings live at <a href="https://github.com/rust-lang/rust/blob/HEAD/src/etc/rust_analyzer_settings.json"><code>src/etc/rust_analyzer_settings.json</code></a>.</p> |
| <p>If running <code>./x check</code> on save is inconvenient, in VS Code you can use a <a href="https://code.visualstudio.com/docs/editor/tasks">Build Task</a> instead:</p> |
| <pre><code class="language-JSON">// .vscode/tasks.json |
| { |
| "version": "2.0.0", |
| "tasks": [ |
| { |
| "label": "./x check", |
| "command": "./x check", |
| "type": "shell", |
| "problemMatcher": "$rustc", |
| "presentation": { "clear": true }, |
| "group": { "kind": "build", "isDefault": true } |
| } |
| ] |
| } |
| </code></pre> |
| <h3 id="neovim"><a class="header" href="#neovim">Neovim</a></h3> |
| <p>For Neovim users, there are a few options:</p> |
| <ol> |
| <li>The easiest way is using <a href="https://github.com/folke/neoconf.nvim/">neoconf.nvim</a> but it uses the |
| deprecated <code>require('lspconfig')</code> API which displays a warning on neovim 0.11+.</li> |
| <li>Using <code>coc.nvim</code> is another option but it requires node.js to be installed.</li> |
| <li>Using a custom script to load rust-analyzer settings.</li> |
| </ol> |
| <h4 id="neoconfnvim"><a class="header" href="#neoconfnvim">neoconf.nvim</a></h4> |
| <p><a href="https://github.com/folke/neoconf.nvim/">neoconf.nvim</a> allows for project-local configuration files with the native LSP. |
| The steps for how to use it are below. |
| Note that they require rust-analyzer to already be configured with Neovim. |
| Steps for this can be <a href="https://rust-analyzer.github.io/book/other_editors.html#nvim-lsp">found here</a>.</p> |
| <ol> |
| <li>First install the plugin. |
| This can be done by following the steps in the README.</li> |
| <li>Run <code>./x setup editor</code>, and select <code>vscode</code> to create a <code>.vscode/settings.json</code> file. |
| <code>neoconf</code> is able to read and update |
| rust-analyzer settings automatically when the project is opened when this file is detected. |
| Neovim does not expand VS Code’s <code>${workspaceFolder}</code> variable, so replace each occurrence |
| in the generated file with the absolute path to your rust repository.</li> |
| </ol> |
| <h4 id="cocnvim"><a class="header" href="#cocnvim">coc.nvim</a></h4> |
| <p>If you’re using <code>coc.nvim</code>, you can run <code>./x setup editor</code> and select <code>vim</code> to |
| create a <code>.vim/coc-settings.json</code>. |
| The settings can be edited with <code>:CocLocalConfig</code>. |
| The recommended settings live at <a href="https://github.com/rust-lang/rust/blob/HEAD/src/etc/rust_analyzer_settings.json"><code>src/etc/rust_analyzer_settings.json</code></a>.</p> |
| <h4 id="custom-lsp-settings"><a class="header" href="#custom-lsp-settings">Custom LSP settings</a></h4> |
| <p>If you’re running neovim 0.11+, you can configure rust-analyzer with just |
| <a href="https://github.com/neovim/nvim-lspconfig">nvim-lspconfig</a> and a custom script.</p> |
| <ol> |
| <li>Make sure <a href="https://rust-analyzer.github.io/book/other_editors.html#nvim-lsp">rust-analyzer LSP</a> is set up</li> |
| <li>Create <code>$HOME/.config/nvim/after/plugged/rust_analyzer.lua</code> with the following content:</li> |
| </ol> |
| <pre><code class="language-lua">-- Capture the default functions from nvim-lspconfig/lsp/rust_analyzer.lua before overriding it. |
| -- This file is in after/plugin to guarantee nvim-lspconfig has been initialised already. |
| local default_root_dir = vim.lsp.config["rust_analyzer"].root_dir |
| local default_before_init = vim.lsp.config["rust_analyzer"].before_init |
| |
| vim.lsp.config("rust_analyzer", { |
| cmd = { "rust-analyzer" }, |
| filetypes = { "rust" }, |
| -- To support rust-lang/rust, we need to detect when we're in the rust repo and use the git root |
| -- instead of cargo project root. |
| root_dir = function(bufnr, on_dir) |
| local git_root = vim.fs.root(bufnr, { ".git" }) |
| if git_root then |
| if vim.uv.fs_stat(vim.fs.joinpath(git_root, "src/etc/rust_analyzer_zed.json")) then |
| on_dir(git_root) |
| return |
| end |
| end |
| -- For anything that doesn't match rust-lang/rust, fallback to default root_dir |
| default_root_dir(bufnr, on_dir) |
| end, |
| before_init = function(init_params, config) |
| -- When inside rust-lang/rust, we need to use the special rust-analyzer settings. |
| local settings = vim.fs.joinpath(config.root_dir, "src/etc/rust_analyzer_zed.json") |
| if vim.uv.fs_stat(settings) then |
| local file = io.open(settings) |
| -- nvim 0.12+ supports comments otherwise you'll need content:gsub("//[^\n]*", ""). |
| local json = vim.json.decode(file:read("*a"), { skip_comments = true }) |
| file:close() |
| config.settings["rust-analyzer"] = vim.tbl_deep_extend( |
| "force", -- Overwrite with the special settings when there is a conflict. |
| config.settings["rust-analyzer"] or {}, |
| json.lsp["rust-analyzer"].initialization_options |
| ) |
| end |
| default_before_init(init_params, config) |
| end, |
| }) |
| |
| vim.lsp.enable("rust_analyzer") |
| </code></pre> |
| <p>If you would like to use the build task that is described above, you may either |
| make your own command in your config, or you can install a plugin such as |
| <a href="https://github.com/stevearc/overseer.nvim">overseer.nvim</a> that can <a href="https://github.com/stevearc/overseer.nvim/blob/master/doc/guides.md#vs-code-tasks">read VSCode’s <code>task.json</code> |
| files</a>, |
| and follow the same instructions as above.</p> |
| <h3 id="emacs"><a class="header" href="#emacs">Emacs</a></h3> |
| <p>Emacs provides support for rust-analyzer with project-local configuration |
| through <a href="https://www.gnu.org/software/emacs/manual/html_node/eglot/">Eglot</a>. |
| Steps for setting up Eglot with rust-analyzer can be <a href="https://rust-analyzer.github.io/manual.html#eglot">found |
| here</a>. |
| Having set up Emacs & Eglot for Rust development in general, you can run |
| <code>./x setup editor</code> and select <code>emacs</code>, which will prompt you to create |
| <code>.dir-locals.el</code> with the recommended configuration for Eglot. |
| The recommended settings live at <a href="https://github.com/rust-lang/rust/blob/HEAD/src/etc/rust_analyzer_eglot.el"><code>src/etc/rust_analyzer_eglot.el</code></a>. |
| For more information on project-specific Eglot configuration, consult <a href="https://www.gnu.org/software/emacs/manual/html_node/eglot/Project_002dspecific-configuration.html">the |
| manual</a>.</p> |
| <h3 id="helix"><a class="header" href="#helix">Helix</a></h3> |
| <p>Helix comes with built-in LSP and rust-analyzer support. |
| It can be configured through <code>languages.toml</code>, as described |
| <a href="https://docs.helix-editor.com/languages.html">here</a>. |
| You can run <code>./x setup editor</code> and select <code>helix</code>, which will prompt you to |
| create <code>languages.toml</code> with the recommended configuration for Helix. |
| The recommended settings live at <a href="https://github.com/rust-lang/rust/blob/HEAD/src/etc/rust_analyzer_helix.toml"><code>src/etc/rust_analyzer_helix.toml</code></a>.</p> |
| <h3 id="zed"><a class="header" href="#zed">Zed</a></h3> |
| <p>Zed comes with built-in LSP and rust-analyzer support. |
| It can be configured through <code>.zed/settings.json</code>, as described |
| <a href="https://zed.dev/docs/configuring-languages">here</a>. |
| Selecting <code>zed</code> in <code>./x setup editor</code> will prompt you to create a <code>.zed/settings.json</code> |
| file which will configure Zed with the recommended configuration. |
| The recommended <code>rust-analyzer</code> settings live at <a href="https://github.com/rust-lang/rust/blob/HEAD/src/etc/rust_analyzer_zed.json"><code>src/etc/rust_analyzer_zed.json</code></a>.</p> |
| <h2 id="check-check-and-check-again"><a class="header" href="#check-check-and-check-again">Check, check, and check again</a></h2> |
| <p>When doing simple refactoring, it can be useful to run <code>./x check</code> continuously. |
| If you set up <code>rust-analyzer</code> as described above, this will be |
| done for you every time you save a file. |
| Here you are just checking that the |
| compiler can <strong>build</strong>, but often that is all you need (e.g., when renaming a |
| method). |
| You can then run <code>./x build</code> when you actually need to run tests.</p> |
| <p>In fact, it is sometimes useful to put off tests even when you are not 100% sure the code will work. |
| You can then keep building up refactoring commits and only run the tests at some later time. |
| You can then use <code>git bisect</code> to track down <strong>precisely</strong> which commit caused the problem. |
| A nice side-effect of this style |
| is that you are left with a fairly fine-grained set of commits at the end, all |
| of which build and pass tests. |
| This often helps reviewing.</p> |
| <h2 id="configuring-rustup-to-use-nightly"><a class="header" href="#configuring-rustup-to-use-nightly">Configuring <code>rustup</code> to use nightly</a></h2> |
| <p>Some parts of the bootstrap process uses pinned, nightly versions of tools like rustfmt. |
| To make things like <code>cargo fmt</code> work correctly in your repo, |
| <a href="https://rust-lang.github.io/rustup/concepts/channels.html?highlight=nightl#working-with-nightly-rust">install a nightly toolchain</a> with rustup, then run this command:</p> |
| <pre><code class="language-console">cd <path to rustc repo> |
| rustup override set nightly |
| </code></pre> |
| <p>Don’t forget to do this for all directories you have <a href="./suggested.html#working-on-multiple-branches-at-the-same-time">setup a worktree for</a>. |
| You may need to use the |
| pinned nightly version from <code>src/stage0</code>, but often the normal <code>nightly</code> channel will work.</p> |
| <p><strong>Note</strong> see <a href="suggested.html#configuring-rust-analyzer-for-rustc">the section on vscode</a> for how to configure it with this real |
| rustfmt <code>x</code> uses, and <a href="how-to-build-and-run.html">the section on rustup</a> for how to setup <code>rustup</code> |
| toolchain for your bootstrapped compiler</p> |
| <p><strong>Note</strong> This does <em>not</em> allow you to build <code>rustc</code> with cargo directly. |
| You still have to use <code>x</code> to work on the compiler or standard library, this just |
| lets you use <code>cargo fmt</code>.</p> |
| <h2 id="faster-builds-with-ci-rustc"><a class="header" href="#faster-builds-with-ci-rustc">Faster Builds with CI-rustc</a></h2> |
| <p>If you are not working on the compiler, you often don’t need to build the compiler tree. |
| For example, you can skip building the compiler and only build the <code>library</code> tree or the |
| tools under <code>src/tools</code>. |
| To achieve that, you have to enable this by setting the <code>download-rustc</code> |
| option in your configuration. |
| This tells bootstrap to use the latest nightly compiler for <code>stage > 0</code> |
| steps, meaning it will have two precompiled compilers: stage0 compiler and <code>download-rustc</code> compiler |
| for <code>stage > 0</code> steps. |
| This way, it will never need to build the in-tree compiler. |
| As a result, your build time will be significantly reduced by not building the in-tree compiler.</p> |
| <h2 id="faster-rebuilds-with---keep-stage-std"><a class="header" href="#faster-rebuilds-with---keep-stage-std">Faster rebuilds with <code>--keep-stage-std</code></a></h2> |
| <p>Sometimes just checking whether the compiler builds is not enough. |
| A common example is that you need to add a <code>debug!</code> statement to inspect the value of |
| some state or better understand the problem. |
| In that case, you don’t really need a full build. |
| By bypassing bootstrap’s cache invalidation, you can often get these builds to complete faster. |
| The only catch is this requires a bit of fudging and may produce compilers that don’t work (but |
| that is easily detected and fixed).</p> |
| <p>The sequence of commands you want is as follows:</p> |
| <ul> |
| <li>Initial build: <code>./x build library</code></li> |
| <li>Subsequent builds: <code>./x build library --keep-stage-std=1</code></li> |
| </ul> |
| <p>As mentioned, the effect of <code>--keep-stage-std=1</code> is that we just <em>assume</em> that the |
| old standard library can be re-used. |
| If you are editing the compiler, this is |
| often true: you haven’t changed the standard library, after all. |
| But sometimes, it’s not true: for example, if you are editing the “metadata” part of |
| the compiler, which controls how the compiler encodes types and other states |
| into the <code>rlib</code> files, or if you are editing things that wind up in the metadata |
| (such as the definition of the MIR).</p> |
| <p>That is, you might get weird behavior from a compile when using |
| <code>--keep-stage-std=1</code>, for example, strange <a href="../appendix/glossary.html#ice">ICEs</a> or other panics. |
| In that case, you should simply remove the <code>--keep-stage-std=1</code> from the command and rebuild.</p> |
| <p>You can also use <code>--keep-stage-std=1</code> when running tests. |
| Something like this:</p> |
| <ul> |
| <li>Initial test run: <code>./x test tests/ui</code></li> |
| <li>Subsequent test run: <code>./x test tests/ui --keep-stage-std=1</code></li> |
| </ul> |
| <h2 id="using-incremental-compilation"><a class="header" href="#using-incremental-compilation">Using incremental compilation</a></h2> |
| <p>You can further enable the <code>--incremental</code> flag to save additional time in subsequent rebuilds:</p> |
| <pre><code class="language-bash">./x test tests/ui --incremental --test-args issue-1234 |
| </code></pre> |
| <p>If you don’t want to include the flag with every command, you can enable it in the <code>bootstrap.toml</code>:</p> |
| <pre><code class="language-toml">[rust] |
| incremental = true |
| </code></pre> |
| <p>Note that incremental compilation will use more disk space than usual. |
| If disk space is a concern for you, you might want to check the size of the <code>build</code> |
| directory from time to time.</p> |
| <h2 id="fine-tuning-optimizations"><a class="header" href="#fine-tuning-optimizations">Fine-tuning optimizations</a></h2> |
| <p>Setting <code>optimize = false</code> makes the compiler too slow for tests. |
| However, to improve the test cycle, you can disable optimizations selectively only for the |
| crates you’ll have to rebuild |
| (<a href="https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/topic/incremental.20compilation.20question/near/202712165">source</a>). |
| For example, when working on <code>rustc_mir_build</code>, the <code>rustc_mir_build</code> and |
| <code>rustc_driver</code> crates take the most time to incrementally rebuild. |
| You could therefore set the following in the root <code>Cargo.toml</code>:</p> |
| <pre><code class="language-toml">[profile.release.package.rustc_mir_build] |
| opt-level = 0 |
| [profile.release.package.rustc_driver] |
| opt-level = 0 |
| </code></pre> |
| <h2 id="working-on-multiple-branches-at-the-same-time"><a class="header" href="#working-on-multiple-branches-at-the-same-time">Working on multiple branches at the same time</a></h2> |
| <p>Working on multiple branches in parallel can be a little annoying, since |
| building the compiler on one branch will cause the old build and the incremental |
| compilation cache to be overwritten. |
| One solution would be to have multiple |
| clones of the repository, but that would mean storing the Git metadata multiple |
| times, and having to update each clone individually.</p> |
| <p>Fortunately, Git has a better solution called <a href="https://git-scm.com/docs/git-worktree">worktrees</a>. |
| This lets you create multiple “working trees”, which all share the same Git database. |
| Moreover, |
| because all of the worktrees share the same object database, if you update a |
| branch (e.g. <code>main</code>) in any of them, you can use the new commits from any of the |
| worktrees. |
| One caveat, though, is that submodules do not get shared. |
| They will still be cloned multiple times.</p> |
| <p>Given you are inside the root directory for your Rust repository, you can create |
| a “linked working tree” in a new “rust2” directory by running the following command:</p> |
| <pre><code class="language-bash">git worktree add ../rust2 |
| </code></pre> |
| <p>Creating a new worktree for a new branch based on <code>main</code> looks like:</p> |
| <pre><code class="language-bash">git worktree add -b my-feature ../rust2 main |
| </code></pre> |
| <p>You can then use that rust2 folder as a separate workspace for modifying and building <code>rustc</code>!</p> |
| <h2 id="working-with-nix"><a class="header" href="#working-with-nix">Working with nix</a></h2> |
| <p>Several nix configurations are defined in <code>src/tools/nix-dev-shell</code>.</p> |
| <p>If you’re using direnv, you can create a symbolic link to <code>src/tools/nix-dev-shell/envrc-flake</code> or <code>src/tools/nix-dev-shell/envrc-shell</code></p> |
| <pre><code class="language-bash">ln -s ./src/tools/nix-dev-shell/envrc-flake ./.envrc # Use flake |
| </code></pre> |
| <p>or</p> |
| <pre><code class="language-bash">ln -s ./src/tools/nix-dev-shell/envrc-shell ./.envrc # Use nix-shell |
| </code></pre> |
| <p>If you’re using the flake, make sure to also update it with the following command:</p> |
| <pre><code>nix flake update --flake ./src/tools/nix-dev-shell |
| </code></pre> |
| <p>The shell creates a command named <code>x</code> that runs the <code>./x.py</code> script with all dependencies |
| set up correctly.</p> |
| <h3 id="note"><a class="header" href="#note">Note</a></h3> |
| <p>Note that when using nix on a not-NixOS distribution, it may be necessary to set |
| <strong><code>build.patch-binaries-for-nix = true</code> in <code>bootstrap.toml</code></strong>. Bootstrap tries to detect |
| whether it’s running in nix and enable patching automatically, but this |
| detection can have false negatives.</p> |
| <p>You can also use your nix shell to manage <code>bootstrap.toml</code>:</p> |
| <pre><code class="language-nix">let |
| config = pkgs.writeText "rustc-config" '' |
| # Your bootstrap.toml content goes here |
| '' |
| pkgs.mkShell { |
| /* ... */ |
| # This environment variable tells bootstrap where our bootstrap.toml is. |
| RUST_BOOTSTRAP_CONFIG = config; |
| } |
| </code></pre> |
| <h2 id="shell-completions"><a class="header" href="#shell-completions">Shell Completions</a></h2> |
| <p>If you use Bash, Zsh, Fish or PowerShell, you can find automatically-generated shell |
| completion scripts for <code>./x</code> in |
| <a href="https://github.com/rust-lang/rust/tree/HEAD/src/etc/completions"><code>src/etc/completions</code></a>.</p> |
| <p>You can use <code>source ./src/etc/completions/x.<extension></code> to load completions |
| for your shell of choice, or <code>& .\src\etc\completions\x.ps1</code> for PowerShell. |
| Adding this to your shell’s startup script (e.g. <code>.bashrc</code>) will automatically |
| load this completion.</p> |
| |
| </main> |
| |
| <nav class="nav-wrapper" aria-label="Page navigation"> |
| <!-- Mobile navigation buttons --> |
| <a rel="prev" href="../building/prerequisites.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left"> |
| <span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 320 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M41.4 233.4c-12.5 12.5-12.5 32.8 0 45.3l160 160c12.5 12.5 32.8 12.5 45.3 0s12.5-32.8 0-45.3L109.3 256 246.6 118.6c12.5-12.5 12.5-32.8 0-45.3s-32.8-12.5-45.3 0l-160 160z"/></svg></span> |
| </a> |
| |
| <a rel="next prefetch" href="../building/build-install-distribution-artifacts.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right"> |
| <span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 320 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M278.6 233.4c12.5 12.5 12.5 32.8 0 45.3l-160 160c-12.5 12.5-32.8 12.5-45.3 0s-12.5-32.8 0-45.3L210.7 256 73.4 118.6c-12.5-12.5-12.5-32.8 0-45.3s32.8-12.5 45.3 0l160 160z"/></svg></span> |
| </a> |
| |
| <div style="clear: both"></div> |
| </nav> |
| </div> |
| </div> |
| |
| <nav class="nav-wide-wrapper" aria-label="Page navigation"> |
| <a rel="prev" href="../building/prerequisites.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left"> |
| <span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 320 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M41.4 233.4c-12.5 12.5-12.5 32.8 0 45.3l160 160c12.5 12.5 32.8 12.5 45.3 0s12.5-32.8 0-45.3L109.3 256 246.6 118.6c12.5-12.5 12.5-32.8 0-45.3s-32.8-12.5-45.3 0l-160 160z"/></svg></span> |
| </a> |
| |
| <a rel="next prefetch" href="../building/build-install-distribution-artifacts.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right"> |
| <span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 320 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M278.6 233.4c12.5 12.5 12.5 32.8 0 45.3l-160 160c-12.5 12.5-32.8 12.5-45.3 0s-12.5-32.8 0-45.3L210.7 256 73.4 118.6c-12.5-12.5-12.5-32.8 0-45.3s32.8-12.5 45.3 0l160 160z"/></svg></span> |
| </a> |
| </nav> |
| |
| </div> |
| |
| <template id=fa-eye><span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M288 32c-80.8 0-145.5 36.8-192.6 80.6C48.6 156 17.3 208 2.5 243.7c-3.3 7.9-3.3 16.7 0 24.6C17.3 304 48.6 356 95.4 399.4C142.5 443.2 207.2 480 288 480s145.5-36.8 192.6-80.6c46.8-43.5 78.1-95.4 93-131.1c3.3-7.9 3.3-16.7 0-24.6c-14.9-35.7-46.2-87.7-93-131.1C433.5 68.8 368.8 32 288 32zM432 256c0 79.5-64.5 144-144 144s-144-64.5-144-144s64.5-144 144-144s144 64.5 144 144zM288 192c0 35.3-28.7 64-64 64c-11.5 0-22.3-3-31.6-8.4c-.2 2.8-.4 5.5-.4 8.4c0 53 43 96 96 96s96-43 96-96s-43-96-96-96c-2.8 0-5.6 .1-8.4 .4c5.3 9.3 8.4 20.1 8.4 31.6z"/></svg></span></template> |
| <template id=fa-eye-slash><span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M38.8 5.1C28.4-3.1 13.3-1.2 5.1 9.2S-1.2 34.7 9.2 42.9l592 464c10.4 8.2 25.5 6.3 33.7-4.1s6.3-25.5-4.1-33.7L525.6 386.7c39.6-40.6 66.4-86.1 79.9-118.4c3.3-7.9 3.3-16.7 0-24.6c-14.9-35.7-46.2-87.7-93-131.1C465.5 68.8 400.8 32 320 32c-68.2 0-125 26.3-169.3 60.8L38.8 5.1zM223.1 149.5C248.6 126.2 282.7 112 320 112c79.5 0 144 64.5 144 144c0 24.9-6.3 48.3-17.4 68.7L408 294.5c5.2-11.8 8-24.8 8-38.5c0-53-43-96-96-96c-2.8 0-5.6 .1-8.4 .4c5.3 9.3 8.4 20.1 8.4 31.6c0 10.2-2.4 19.8-6.6 28.3l-90.3-70.8zm223.1 298L373 389.9c-16.4 6.5-34.3 10.1-53 10.1c-79.5 0-144-64.5-144-144c0-6.9 .5-13.6 1.4-20.2L83.1 161.5C60.3 191.2 44 220.8 34.5 243.7c-3.3 7.9-3.3 16.7 0 24.6c14.9 35.7 46.2 87.7 93 131.1C174.5 443.2 239.2 480 320 480c47.8 0 89.9-12.9 126.2-32.5z"/></svg></span></template> |
| <template id=fa-copy><span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M502.6 70.63l-61.25-61.25C435.4 3.371 427.2 0 418.7 0H255.1c-35.35 0-64 28.66-64 64l.0195 256C192 355.4 220.7 384 256 384h192c35.2 0 64-28.8 64-64V93.25C512 84.77 508.6 76.63 502.6 70.63zM464 320c0 8.836-7.164 16-16 16H255.1c-8.838 0-16-7.164-16-16L239.1 64.13c0-8.836 7.164-16 16-16h128L384 96c0 17.67 14.33 32 32 32h47.1V320zM272 448c0 8.836-7.164 16-16 16H63.1c-8.838 0-16-7.164-16-16L47.98 192.1c0-8.836 7.164-16 16-16H160V128H63.99c-35.35 0-64 28.65-64 64l.0098 256C.002 483.3 28.66 512 64 512h192c35.2 0 64-28.8 64-64v-32h-47.1L272 448z"/></svg></span></template> |
| <template id=fa-play><span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 384 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M73 39c-14.8-9.1-33.4-9.4-48.5-.9S0 62.6 0 80V432c0 17.4 9.4 33.4 24.5 41.9s33.7 8.1 48.5-.9L361 297c14.3-8.7 23-24.2 23-41s-8.7-32.2-23-41L73 39z"/></svg></span></template> |
| <template id=fa-clock-rotate-left><span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M75 75L41 41C25.9 25.9 0 36.6 0 57.9V168c0 13.3 10.7 24 24 24H134.1c21.4 0 32.1-25.9 17-41l-30.8-30.8C155 85.5 203 64 256 64c106 0 192 86 192 192s-86 192-192 192c-40.8 0-78.6-12.7-109.7-34.4c-14.5-10.1-34.4-6.6-44.6 7.9s-6.6 34.4 7.9 44.6C151.2 495 201.7 512 256 512c141.4 0 256-114.6 256-256S397.4 0 256 0C185.3 0 121.3 28.7 75 75zm181 53c-13.3 0-24 10.7-24 24V256c0 6.4 2.5 12.5 7 17l72 72c9.4 9.4 24.6 9.4 33.9 0s9.4-24.6 0-33.9l-65-65V152c0-13.3-10.7-24-24-24z"/></svg></span></template> |
| |
| |
| |
| <script> |
| window.playground_copyable = true; |
| </script> |
| |
| |
| <script src="../elasticlunr-ef4e11c1.min.js"></script> |
| <script src="../mark-09e88c2c.min.js"></script> |
| <script src="../searcher-09f2665d.js"></script> |
| |
| <script src="../clipboard-1626706a.min.js"></script> |
| <script src="../highlight-abc7f01d.js"></script> |
| <script src="../book-609e4cb8.js"></script> |
| |
| <!-- Custom JS scripts --> |
| <script src="../mermaid-cc85ecea.min.js"></script> |
| <script src="../mermaid-init-4533fb11.js"></script> |
| |
| |
| |
| </div> |
| </body> |
| </html> |
