Skip to content

Commit 08954ca

Browse files
committed
update original text: #a203290
1 parent 16328ad commit 08954ca

File tree

241 files changed

+35836
-506
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

241 files changed

+35836
-506
lines changed

CONTRIBUTING.md

+25-82
Original file line numberDiff line numberDiff line change
@@ -1,99 +1,42 @@
11
# Contributing
22

3-
## First edition
3+
We'd love your help! Thanks for caring about the book.
44

5-
The first edition of the book is no longer actively being worked on, since
6-
we're concentrating our efforts on bringing the second edition to print. We
7-
will accept pull requests for small tweaks to the first edition; any larger
8-
work should be spent improving the second edition. Issues will likely be closed
9-
unless they are also issues in the second edition.
5+
## Licensing
106

11-
## Second edition
7+
This repository is under the same license as Rust itself, MIT/Apache2. You
8+
can find the full text of each license in the `LICENSE-*` files in this
9+
repository.
1210

13-
We're currently working with No Starch Press to bring the second edition of the
14-
book to print. Each chapter goes through [a number of stages][project]:
11+
## Code of Conduct
1512

16-
[project]: https://github.com/rust-lang/book/projects/1
13+
The Rust project has [a code of conduct](http://rust-lang.org/policies/code-of-conduct)
14+
that governs all sub-projects, including this one. Please respect it!
1715

18-
* We write and edit a chapter's initial content
19-
* No Starch provides a round of edits and questions
20-
* We revise, clarify, and check those edits
21-
* A Technical Reviewer checks for the accuracy of technical details
22-
* No Starch copyedits the chapter for spelling, grammar, wording, consistency
23-
* We revise, clarify, and check the copyedits
24-
* The chapter goes to layout, at which point only minor changes should be made
16+
## Review
2517

26-
### Documenting newly stabilized features
27-
28-
New features added to Rust will be documented in the ["Newest Features"
29-
Appendix][new] per [RFC 1636][rfc]. We'd love pull requests adding new
30-
sections! These sections may be incorporated into the book at some point, but
31-
we have no timeline for doing so; see the Post-publication section below for
32-
more details.
33-
34-
[new]: https://github.com/rust-lang/book/blob/master/second-edition/src/appendix-07-newest-features.md
35-
[rfc]: https://github.com/rust-lang/rfcs/pull/1636#issuecomment-247325313
36-
37-
### Corrections and Modifications
38-
39-
We would love issues and pull requests to the Markdown files in the src
40-
directory, up until the chapter goes to layout with No Starch. At that point,
41-
we will likely only be accepting changes that correct factual errors or major
42-
problems and not, for example, minor wording changes.
43-
44-
You can check which chapters have gone to layout and are frozen on the [project
45-
page][project] by scrolling all the way to the right to find the column titled
46-
**Frozen**.
47-
48-
### Review
49-
50-
Our [open pull requests][pulls] are new chapters or edits that we're currently
51-
working on. We would love if you would read through those and make comments for
52-
any suggestions or corrections!
18+
Our [open pull requests][pulls] are new chapters or edits that we're
19+
currently working on. We would love if you would read through those and make
20+
comments for any suggestions or corrections!
5321

5422
[pulls]: https://github.com/rust-lang/book/pulls
5523

56-
### Translations
24+
## Help wanted
5725

58-
We'd especially love help translating the second edition of the book! See the
59-
[Translations] label to join in efforts that are currently in progress. Open
60-
a new issue to start working on a new language! We're waiting on [mdbook
61-
support] for multiple languages before we merge any in, but feel free to
62-
start! The chapters in [the frozen column] of the project won't see major
63-
changes, so if you start with those, you won't have to redo work :)
64-
65-
[Translations]: https://github.com/rust-lang/book/issues?q=is%3Aopen+is%3Aissue+label%3ATranslations
66-
[mdbook support]: https://github.com/azerupi/mdBook/issues/5
67-
[the frozen column]: https://github.com/rust-lang/book/projects/1
68-
69-
### Help wanted
70-
71-
If you're looking for ways to help that don't involve large amounts of reading
72-
or writing, check out the [open issues with the E-help-wanted
73-
label][help-wanted]. These might be small fixes to the text Rust code, frontend
74-
code, or shell scripts that would help us be more efficient or enhance the book
75-
in some way!
26+
If you're looking for ways to help that don't involve large amounts of
27+
reading or writing, check out the [open issues with the E-help-wanted
28+
label][help-wanted]. These might be small fixes to the text Rust code,
29+
frontend code, or shell scripts that would help us be more efficient or
30+
enhance the book in some way!
7631

7732
[help-wanted]: https://github.com/rust-lang/book/issues?q=is%3Aopen+is%3Aissue+label%3AE-help-wanted
7833

79-
### Post-publication
80-
81-
After the second edition of the book goes to print, here are our intentions for
82-
changes:
34+
## Translations
8335

84-
* The online version should stay fairly close to the printed version. For
85-
example, you should be able to look at listing 10-3 in the book and find
86-
listing 10-3 in the online version and copy-paste the code if you want to
87-
play with it. Major changes to correct errors should get documented in
88-
errata.
89-
* There are multiple efforts starting to translate the online book into
90-
other languages. It would help the translations stay in sync if we're not
91-
constantly changing the text.
92-
* Someday there might be a third edition, once there are enough large, new
93-
features in Rust to warrant such a thing. We don't have any schedule in mind
94-
for that though, nor have we decided if it would be modifications to the
95-
second edition or a ground-up rewrite. Until we have plans for that, we won't
96-
be accepting pull requests that aren't fixing errors, for example, changing
97-
the way something is worded.
36+
We'd love help translating the book! See the [Translations] label to join in
37+
efforts that are currently in progress. Open a new issue to start working on
38+
a new language! We're waiting on [mdbook support] for multiple languages
39+
before we merge any in, but feel free to start!
9840

99-
This repository is under the same license as Rust itself, MIT/Apache2.
41+
[Translations]: https://github.com/rust-lang/book/issues?q=is%3Aopen+is%3Aissue+label%3ATranslations
42+
[mdbook support]: https://github.com/azerupi/mdBook/issues/5

Cargo.lock

+142
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
[package]
2+
name = "rust-book"
3+
version = "0.0.1"
4+
authors = ["Steve Klabnik <[email protected]>"]
5+
description = "The Rust Book"
6+
edition = "2018"
7+
8+
[[bin]]
9+
name = "concat_chapters"
10+
path = "tools/src/bin/concat_chapters.rs"
11+
12+
[[bin]]
13+
name = "lfp"
14+
path = "tools/src/bin/lfp.rs"
15+
16+
[[bin]]
17+
name = "link2print"
18+
path = "tools/src/bin/link2print.rs"
19+
20+
[[bin]]
21+
name = "remove_links"
22+
path = "tools/src/bin/remove_links.rs"
23+
24+
[[bin]]
25+
name = "remove_markup"
26+
path = "tools/src/bin/remove_markup.rs"
27+
28+
[[bin]]
29+
name = "convert_quotes"
30+
path = "tools/src/bin/convert_quotes.rs"
31+
32+
[dependencies]
33+
walkdir = "0.1.5"
34+
docopt = "0.6.82"
35+
rustc-serialize = "0.3.19"
36+
regex = "0.1.73"
37+
lazy_static = "0.2.1"

book.toml

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
[book]
2+
title = "The Rust Programming Language"
3+
author = "Steve Klabnik and Carol Nichols, with Contributions from the Rust Community"
4+
5+
[output.html]
6+
additional-css = ["ferris.css", "theme/2018-edition.css"]
7+
additional-js = ["ferris.js"]

ci/build.sh

+8-16
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,21 @@
1-
# Copyright 2016 The Rust Project Developers. See the COPYRIGHT
2-
# file at the top-level directory of this distribution and at
3-
# http://rust-lang.org/COPYRIGHT.
4-
#
5-
# Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6-
# http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7-
# <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8-
# option. This file may not be copied, modified, or distributed
9-
# except according to those terms.
1+
#!/bin/bash
102

113
set -e
124

135
export PATH=$PATH:/home/travis/.cargo/bin;
146

15-
# feature check
7+
# Feature check
168
cd ci/stable-check
179

18-
cargo run -- ../../first-edition/src
19-
cargo run -- ../../second-edition/src
10+
cargo run -- ../../src
2011

2112
cd ../..
2213

23-
# tests for the second edition
24-
25-
cd second-edition
26-
bash spellcheck.sh list
14+
echo 'Spellchecking...'
15+
bash ci/spellcheck.sh list
16+
echo 'Testing...'
2717
mdbook test
18+
echo 'Building...'
2819
mdbook build
20+
echo 'Linting for local file paths...'
2921
cargo run --bin lfp src

0 commit comments

Comments
 (0)