Skip to content

Commit eeafee4

Browse files
committed
Convert sub tutorials into Guides #10838
Ensure configure creates doc/guides directory Fix configure makefile and tests Remove old guides dir and configure option, convert testing to guide Remove ignored files Fix submodule issue prepend dir in makefile so that bor knows how to build the docs S to uppercase
1 parent 4bca7fd commit eeafee4

12 files changed

+55
-51
lines changed

configure

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -792,12 +792,12 @@ do
792792
make_dir $h/test/debug-info
793793
make_dir $h/test/codegen
794794
make_dir $h/test/doc-tutorial
795-
make_dir $h/test/doc-tutorial-ffi
796-
make_dir $h/test/doc-tutorial-macros
797-
make_dir $h/test/doc-tutorial-borrowed-ptr
798-
make_dir $h/test/doc-tutorial-container
799-
make_dir $h/test/doc-tutorial-tasks
800-
make_dir $h/test/doc-tutorial-conditions
795+
make_dir $h/test/doc-guide-ffi
796+
make_dir $h/test/doc-guide-macros
797+
make_dir $h/test/doc-guide-borrowed-ptr
798+
make_dir $h/test/doc-guide-container
799+
make_dir $h/test/doc-guide-tasks
800+
make_dir $h/test/doc-guide-conditions
801801
make_dir $h/test/doc-rust
802802
done
803803

doc/tutorial-borrowed-ptr.md renamed to doc/guide-borrowed-ptr.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
% Rust Borrowed Pointers Tutorial
1+
% Rust Borrowed Pointers Guide
22

33
# Introduction
44

doc/tutorial-conditions.md renamed to doc/guide-conditions.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
% Rust Condition and Error-handling Tutorial
1+
% Rust Condition and Error-handling Guide
22

33
# Introduction
44

@@ -12,12 +12,12 @@ The four mechanisms are:
1212
- Failure
1313
- Conditions
1414

15-
This tutorial will lead you through use of these mechanisms
15+
This guide will lead you through use of these mechanisms
1616
in order to understand the trade-offs of each and relationships between them.
1717

1818
# Example program
1919

20-
This tutorial will be based around an example program
20+
This guide will be based around an example program
2121
that attempts to read lines from a file
2222
consisting of pairs of numbers,
2323
and then print them back out with slightly different formatting.
@@ -823,7 +823,7 @@ There are three other things to note in this variant of the example program:
823823

824824
# When to use which technique
825825

826-
This tutorial explored several techniques for handling errors.
826+
This guide explored several techniques for handling errors.
827827
Each is appropriate to different circumstances:
828828

829829
- If an error may be extremely frequent, expected, and very likely dealt with by an immediate caller,

doc/tutorial-container.md renamed to doc/guide-container.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
% Containers and iterators
1+
% Containers and Iterators Guide
22

33
# Containers
44

doc/tutorial-ffi.md renamed to doc/guide-ffi.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
% Rust Foreign Function Interface Tutorial
1+
% Rust Foreign Function Interface Guide
22

33
# Introduction
44

5-
This tutorial will use the [snappy](https://code.google.com/p/snappy/)
5+
This guide will use the [snappy](https://code.google.com/p/snappy/)
66
compression/decompression library as an introduction to writing bindings for
77
foreign code. Rust is currently unable to call directly into a C++ library, but
88
snappy includes a C interface (documented in

doc/tutorial-macros.md renamed to doc/guide-macros.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
% Rust Macros Tutorial
1+
% Rust Macros Guide
22

33
# Introduction
44

doc/tutorial-rustpkg.md renamed to doc/guide-rustpkg.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
% Rust Packaging Tutorial
1+
% Rust Packaging Guide
22

33
# Introduction
44

55
Sharing is caring. Rust comes with a tool, `rustpkg`, which allows you to
6-
package up your Rust code and share it with other people. This tutorial will
6+
package up your Rust code and share it with other people. This guide will
77
get you started on all of the concepts and commands you need to give the gift
88
of Rust code to someone else.
99

@@ -92,7 +92,7 @@ There are also default file names you'll want to follow as well:
9292
Now that you've got workspaces down, let's build your own copy of `hello`. Go
9393
to wherever you keep your personal projects, and let's make all of the
9494
directories we'll need. I'll refer to this personal project directory as
95-
`~/src` for the rest of this tutorial.
95+
`~/src` for the rest of this guide.
9696

9797
## Creating our workspace
9898

doc/tutorial-tasks.md renamed to doc/guide-tasks.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
% Rust Tasks and Communication Tutorial
1+
% Rust Tasks and Communication Guide
22

33
# Introduction
44

55
Rust provides safe concurrency through a combination
66
of lightweight, memory-isolated tasks and message passing.
7-
This tutorial will describe the concurrency model in Rust, how it
7+
This guide will describe the concurrency model in Rust, how it
88
relates to the Rust type system, and introduce
99
the fundamental library abstractions for constructing concurrent programs.
1010

doc/tutorial-testing.md renamed to doc/guide-testing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
% Rust Testing Tutorial
1+
% Rust Testing Guide
22

33
# Quick start
44

doc/tutorial.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3035,8 +3035,6 @@ but for this tutorial it's only important to know that you can optionally annota
30353035
extern mod rust = "github.com/mozilla/rust"; // pretend Rust is a simple library
30363036
~~~
30373037

3038-
[rustpkg]: rustpkg.html
3039-
30403038
## Crate metadata and settings
30413039

30423040
For every crate you can define a number of metadata items, such as link name, version or author.
@@ -3194,7 +3192,7 @@ re-export a bunch of 'officially blessed' crates that get managed with `rustpkg`
31943192
# What next?
31953193

31963194
Now that you know the essentials, check out any of the additional
3197-
tutorials on individual topics.
3195+
guides on individual topics.
31983196

31993197
* [Borrowed pointers][borrow]
32003198
* [Tasks and communication][tasks]
@@ -3209,14 +3207,14 @@ tutorials on individual topics.
32093207
There is further documentation on the [wiki], however those tend to be even
32103208
more out of date than this document.
32113209

3212-
[borrow]: tutorial-borrowed-ptr.html
3213-
[tasks]: tutorial-tasks.html
3214-
[macros]: tutorial-macros.html
3215-
[ffi]: tutorial-ffi.html
3216-
[container]: tutorial-container.html
3217-
[conditions]: tutorial-conditions.html
3218-
[rustpkg]: tutorial-rustpkg.html
3219-
[testing]: tutorial-testing.html
3210+
[borrow]: guide-borrowed-ptr.html
3211+
[tasks]: guide-tasks.html
3212+
[macros]: guide-macros.html
3213+
[ffi]: guide-ffi.html
3214+
[container]: guide-container.html
3215+
[conditions]: guide-conditions.html
3216+
[rustpkg]: guide-rustpkg.html
3217+
[testing]: guide-testing.html
32203218
[rustdoc]: rustdoc.html
32213219

32223220
[wiki]: https://github.com/mozilla/rust/wiki/Docs

0 commit comments

Comments
 (0)