Skip to content

Commit 61d8fe0

Browse files
committed
---
yaml --- r: 130969 b: refs/heads/auto c: 5b3c351 h: refs/heads/master i: 130967: 8dd0d2c v: v3
1 parent 6bb1e7c commit 61d8fe0

File tree

13 files changed

+3447
-141
lines changed

13 files changed

+3447
-141
lines changed

[refs]

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ refs/heads/try3: 9387340aab40a73e8424c48fd42f0c521a4875c0
1313
refs/tags/release-0.3.1: 495bae036dfe5ec6ceafd3312b4dca48741e845b
1414
refs/tags/release-0.4: e828ea2080499553b97dfe33b3f4d472b4562ad7
1515
refs/tags/release-0.5: 7e3bcfbf21278251ee936ad53e92e9b719702d73
16-
refs/heads/auto: 805cf81b778f7b0d17a4afa3af93f975d5351307
16+
refs/heads/auto: 5b3c3511c9f69c047a5eb804c91f984d83779c83
1717
refs/heads/servo: af82457af293e2a842ba6b7759b70288da276167
1818
refs/tags/release-0.6: b4ebcfa1812664df5e142f0134a5faea3918544c
1919
refs/tags/0.1: b19db808c2793fe2976759b85a355c3ad8c8b336

branches/auto/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@ documentation.
66
## Quick Start
77

88
1. Download a [binary installer][installer] for your platform.
9-
2. Read the [guide].
9+
2. Read the [tutorial].
1010
3. Enjoy!
1111

1212
> ***Note:*** Windows users can read the detailed
1313
> [getting started][wiki-start] notes on the wiki.
1414
1515
[installer]: http://www.rust-lang.org/install.html
16-
[guide]: http://doc.rust-lang.org/guide.html
16+
[tutorial]: http://doc.rust-lang.org/tutorial.html
1717
[wiki-start]: https://github.com/rust-lang/rust/wiki/Note-getting-started-developing-Rust
1818
[win-wiki]: https://github.com/rust-lang/rust/wiki/Using-Rust-on-Windows
1919

@@ -54,7 +54,7 @@ documentation.
5454
When complete, `make install` will place several programs into
5555
`/usr/local/bin`: `rustc`, the Rust compiler, and `rustdoc`, the
5656
API-documentation tool.
57-
3. Read the [guide].
57+
3. Read the [tutorial].
5858
4. Enjoy!
5959

6060
### Building on Windows
@@ -76,7 +76,7 @@ To easily build on windows we can use [MSYS2](http://sourceforge.net/projects/ms
7676

7777
[repo]: https://github.com/rust-lang/rust
7878
[tarball]: https://static.rust-lang.org/dist/rust-nightly.tar.gz
79-
[guide]: http://doc.rust-lang.org/guide.html
79+
[tutorial]: http://doc.rust-lang.org/tutorial.html
8080

8181
## Notes
8282

branches/auto/mk/docs.mk

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@
99
# except according to those terms.
1010

1111
######################################################################
12-
# The various pieces of standalone documentation: guides, manual, etc
12+
# The various pieces of standalone documentation: guides, tutorial,
13+
# manual etc.
1314
#
1415
# The DOCS variable is their names (with no file extension).
1516
#
@@ -31,7 +32,7 @@ DOCS := index intro tutorial guide guide-ffi guide-macros guide-lifetimes \
3132
complement-lang-faq complement-design-faq complement-project-faq rust \
3233
rustdoc guide-unsafe guide-strings
3334

34-
PDF_DOCS := guide rust
35+
PDF_DOCS := tutorial rust
3536

3637
RUSTDOC_DEPS_rust := doc/full-toc.inc
3738
RUSTDOC_FLAGS_rust := --html-in-header=doc/full-toc.inc
@@ -225,7 +226,7 @@ $(foreach docname,$(DOCS),$(eval $(call DEF_DOC,$(docname))))
225226
#
226227
# As such, I've attempted to get it working as much as possible (and
227228
# switching from pandoc to rustdoc), but preserving the old behaviour
228-
# (e.g. only running on the guide)
229+
# (e.g. only running on the tutorial)
229230
.PHONY: l10n-mds
230231
l10n-mds: $(D)/po4a.conf \
231232
$(foreach lang,$(L10N_LANG),$(D)/po/$(lang)/*.md.po)
@@ -243,7 +244,7 @@ doc/l10n/$(1)/$(2).html: l10n-mds $$(HTML_DEPS) $$(RUSTDOC_DEPS_$(2))
243244
$$(RUSTDOC) $$(RUSTDOC_HTML_OPTS) $$(RUSTDOC_FLAGS_$(1)) doc/l10n/$(1)/$(2).md
244245
endef
245246

246-
$(foreach lang,$(L10N_LANGS),$(eval $(call DEF_L10N_DOC,$(lang),guide)))
247+
$(foreach lang,$(L10N_LANGS),$(eval $(call DEF_L10N_DOC,$(lang),tutorial)))
247248

248249

249250
######################################################################

branches/auto/src/doc/guide.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
% The Rust Guide
22

3+
<div style="border: 2px solid red; padding:5px;">
4+
This guide is a work in progress. Until it is ready, we highly recommend that
5+
you read the <a href="tutorial.html">Tutorial</a> instead. This work-in-progress Guide is being
6+
displayed here in line with Rust's open development policy. Please open any
7+
issues you find as usual.
8+
</div>
9+
10+
# Welcome!
11+
312
Hey there! Welcome to the Rust guide. This is the place to be if you'd like to
413
learn how to program in Rust. Rust is a systems programming language with a
514
focus on "high-level, bare-metal programming": the lowest level control a
@@ -110,7 +119,7 @@ The first thing that we need to do is make a file to put our code in. I like
110119
to make a `projects` directory in my home directory, and keep all my projects
111120
there. Rust does not care where your code lives.
112121

113-
This actually leads to one other concern we should address: this guide will
122+
This actually leads to one other concern we should address: this tutorial will
114123
assume that you have basic familiarity with the command line. Rust does not
115124
require that you know a whole ton about the command line, but until the
116125
language is in a more finished state, IDE support is spotty. Rust makes no
@@ -206,7 +215,7 @@ Finally, the line ends with a semicolon (`;`). Rust is an **expression
206215
oriented** language, which means that most things are expressions. The `;` is
207216
used to indicate that this expression is over, and the next one is ready to
208217
begin. Most lines of Rust code end with a `;`. We will cover this in-depth
209-
later in the guide.
218+
later in the tutorial.
210219

211220
Finally, actually **compiling** and **running** our program. We can compile
212221
with our compiler, `rustc`, by passing it the name of our source file:
@@ -2008,7 +2017,7 @@ Great! Next up: let's compare our guess to the secret guess.
20082017

20092018
## Comparing guesses
20102019

2011-
If you remember, earlier in the guide, we made a `cmp` function that compared
2020+
If you remember, earlier in the tutorial, we made a `cmp` function that compared
20122021
two numbers. Let's add that in, along with a `match` statement to compare the
20132022
guess to the secret guess:
20142023

branches/auto/src/doc/intro.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ Rust is a systems programming language that combines strong compile-time correct
44
It improves upon the ideas of other systems languages like C++
55
by providing guaranteed memory safety (no crashes, no data races) and complete control over the lifecycle of memory.
66
Strong memory guarantees make writing correct concurrent Rust code easier than in other languages.
7-
This introduction will give you an idea of what Rust is like in about thirty minutes.
7+
This tutorial will give you an idea of what Rust is like in about thirty minutes.
88
It expects that you're at least vaguely familiar with a previous 'curly brace' language,
99
but does not require prior experience with systems programming.
1010
The concepts are more important than the syntax,
1111
so don't worry if you don't get every last detail:
12-
the [guide](guide.html) can help you out with that later.
12+
the [tutorial](tutorial.html) can help you out with that later.
1313

1414
Let's talk about the most important concept in Rust, "ownership,"
1515
and its implications on a task that programmers usually find very difficult: concurrency.
@@ -433,5 +433,5 @@ yet get the efficiency of languages such as C++.
433433

434434
I hope that this taste of Rust has given you an idea if Rust is the right language for you.
435435
If that's true,
436-
I encourage you to check out [the guide](guide.html) for a full,
436+
I encourage you to check out [the tutorial](tutorial.html) for a full,
437437
in-depth exploration of Rust's syntax and concepts.

branches/auto/src/doc/po4a.conf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,4 +24,4 @@
2424
[type: text] src/doc/intro.md $lang:doc/l10n/$lang/intro.md
2525
[type: text] src/doc/rust.md $lang:doc/l10n/$lang/rust.md
2626
[type: text] src/doc/rustdoc.md $lang:doc/l10n/$lang/rustdoc.md
27-
[type: text] src/doc/guide.md $lang:doc/l10n/$lang/guide.md
27+
[type: text] src/doc/tutorial.md $lang:doc/l10n/$lang/tutorial.md

branches/auto/src/doc/rust.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,16 @@ provides three kinds of material:
1313
- Appendix chapters providing rationale and references to languages that
1414
influenced the design.
1515

16-
This document does not serve as an introduction to the
16+
This document does not serve as a tutorial introduction to the
1717
language. Background familiarity with the language is assumed. A separate
18-
[guide] is available to help acquire such background familiarity.
18+
[tutorial] document is available to help acquire such background familiarity.
1919

2020
This document also does not serve as a reference to the [standard]
2121
library included in the language distribution. Those libraries are
2222
documented separately by extracting documentation attributes from their
2323
source code.
2424

25-
[guide]: guide.html
25+
[tutorial]: tutorial.html
2626
[standard]: std/index.html
2727

2828
## Disclaimer
@@ -4175,7 +4175,7 @@ communication facilities.
41754175
The Rust compiler supports various methods to link crates together both
41764176
statically and dynamically. This section will explore the various methods to
41774177
link Rust crates together, and more information about native libraries can be
4178-
found in the [ffi guide][ffi].
4178+
found in the [ffi tutorial][ffi].
41794179

41804180
In one session of compilation, the compiler can generate multiple artifacts
41814181
through the usage of either command line flags or the `crate_type` attribute.

0 commit comments

Comments
 (0)