Skip to content

Commit c669411

Browse files
committed
auto merge of #17402 : steveklabnik/rust/update_manual, r=brson
Because I'm still 😷 😷 😷 , I figured some mindless tasks would be better than trying to finish the ownership guide. The manual has long been waiting for some ❤️ ❤️ ❤️ , and so I gave it a quick once-over. I made small commits in case any of the changes are a bit weird, I mostly did a few things: 1. changed 'manual' to 'reference.' I feel like this name is better. If it's not, It's not a huge deal. it shouldn't be `rust.md` though. 2. word wrapped everything appropriately. Changes 1&2 are in the first commit, so that its' easier to see the changes in the later ones. 3. fixed other small style issues 4. removed references to things that are in the standard library, and not the language itself There's still lots of gross in here, but I didn't want to pile on too too many changes. /cc @brson @nikomatsakis
2 parents 7fbbfe6 + c765178 commit c669411

File tree

7 files changed

+4298
-4422
lines changed

7 files changed

+4298
-4422
lines changed

mk/docs.mk

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,9 @@ DOCS := index intro tutorial guide guide-ffi guide-macros guide-lifetimes \
2929
guide-tasks guide-container guide-pointers guide-testing \
3030
guide-runtime complement-bugreport \
3131
complement-lang-faq complement-design-faq complement-project-faq rust \
32-
rustdoc guide-unsafe guide-strings
32+
rustdoc guide-unsafe guide-strings reference
3333

34-
PDF_DOCS := guide rust
34+
PDF_DOCS := guide reference
3535

3636
RUSTDOC_DEPS_rust := doc/full-toc.inc
3737
RUSTDOC_FLAGS_rust := --html-in-header=doc/full-toc.inc

src/doc/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ To generate an HTML version of a doc from Markdown manually, you can do
3030
something like:
3131

3232
~~~~
33-
pandoc --from=markdown --to=html5 --number-sections -o rust.html rust.md
33+
pandoc --from=markdown --to=html5 --number-sections -o reference.html reference.md
3434
~~~~
3535

3636
(rust.md being the Rust Reference Manual.)

src/doc/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ development of Rust itself is discussed.
4646
# Specification
4747

4848
Rust does not have an exact specification, but an effort to describe as much of
49-
the language in as much detail as possible is in [the manual](rust.html).
49+
the language in as much detail as possible is in [the reference](reference.html).
5050

5151
# Guides
5252

src/doc/not_found.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Some things that might be helpful to you though:
1313

1414
## Reference
1515
* [The Rust official site](http://rust-lang.org)
16-
* [The Rust reference manual](http://doc.rust-lang.org/rust.html) (* [PDF](http://doc.rust-lang.org/rust.pdf))
16+
* [The Rust reference](http://doc.rust-lang.org/reference.html) (* [PDF](http://doc.rust-lang.org/reference.pdf))
1717

1818
## Docs
1919
* [The standard library](http://doc.rust-lang.org/std/)

0 commit comments

Comments
 (0)