| <!DOCTYPE HTML> |
| <html lang="en" class="light sidebar-visible" dir="ltr"> |
| <head> |
| <!-- Book generated using mdBook --> |
| <meta charset="UTF-8"> |
| <title>Documentation - Cargo Contributor Guide</title> |
| |
| |
| <!-- Custom HTML head --> |
| |
| <meta name="description" content=""> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta name="theme-color" content="#ffffff"> |
| |
| <link rel="icon" href="../favicon.svg"> |
| <link rel="shortcut icon" href="../favicon.png"> |
| <link rel="stylesheet" href="../css/variables.css"> |
| <link rel="stylesheet" href="../css/general.css"> |
| <link rel="stylesheet" href="../css/chrome.css"> |
| <link rel="stylesheet" href="../css/print.css" media="print"> |
| |
| <!-- Fonts --> |
| <link rel="stylesheet" href="../FontAwesome/css/font-awesome.css"> |
| <link rel="stylesheet" href="../fonts/fonts.css"> |
| |
| <!-- Highlight.js Stylesheets --> |
| <link rel="stylesheet" id="highlight-css" href="../highlight.css"> |
| <link rel="stylesheet" id="tomorrow-night-css" href="../tomorrow-night.css"> |
| <link rel="stylesheet" id="ayu-highlight-css" href="../ayu-highlight.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.js"; |
| </script> |
| <!-- Start loading toc.js asap --> |
| <script src="../toc.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="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="sidebar-toggle-anchor" class="hidden"> |
| |
| <!-- Hide / unhide sidebar before it is displayed --> |
| <script> |
| let sidebar = null; |
| const sidebar_toggle = document.getElementById("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="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="sidebar-resize-handle" class="sidebar-resize-handle"> |
| <div class="sidebar-resize-indicator"></div> |
| </div> |
| </nav> |
| |
| <div id="page-wrapper" class="page-wrapper"> |
| |
| <div class="page"> |
| <div id="menu-bar-hover-placeholder"></div> |
| <div id="menu-bar" class="menu-bar sticky"> |
| <div class="left-buttons"> |
| <label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar"> |
| <i class="fa fa-bars"></i> |
| </label> |
| <button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list"> |
| <i class="fa fa-paint-brush"></i> |
| </button> |
| <ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu"> |
| <li role="none"><button role="menuitem" class="theme" id="default_theme">Auto</button></li> |
| <li role="none"><button role="menuitem" class="theme" id="light">Light</button></li> |
| <li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li> |
| <li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li> |
| <li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li> |
| <li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li> |
| </ul> |
| <button id="search-toggle" class="icon-button" type="button" title="Search (`/`)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="/ s" aria-controls="searchbar"> |
| <i class="fa fa-search"></i> |
| </button> |
| </div> |
| |
| <h1 class="menu-title">Cargo Contributor Guide</h1> |
| |
| <div class="right-buttons"> |
| <a href="../print.html" title="Print this book" aria-label="Print this book"> |
| <i id="print-button" class="fa fa-print"></i> |
| </a> |
| <a href="https://github.com/rust-lang/cargo/tree/master/src/doc/contrib/src" title="Git repository" aria-label="Git repository"> |
| <i id="git-repository-button" class="fa fa-github"></i> |
| </a> |
| <a href="https://github.com/rust-lang/cargo/edit/master/src/doc/contrib/src/documentation/index.md" title="Suggest an edit" aria-label="Suggest an edit" rel="edit"> |
| <i id="git-edit-button" class="fa fa-edit"></i> |
| </a> |
| |
| </div> |
| </div> |
| |
| <div id="search-wrapper" class="hidden"> |
| <form id="searchbar-outer" class="searchbar-outer"> |
| <div class="search-wrapper"> |
| <input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header"> |
| <div class="spinner-wrapper"> |
| <i class="fa fa-spinner fa-spin"></i> |
| </div> |
| </div> |
| </form> |
| <div id="searchresults-outer" class="searchresults-outer hidden"> |
| <div id="searchresults-header" class="searchresults-header"></div> |
| <ul id="searchresults"> |
| </ul> |
| </div> |
| </div> |
| |
| <!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM --> |
| <script> |
| document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible'); |
| document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible'); |
| Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) { |
| link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1); |
| }); |
| </script> |
| |
| <div id="content" class="content"> |
| <main> |
| <h1 id="documentation"><a class="header" href="#documentation">Documentation</a></h1> |
| <p>Cargo has several types of documentation that contributors work with:</p> |
| <ul> |
| <li><a href="https://doc.rust-lang.org/cargo/">The Cargo Book</a> |
| <ul> |
| <li>The primary user-facing Cargo documentation</li> |
| <li>Source at <a href="https://github.com/rust-lang/cargo/tree/master/src/doc">https://github.com/rust-lang/cargo/tree/master/src/doc</a></li> |
| <li>Built with <a href="https://github.com/rust-lang/mdBook">mdbook</a></li> |
| <li>Published through <a href="../process/release.html#docs-publishing">“the doc publishing process”</a></li> |
| </ul> |
| </li> |
| <li>Man pages |
| <ul> |
| <li>Man pages of the <code>cargo</code> command</li> |
| <li>Built with <a href="https://github.com/rust-lang/cargo/tree/master/crates/mdman/">mdman</a></li> |
| <li>Published through <a href="../process/release.html#docs-publishing">“the doc publishing process”</a></li> |
| </ul> |
| </li> |
| <li><a href="https://rust-lang.github.io/cargo/contrib">Contributor guide</a> |
| <ul> |
| <li>This guide itself</li> |
| <li>Source at <a href="https://github.com/rust-lang/cargo/tree/master/src/doc/contrib">https://github.com/rust-lang/cargo/tree/master/src/doc/contrib</a></li> |
| <li>Published independently on GitHub Pages at |
| <a href="https://rust-lang.github.io/cargo/contrib">https://rust-lang.github.io/cargo/contrib</a> |
| when committing to the master branch.</li> |
| </ul> |
| </li> |
| </ul> |
| <h2 id="building-the-book"><a class="header" href="#building-the-book">Building the book</a></h2> |
| <p>Building the book requires <a href="https://github.com/rust-lang/mdBook">mdBook</a>. To get it:</p> |
| <pre><code class="language-console">$ cargo install mdbook |
| </code></pre> |
| <p>To build the book:</p> |
| <pre><code class="language-console">$ mdbook build |
| </code></pre> |
| <p><code>mdbook</code> provides a variety of different commands and options to help you work |
| on the book:</p> |
| <ul> |
| <li><code>mdbook build --open</code>: Build the book and open it in a web browser.</li> |
| <li><code>mdbook serve</code>: Launches a web server on localhost. It also automatically |
| rebuilds the book whenever any file changes and automatically reloads your |
| web browser.</li> |
| </ul> |
| <p>The book contents are driven by a <code>SUMMARY.md</code> file, |
| and every file must be linked there. |
| See <a href="https://rust-lang.github.io/mdBook/">https://rust-lang.github.io/mdBook/</a> for its usage.</p> |
| <h2 id="building-the-man-pages"><a class="header" href="#building-the-man-pages">Building the man pages</a></h2> |
| <p>The man pages use a tool called <a href="https://github.com/rust-lang/cargo/tree/master/crates/mdman/">mdman</a> to convert Markdown templates into several output formats. |
| See <a href="https://github.com/rust-lang/cargo/tree/master/crates/mdman/doc">https://github.com/rust-lang/cargo/tree/master/crates/mdman/doc</a> |
| for usage details and template syntax.</p> |
| <p>The templates are located in |
| <a href="https://github.com/rust-lang/cargo/tree/master/src/doc/man">https://github.com/rust-lang/cargo/tree/master/src/doc/man</a> |
| and are converted into three formats:</p> |
| <ol> |
| <li>Troff man pages — used by the <code>cargo help</code> command, |
| and by distributions to provide man pages which people can install, |
| saved in <a href="https://github.com/rust-lang/cargo/tree/master/src/etc/man">https://github.com/rust-lang/cargo/tree/master/src/etc/man</a>.</li> |
| <li>Plain text — used for embedded help on platforms without <code>man</code> (such as Windows), |
| saved in <a href="https://github.com/rust-lang/cargo/tree/master/src/doc/man/generated_txt">https://github.com/rust-lang/cargo/tree/master/src/doc/man/generated_txt</a>.</li> |
| <li>Markdown (with some HTML) — used for the Cargo Book, |
| saved in <a href="https://github.com/rust-lang/cargo/tree/master/src/doc/src/commands">https://github.com/rust-lang/cargo/tree/master/src/doc/src/commands</a>.</li> |
| </ol> |
| <p>To rebuild the man pages, run <code>cargo build-man</code> inside the workspace.</p> |
| <h2 id="writing-guidelines"><a class="header" href="#writing-guidelines">Writing guidelines</a></h2> |
| <p>Cargo’s documentation is a collective effort, |
| so there isn’t a single fixed writing style. |
| We recommend following the style of the surrounding text to keep things consistent.</p> |
| <p>A few important guidelines:</p> |
| <ul> |
| <li>The <a href="https://doc.rust-lang.org/nightly/cargo/commands/index.html">Cargo Commands</a> |
| chapters in the book are generated from man page templates. |
| To update them, see the <a href="#building-the-man-pages">Building the man pages</a> section. |
| Do not edit the generated Markdown files directly.</li> |
| <li>Links to pages under <a href="https://doc.rust-lang.org/">https://doc.rust-lang.org/</a> should use relative paths. |
| This ensures versioned docs are redirected correctly. |
| For example, if you are at <a href="https://doc.rust-lang.org/cargo/reference/config.html">https://doc.rust-lang.org/cargo/reference/config.html</a> |
| and want to link to <a href="https://doc.rust-lang.org/rustc/codegen-options/index.html">https://doc.rust-lang.org/rustc/codegen-options/index.html</a>, |
| you should write the link as <code>../../rustc/codegen-options/index.html</code>. |
| This rule doesn’t apply if you specifically want to link to docs of a fixed version or channel.</li> |
| <li>When renaming or removing any headings or pages, |
| make sure to set up proper redirects via the [<code>output.html.redirect</code>] mdbook option.</li> |
| <li>If a section refers to a concept explained elsewhere |
| (like profiles, features, or workspaces), link to it. |
| That keeps the book navigable without duplicating content.</li> |
| </ul> |
| <p>[[<code>output.html.redirect</code>]]: https://rust-lang.github.io/mdBook/format/configuration/renderers.html#outputhtmlredirect</p> |
| <h2 id="semver-chapter-tests"><a class="header" href="#semver-chapter-tests">SemVer chapter tests</a></h2> |
| <p>There is a script to verify that the examples in <a href="https://doc.rust-lang.org/nightly/cargo/reference/semver.html">the SemVer chapter</a> work as |
| intended. To run the tests, run <code>cargo +stable run -p semver-check</code>.</p> |
| <p>Note that these tests run on the most recent stable release because they |
| validate the output of the compiler diagnostics. The output can change between |
| releases, so we pin to a specific release to avoid frequent and unexpected |
| breakage.</p> |
| |
| </main> |
| |
| <nav class="nav-wrapper" aria-label="Page navigation"> |
| <!-- Mobile navigation buttons --> |
| <a rel="prev" href="../tests/crater.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left"> |
| <i class="fa fa-angle-left"></i> |
| </a> |
| |
| |
| <div style="clear: both"></div> |
| </nav> |
| </div> |
| </div> |
| |
| <nav class="nav-wide-wrapper" aria-label="Page navigation"> |
| <a rel="prev" href="../tests/crater.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left"> |
| <i class="fa fa-angle-left"></i> |
| </a> |
| |
| </nav> |
| |
| </div> |
| |
| |
| |
| |
| <script> |
| window.playground_copyable = true; |
| </script> |
| |
| |
| <script src="../elasticlunr.min.js"></script> |
| <script src="../mark.min.js"></script> |
| <script src="../searcher.js"></script> |
| |
| <script src="../clipboard.min.js"></script> |
| <script src="../highlight.js"></script> |
| <script src="../book.js"></script> |
| |
| <!-- Custom JS scripts --> |
| |
| |
| |
| </div> |
| </body> |
| </html> |
