This repository contains the source of all editions of "the Rust Programming Language".
The second edition will also be available in dead-tree form by No Starch Press, available around June 2018. Check the No Starch Page for the latest information on the release date and how to order.
You can read all editions of the book for free online! Please see the book as shipped with the latest stable, beta, or nightly Rust releases. Be aware that issues in those versions may have been fixed in this repository already, as those releases are updated less frequently.
Building the book requires mdBook, ideally the same version that rust-lang/rust uses in this file. To get it:
$ cargo install mdbook --vers [version-num]To build the book, first cd into the directory of the edition of the
book you'd like to build. For example, the first-edition or
second-edition directory. Then type:
$ mdbook buildThe output will be in the book subdirectory. To check it out, open it in
your web browser.
Firefox:
$ firefox book/index.html # Linux
$ open -a "Firefox" book/index.html # OS X
$ Start-Process "firefox.exe" .\book\index.html # Windows (PowerShell)
$ start firefox.exe .\book\index.html # Windows (Cmd)Chrome:
$ google-chrome book/index.html # Linux
$ open -a "Google Chrome" book/index.html # OS X
$ Start-Process "chrome.exe" .\book\index.html # Windows (PowerShell)
$ start chrome.exe .\book\index.html # Windows (Cmd)To run the tests:
$ mdbook testWe'd love your help! Please see CONTRIBUTING.md to learn about the kinds of contributions we're looking for.
The "2018" Edition is in the process of being updated with the language changes that will be available with the 2018 Edition of the Rust language. All new contributions should be to this edition.
No Starch Press has brought the second edition to print. Pull requests fixing factual errors will be accepted and documented as errata; pull requests changing wording or other small corrections should be made against the 2018 edition instead.
The first edition is frozen, and is not accepting any changes at this time.
We'd especially love help translating the second edition or 2018 edition of the book! See the Translations label to join in efforts that are currently in progress. Open a new issue to start working on a new language! We're waiting on mdbook support for multiple languages before we merge any in, but feel free to start! The second edition is frozen and won't see major changes, so if you start with that, you won't have to redo work :)
As the second edition of the book will be published by No Starch, we first iterate here, then ship the text off to No Starch. Then they do editing, and we fold it back in.
As such, there’s a directory, nostarch, which corresponds to the text in No Starch’s system.
When we've started working with No Starch in a word doc, we will also check those into the repo in the nostarch/odt directory. To extract the text from the word doc as markdown in order to backport changes to the online book:
- Open the doc file in LibreOffice
- Accept all tracked changes
- Save as Microsoft Word 2007-2013 XML (.docx) in the tmp directory
- Run
./doc-to-md.sh - Inspect changes made to the markdown file in the nostarch directory and copy the changes to the src directory as appropriate.
We're using Graphviz for some of the diagrams in the
book. The source for those files live in the dot directory. To turn a dot
file, for example, dot/trpl04-01.dot into an svg, run:
$ dot dot/trpl04-01.dot -Tsvg > src/img/trpl04-01.svgIn the generated SVG, remove the width and the height attributes from the svg
element and set the viewBox attribute to 0.00 0.00 1000.00 1000.00 or other
values that don't cut off the image.
To scan source files for spelling errors, you can use the spellcheck.sh
script. It needs a dictionary of valid words, which is provided in
dictionary.txt. If the script produces a false positive (say, you used word
BTreeMap which the script considers invalid), you need to add this word to
dictionary.txt (keep the sorted order for consistency).
