Skip to content

Commit 9e658e4

Browse files
committed
---
yaml --- r: 235814 b: refs/heads/stable c: e4f0446 h: refs/heads/master v: v3
1 parent f16521b commit 9e658e4

File tree

123 files changed

+4050
-847
lines changed

Some content is hidden

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

123 files changed

+4050
-847
lines changed

[refs]

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ refs/heads/tmp: afae2ff723393b3ab4ccffef6ac7c6d1809e2da0
2929
refs/tags/1.0.0-alpha.2: 4c705f6bc559886632d3871b04f58aab093bfa2f
3030
refs/tags/homu-tmp: f859507de8c410b648d934d8f5ec1c52daac971d
3131
refs/tags/1.0.0-beta: 8cbb92b53468ee2b0c2d3eeb8567005953d40828
32-
refs/heads/stable: c2fca7c95742cdd25198eae42d233d49db7026ea
32+
refs/heads/stable: e4f044662be44f18d163db5fec4cde09c6d4342c
3333
refs/tags/1.0.0: 55bd4f8ff2b323f317ae89e254ce87162d52a375
3434
refs/tags/1.1.0: bc3c16f09287e5545c1d3f76b7abd54f2eca868b
3535
refs/tags/1.2.0: f557861f822c34f07270347b94b5280de20a597e

branches/stable/src/doc/reference.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1636,6 +1636,10 @@ The type of a function declared in an extern block is `extern "abi" fn(A1, ...,
16361636
An) -> R`, where `A1...An` are the declared types of its arguments and `R` is
16371637
the declared return type.
16381638

1639+
It is valid to add the `link` attribute on an empty extern block. You can use
1640+
this to satisfy the linking requirements of extern blocks elsewhere in your code
1641+
(including upstream crates) instead of adding the attribute to each extern block.
1642+
16391643
## Visibility and Privacy
16401644

16411645
These two terms are often used interchangeably, and what they are attempting to

branches/stable/src/doc/trpl/SUMMARY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@
6363
* [No stdlib](no-stdlib.md)
6464
* [Intrinsics](intrinsics.md)
6565
* [Lang items](lang-items.md)
66-
* [Link args](link-args.md)
66+
* [Advanced linking](advanced-linking.md)
6767
* [Benchmark Tests](benchmark-tests.md)
6868
* [Box Syntax and Patterns](box-syntax-and-patterns.md)
6969
* [Slice Patterns](slice-patterns.md)
Lines changed: 151 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,151 @@
1+
% Advanced Linking
2+
3+
The common cases of linking with Rust have been covered earlier in this book,
4+
but supporting the range of linking possibilities made available by other
5+
languages is important for Rust to achieve seamless interaction with native
6+
libraries.
7+
8+
# Link args
9+
10+
There is one other way to tell `rustc` how to customize linking, and that is via
11+
the `link_args` attribute. This attribute is applied to `extern` blocks and
12+
specifies raw flags which need to get passed to the linker when producing an
13+
artifact. An example usage would be:
14+
15+
``` no_run
16+
#![feature(link_args)]
17+
18+
#[link_args = "-foo -bar -baz"]
19+
extern {}
20+
# fn main() {}
21+
```
22+
23+
Note that this feature is currently hidden behind the `feature(link_args)` gate
24+
because this is not a sanctioned way of performing linking. Right now `rustc`
25+
shells out to the system linker (`gcc` on most systems, `link.exe` on MSVC),
26+
so it makes sense to provide extra command line
27+
arguments, but this will not always be the case. In the future `rustc` may use
28+
LLVM directly to link native libraries, in which case `link_args` will have no
29+
meaning. You can achieve the same effect as the `link-args` attribute with the
30+
`-C link-args` argument to `rustc`.
31+
32+
It is highly recommended to *not* use this attribute, and rather use the more
33+
formal `#[link(...)]` attribute on `extern` blocks instead.
34+
35+
# Static linking
36+
37+
Static linking refers to the process of creating output that contain all
38+
required libraries and so don't need libraries installed on every system where
39+
you want to use your compiled project. Pure-Rust dependencies are statically
40+
linked by default so you can use created binaries and libraries without
41+
installing the Rust everywhere. By contrast, native libraries
42+
(e.g. `libc` and `libm`) usually dynamically linked, but it is possible to
43+
change this and statically link them as well.
44+
45+
Linking is a very platform dependent topic — on some platforms, static linking
46+
may not be possible at all! This section assumes some basic familiarity with
47+
linking on your platform of choice.
48+
49+
## Linux
50+
51+
By default, all Rust programs on Linux will link to the system `libc` along with
52+
a number of other libraries. Let's look at an example on a 64-bit Linux machine
53+
with GCC and `glibc` (by far the most common `libc` on Linux):
54+
55+
``` text
56+
$ cat example.rs
57+
fn main() {}
58+
$ rustc example.rs
59+
$ ldd example
60+
linux-vdso.so.1 => (0x00007ffd565fd000)
61+
libdl.so.2 => /lib/x86_64-linux-gnu/libdl.so.2 (0x00007fa81889c000)
62+
libpthread.so.0 => /lib/x86_64-linux-gnu/libpthread.so.0 (0x00007fa81867e000)
63+
librt.so.1 => /lib/x86_64-linux-gnu/librt.so.1 (0x00007fa818475000)
64+
libgcc_s.so.1 => /lib/x86_64-linux-gnu/libgcc_s.so.1 (0x00007fa81825f000)
65+
libc.so.6 => /lib/x86_64-linux-gnu/libc.so.6 (0x00007fa817e9a000)
66+
/lib64/ld-linux-x86-64.so.2 (0x00007fa818cf9000)
67+
libm.so.6 => /lib/x86_64-linux-gnu/libm.so.6 (0x00007fa817b93000)
68+
```
69+
70+
Dynamic linking on Linux can be undesirable if you wish to use new library
71+
features on old systems or target systems which do not have the required
72+
dependencies for your program to run.
73+
74+
Static linking is supported via an alternative `libc`, `musl` - this must be
75+
enabled at Rust compile-time with some prerequisites available. You can compile
76+
your own version of Rust with `musl` enabled and install it into a custom
77+
directory with the instructions below:
78+
79+
```text
80+
$ mkdir musldist
81+
$ PREFIX=$(pwd)/musldist
82+
$
83+
$ # Build musl
84+
$ wget http://www.musl-libc.org/releases/musl-1.1.10.tar.gz
85+
[...]
86+
$ tar xf musl-1.1.10.tar.gz
87+
$ cd musl-1.1.10/
88+
musl-1.1.10 $ ./configure --disable-shared --prefix=$PREFIX
89+
[...]
90+
musl-1.1.10 $ make
91+
[...]
92+
musl-1.1.10 $ make install
93+
[...]
94+
musl-1.1.10 $ cd ..
95+
$ du -h musldist/lib/libc.a
96+
2.2M musldist/lib/libc.a
97+
$
98+
$ # Build libunwind.a
99+
$ wget http://llvm.org/releases/3.6.1/llvm-3.6.1.src.tar.xz
100+
$ tar xf llvm-3.6.1.src.tar.xz
101+
$ cd llvm-3.6.1.src/projects/
102+
llvm-3.6.1.src/projects $ svn co http://llvm.org/svn/llvm-project/libcxxabi/trunk/ libcxxabi
103+
llvm-3.6.1.src/projects $ svn co http://llvm.org/svn/llvm-project/libunwind/trunk/ libunwind
104+
llvm-3.6.1.src/projects $ sed -i 's#^\(include_directories\).*$#\0\n\1(../libcxxabi/include)#' libunwind/CMakeLists.txt
105+
llvm-3.6.1.src/projects $ mkdir libunwind/build
106+
llvm-3.6.1.src/projects $ cd libunwind/build
107+
llvm-3.6.1.src/projects/libunwind/build $ cmake -DLLVM_PATH=../../.. -DLIBUNWIND_ENABLE_SHARED=0 ..
108+
llvm-3.6.1.src/projects/libunwind/build $ make
109+
llvm-3.6.1.src/projects/libunwind/build $ cp lib/libunwind.a $PREFIX/lib/
110+
llvm-3.6.1.src/projects/libunwind/build $ cd cd ../../../../
111+
$ du -h musldist/lib/libunwind.a
112+
164K musldist/lib/libunwind.a
113+
$
114+
$ # Build musl-enabled rust
115+
$ git clone https://github.com/rust-lang/rust.git muslrust
116+
$ cd muslrust
117+
muslrust $ ./configure --target=x86_64-unknown-linux-musl --musl-root=$PREFIX --prefix=$PREFIX
118+
muslrust $ make
119+
muslrust $ make install
120+
muslrust $ cd ..
121+
$ du -h musldist/bin/rustc
122+
12K musldist/bin/rustc
123+
```
124+
125+
You now have a build of a `musl`-enabled Rust! Because we've installed it to a
126+
custom prefix we need to make sure our system can the binaries and appropriate
127+
libraries when we try and run it:
128+
129+
```text
130+
$ export PATH=$PREFIX/bin:$PATH
131+
$ export LD_LIBRARY_PATH=$PREFIX/lib:$LD_LIBRARY_PATH
132+
```
133+
134+
Let's try it out!
135+
136+
```text
137+
$ echo 'fn main() { println!("hi!"); panic!("failed"); }' > example.rs
138+
$ rustc --target=x86_64-unknown-linux-musl example.rs
139+
$ ldd example
140+
not a dynamic executable
141+
$ ./example
142+
hi!
143+
thread '<main>' panicked at 'failed', example.rs:1
144+
```
145+
146+
Success! This binary can be copied to almost any Linux machine with the same
147+
machine architecture and run without issues.
148+
149+
`cargo build` also permits the `--target` option so you should be able to build
150+
your crates as normal. However, you may need to recompile your native libraries
151+
against `musl` before they can be linked against.

branches/stable/src/doc/trpl/ffi.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -340,7 +340,7 @@ libraries:
340340
Note that frameworks are only available on OSX targets.
341341
342342
The different `kind` values are meant to differentiate how the native library
343-
participates in linkage. From a linkage perspective, the rust compiler creates
343+
participates in linkage. From a linkage perspective, the Rust compiler creates
344344
two flavors of artifacts: partial (rlib/staticlib) and final (dylib/binary).
345345
Native dynamic library and framework dependencies are propagated to the final
346346
artifact boundary, while static library dependencies are not propagated at
@@ -350,9 +350,9 @@ artifact.
350350
A few examples of how this model can be used are:
351351
352352
* A native build dependency. Sometimes some C/C++ glue is needed when writing
353-
some rust code, but distribution of the C/C++ code in a library format is just
353+
some Rust code, but distribution of the C/C++ code in a library format is just
354354
a burden. In this case, the code will be archived into `libfoo.a` and then the
355-
rust crate would declare a dependency via `#[link(name = "foo", kind =
355+
Rust crate would declare a dependency via `#[link(name = "foo", kind =
356356
"static")]`.
357357
358358
Regardless of the flavor of output for the crate, the native static library
@@ -361,7 +361,7 @@ A few examples of how this model can be used are:
361361
362362
* A normal dynamic dependency. Common system libraries (like `readline`) are
363363
available on a large number of systems, and often a static copy of these
364-
libraries cannot be found. When this dependency is included in a rust crate,
364+
libraries cannot be found. When this dependency is included in a Rust crate,
365365
partial targets (like rlibs) will not link to the library, but when the rlib
366366
is included in a final target (like a binary), the native library will be
367367
linked in.

branches/stable/src/doc/trpl/installing-rust.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
The first step to using Rust is to install it! There are a number of ways to
44
install Rust, but the easiest is to use the `rustup` script. If you're on Linux
5-
or a Mac, all you need to do is this:
5+
or a Mac, all you need to do is this:
66

77
> Note: you don't need to type in the `$`s, they just indicate the start of
88
> each command. You’ll see many tutorials and examples around the web that
@@ -25,6 +25,12 @@ $ sh rustup.sh
2525
[insecurity]: http://curlpipesh.tumblr.com
2626

2727
If you're on Windows, please download the appropriate [installer][install-page].
28+
**NOTE:** By default, the Windows installer will not add Rust to the %PATH%
29+
system variable. If this is the only version of Rust you are installing and you
30+
want to be able to run it from the command line, click on "Advanced" on the
31+
install dialog and on the "Product Features" page ensure "Add to PATH" is
32+
installed on the local hard drive.
33+
2834

2935
[install-page]: http://www.rust-lang.org/install.html
3036

@@ -87,6 +93,11 @@ rustc 1.0.0 (a59de37e9 2015-05-13)
8793

8894
If you did, Rust has been installed successfully! Congrats!
8995

96+
If you didn't and you're on Windows, check that Rust is in your %PATH% system
97+
variable. If it isn't, run the installer again, select "Change" on the "Change,
98+
repair, or remove installation" page and ensure "Add to PATH" is installed on
99+
the local hard drive.
100+
90101
This installer also installs a copy of the documentation locally, so you can
91102
read it offline. On UNIX systems, `/usr/local/share/doc/rust` is the location.
92103
On Windows, it's in a `share/doc` directory, inside wherever you installed Rust
@@ -101,5 +112,5 @@ resources include [the user’s forum][users], and
101112

102113
[irc]: irc://irc.mozilla.org/#rust
103114
[mibbit]: http://chat.mibbit.com/?server=irc.mozilla.org&channel=%23rust
104-
[users]: http://users.rust-lang.org/
115+
[users]: http://users.rust-lang.org/
105116
[stackoverflow]: http://stackoverflow.com/questions/tagged/rust

branches/stable/src/doc/trpl/link-args.md

Lines changed: 0 additions & 25 deletions
This file was deleted.

branches/stable/src/doc/trpl/release-channels.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,3 +43,26 @@ This will help alert the team in case there’s an accidental regression.
4343
Additionally, testing against nightly can catch regressions even sooner, and so
4444
if you don’t mind a third build, we’d appreciate testing against all channels.
4545

46+
As an example, many Rust programmers use [Travis](https://travis-ci.org/) to
47+
test their crates, which is free for open source projects. Travis [supports
48+
Rust directly][travis], and you can use a `.travis.yml` file like this to
49+
test on all channels:
50+
51+
```yaml
52+
language: rust
53+
rust:
54+
- nightly
55+
- beta
56+
- stable
57+
58+
matrix:
59+
allow_failures:
60+
- rust: nightly
61+
```
62+
63+
[travis]: http://docs.travis-ci.com/user/languages/rust/
64+
65+
With this configuration, Travis will test all three channels, but if something
66+
breaks on nightly, it won’t fail your build. A similar configuration is
67+
recommended for any CI system, check the documentation of the one you’re
68+
using for more details.

branches/stable/src/doc/trpl/unsafe.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -100,10 +100,14 @@ that you normally can not do. Just three. Here they are:
100100

101101
That’s it. It’s important that `unsafe` does not, for example, ‘turn off the
102102
borrow checker’. Adding `unsafe` to some random Rust code doesn’t change its
103-
semantics, it won’t just start accepting anything.
103+
semantics, it won’t just start accepting anything. But it will let you write
104+
things that _do_ break some of the rules.
104105

105-
But it will let you write things that _do_ break some of the rules. Let’s go
106-
over these three abilities in order.
106+
You will also encounter the `unsafe` keyword when writing bindings to foreign
107+
(non-Rust) interfaces. You're encouraged to write a safe, native Rust interface
108+
around the methods provided by the library.
109+
110+
Let’s go over the basic three abilities listed, in order.
107111

108112
## Access or update a `static mut`
109113

branches/stable/src/doc/trpl/while-loops.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,24 @@ for x in 0..10 {
8888
}
8989
```
9090

91+
You may also encounter situations where you have nested loops and need to
92+
specify which one your `break` or `continue` statement is for. Like most
93+
other languages, by default a `break` or `continue` will apply to innermost
94+
loop. In a sitation where you would like to a `break` or `continue` for one
95+
of the outer loops, you can use labels to specify which loop the `break` or
96+
`continue` statement applies to. This will only print when both `x` and `y` are
97+
odd:
98+
99+
```rust
100+
'outer: for x in 0..10 {
101+
'inner: for y in 0..10 {
102+
if x % 2 == 0 { continue 'outer; } // continues the loop over x
103+
if y % 2 == 0 { continue 'inner; } // continues the loop over y
104+
println!("x: {}, y: {}", x, y);
105+
}
106+
}
107+
```
108+
91109
Both `continue` and `break` are valid in both `while` loops and [`for` loops][for].
92110

93111
[for]: for-loops.html

0 commit comments

Comments
 (0)