Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rollup of 10 pull requests #33742

Merged
merged 22 commits into from
May 19, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
7da9ea0
Add a note about Higher-Ranked Trait Bounds in docs on Closures.
vvanders May 13, 2016
64feba0
Updated based on CR feedback.
vvanders May 13, 2016
e2bf1f8
Add regression tests for error message when using enum variant as a type
May 17, 2016
c22a45b
std: Update libc submodule
alexcrichton May 17, 2016
acfe199
Add descriptive error explanation for E0502
May 15, 2016
7fef162
Only print parameters with elided lifetimes in elision error messages.
May 18, 2016
f630419
Fix bug in macro expression spans
jseyfried May 18, 2016
98f1c35
Clarified that `let(mut x, y) =` only makes x mutable, not y
mark-summerfield May 18, 2016
c951718
Rust syntax coloring for some ignore, should-panic and no-run snippets.
royalstream May 18, 2016
a50c82b
Simplify report_elision_failure a little bit.
May 18, 2016
f8e9c15
Fix macro expansion backtrace diagnostics
jseyfried May 19, 2016
352a70b
Make the #[stable(since)] version attribute clearer with a tooltip
lqd May 18, 2016
c9ca735
Rollup merge of #33353 - timothy-mcroy:E0502, r=sanxiyn
Manishearth May 19, 2016
e4f33d5
Rollup merge of #33611 - vvanders:master, r=steveklabnik
Manishearth May 19, 2016
7acb22a
Rollup merge of #33696 - nham:add-test-21225, r=luqmana
Manishearth May 19, 2016
26f666b
Rollup merge of #33698 - alexcrichton:update-libc, r=japaric
Manishearth May 19, 2016
355d9f9
Rollup merge of #33705 - lqd:rustdoc-version-tooltip, r=GuillaumeGomez
Manishearth May 19, 2016
14661ae
Rollup merge of #33708 - nham:zero-elided-lifetimes, r=sanxiyn
Manishearth May 19, 2016
8b4b3a8
Rollup merge of #33712 - jseyfried:fix_expanded_expr_span_bug, r=nrc
Manishearth May 19, 2016
f6f5cdf
Rollup merge of #33720 - mark-summerfield:patch-1, r=steveklabnik
Manishearth May 19, 2016
5928d49
Rollup merge of #33721 - royalstream:royalstream-doc-highlights, r=Ma…
Manishearth May 19, 2016
acd2c11
Rollup merge of #33730 - jseyfried:fix_macro_backtrace_diagnostics, r…
Manishearth May 19, 2016
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/doc/book/advanced-linking.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ the `link_args` attribute. This attribute is applied to `extern` blocks and
specifies raw flags which need to get passed to the linker when producing an
artifact. An example usage would be:

``` no_run
```rust,no_run
#![feature(link_args)]

#[link_args = "-foo -bar -baz"]
Expand Down Expand Up @@ -52,7 +52,7 @@ By default, all Rust programs on Linux will link to the system `libc` along with
a number of other libraries. Let's look at an example on a 64-bit Linux machine
with GCC and `glibc` (by far the most common `libc` on Linux):

``` text
```text
$ cat example.rs
fn main() {}
$ rustc example.rs
Expand Down
49 changes: 48 additions & 1 deletion src/doc/book/closures.md
Original file line number Diff line number Diff line change
Expand Up @@ -319,6 +319,53 @@ assert_eq!(3, answer);
Now we take a trait object, a `&Fn`. And we have to make a reference
to our closure when we pass it to `call_with_one`, so we use `&||`.

A quick note about closures that use explicit lifetimes. Sometimes you might have a closure
that takes a reference like so:

```
fn call_with_ref<F>(some_closure:F) -> i32
where F: Fn(&i32) -> i32 {

let mut value = 0;
some_closure(&value)
}
```

Normally you can specify the lifetime of the parameter to our closure. We
could annotate it on the function declaration:

```ignore
fn call_with_ref<'a, F>(some_closure:F) -> i32
where F: Fn(&'a 32) -> i32 {
```

However this presents a problem with in our case. When you specify the explict
lifetime on a function it binds that lifetime to the *entire* scope of the function
instead of just the invocation scope of our closure. This means that the borrow checker
will see a mutable reference in the same lifetime as our immutable reference and fail
to compile.

In order to say that we only need the lifetime to be valid for the invocation scope
of the closure we can use Higher-Ranked Trait Bounds with the `for<...>` syntax:

```ignore
fn call_with_ref<F>(some_closure:F) -> i32
where F: for<'a> Fn(&'a 32) -> i32 {
```

This lets the Rust compiler find the minimum lifetime to invoke our closure and
satisfy the borrow checker's rules. Our function then compiles and excutes as we
expect.

```
fn call_with_ref<F>(some_closure:F) -> i32
where F: for<'a> Fn(&'a i32) -> i32 {

let mut value = 0;
some_closure(&value)
}
```

# Function pointers and closures

A function pointer is kind of like a closure that has no environment. As such,
Expand All @@ -344,7 +391,7 @@ assert_eq!(2, answer);
In this example, we don’t strictly need the intermediate variable `f`,
the name of the function works just fine too:

```ignore
```rust,ignore
let answer = call_with_one(&add_one);
```

Expand Down
10 changes: 5 additions & 5 deletions src/doc/book/compiler-plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Let's write a plugin
[`roman_numerals.rs`](https://github.com/rust-lang/rust/tree/master/src/test/auxiliary/roman_numerals.rs)
that implements Roman numeral integer literals.

```ignore
```rust,ignore
#![crate_type="dylib"]
#![feature(plugin_registrar, rustc_private)]

Expand Down Expand Up @@ -102,7 +102,7 @@ pub fn plugin_registrar(reg: &mut Registry) {

Then we can use `rn!()` like any other macro:

```ignore
```rust,ignore
#![feature(plugin)]
#![plugin(roman_numerals)]

Expand Down Expand Up @@ -132,7 +132,7 @@ Some of the [macro debugging tips](macros.html#debugging-macro-code) are applica
You can use `syntax::parse` to turn token trees into
higher-level syntax elements like expressions:

```ignore
```rust,ignore
fn expand_foo(cx: &mut ExtCtxt, sp: Span, args: &[TokenTree])
-> Box<MacResult+'static> {

Expand Down Expand Up @@ -169,7 +169,7 @@ infrastructure](../reference.html#lint-check-attributes) with additional checks
code style, safety, etc. Now let's write a plugin [`lint_plugin_test.rs`](https://github.com/rust-lang/rust/blob/master/src/test/auxiliary/lint_plugin_test.rs)
that warns about any item named `lintme`.

```ignore
```rust,ignore
#![feature(plugin_registrar)]
#![feature(box_syntax, rustc_private)]

Expand Down Expand Up @@ -211,7 +211,7 @@ pub fn plugin_registrar(reg: &mut Registry) {

Then code like

```ignore
```rust,ignore
#![plugin(lint_plugin_test)]

fn lintme() { }
Expand Down
8 changes: 4 additions & 4 deletions src/doc/book/concurrency.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ concurrency bugs.
As an example, here is a Rust program that would have a data race in many
languages. It will not compile:

```ignore
```rust,ignore
use std::thread;
use std::time::Duration;

Expand Down Expand Up @@ -204,7 +204,7 @@ Calling `clone()` on an `Rc<T>` will return a new owned reference and bump the
internal reference count. We create one of these for each thread:


```ignore
```rust,ignore
use std::thread;
use std::time::Duration;
use std::rc::Rc;
Expand Down Expand Up @@ -250,7 +250,7 @@ In essence, `Arc<T>` is a type that lets us share ownership of data _across
threads_.


```ignore
```rust,ignore
use std::thread;
use std::sync::Arc;
use std::time::Duration;
Expand Down Expand Up @@ -336,7 +336,7 @@ The lock "release" here is implicit; when the result of the lock (in this case,
Note that [`lock`](../std/sync/struct.Mutex.html#method.lock) method of
[`Mutex`](../std/sync/struct.Mutex.html) has this signature:

```ignore
```rust,ignore
fn lock(&self) -> LockResult<MutexGuard<T>>
```

Expand Down
12 changes: 6 additions & 6 deletions src/doc/book/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -362,7 +362,7 @@ Here’s an example of documenting a macro:
/// # }
/// ```
///
/// ```should_panic
/// ```rust,should_panic
/// # #[macro_use] extern crate foo;
/// # fn main() {
/// panic_unless!(true == false, “I’m broken.”);
Expand Down Expand Up @@ -429,7 +429,7 @@ There are a few more annotations that are useful to help `rustdoc` do the right
thing when testing your code:

```rust
/// ```ignore
/// ```rust,ignore
/// fn foo() {
/// ```
# fn foo() {}
Expand All @@ -441,7 +441,7 @@ with `text` if it's not code, or using `#`s to get a working example that
only shows the part you care about.

```rust
/// ```should_panic
/// ```rust,should_panic
/// assert!(false);
/// ```
# fn foo() {}
Expand All @@ -451,7 +451,7 @@ only shows the part you care about.
not actually pass as a test.

```rust
/// ```no_run
/// ```rust,no_run
/// loop {
/// println!("Hello, world");
/// }
Expand Down Expand Up @@ -563,7 +563,7 @@ can be useful when changing some options, or when writing a macro.

`rustdoc` will show the documentation for a public re-export in both places:

```ignore
```rust,ignore
extern crate foo;

pub use foo::bar;
Expand All @@ -575,7 +575,7 @@ documentation in both places.

This behavior can be suppressed with `no_inline`:

```ignore
```rust,ignore
extern crate foo;

#[doc(no_inline)]
Expand Down
12 changes: 6 additions & 6 deletions src/doc/book/ffi.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ and add `extern crate libc;` to your crate root.
The following is a minimal example of calling a foreign function which will
compile if snappy is installed:

```no_run
```rust,no_run
# #![feature(libc)]
extern crate libc;
use libc::size_t;
Expand Down Expand Up @@ -62,7 +62,7 @@ keeping the binding correct at runtime.

The `extern` block can be extended to cover the entire snappy API:

```no_run
```rust,no_run
# #![feature(libc)]
extern crate libc;
use libc::{c_int, size_t};
Expand Down Expand Up @@ -209,7 +209,7 @@ A basic example is:

Rust code:

```no_run
```rust,no_run
extern fn callback(a: i32) {
println!("I'm called from C with value {0}", a);
}
Expand Down Expand Up @@ -262,7 +262,7 @@ referenced Rust object.

Rust code:

```no_run
```rust,no_run
#[repr(C)]
struct RustObject {
a: i32,
Expand Down Expand Up @@ -406,7 +406,7 @@ Foreign APIs often export a global variable which could do something like track
global state. In order to access these variables, you declare them in `extern`
blocks with the `static` keyword:

```no_run
```rust,no_run
# #![feature(libc)]
extern crate libc;

Expand All @@ -425,7 +425,7 @@ Alternatively, you may need to alter global state provided by a foreign
interface. To do this, statics can be declared with `mut` so we can mutate
them.

```no_run
```rust,no_run
# #![feature(libc)]
extern crate libc;

Expand Down
4 changes: 2 additions & 2 deletions src/doc/book/functions.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ x = y = 5
In Rust, however, using `let` to introduce a binding is _not_ an expression. The
following will produce a compile-time error:

```ignore
```rust,ignore
let x = (let y = 5); // expected identifier, found keyword `let`
```

Expand Down Expand Up @@ -283,7 +283,7 @@ stack backtrace:

A diverging function can be used as any type:

```should_panic
```rust,should_panic
# fn diverges() -> ! {
# panic!("This function never returns!");
# }
Expand Down
2 changes: 1 addition & 1 deletion src/doc/book/inline-assembly.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ For extremely low-level manipulations and performance reasons, one
might wish to control the CPU directly. Rust supports using inline
assembly to do this via the `asm!` macro.

```ignore
```rust,ignore
asm!(assembly template
: output operands
: input operands
Expand Down
2 changes: 1 addition & 1 deletion src/doc/book/loops.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ for x in 0..10 {

In slightly more abstract terms,

```ignore
```rust,ignore
for var in expression {
code
}
Expand Down
10 changes: 5 additions & 5 deletions src/doc/book/macros.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ macro_rules! vec {

Whoa, that’s a lot of new syntax! Let’s break it down.

```ignore
```rust,ignore
macro_rules! vec { ... }
```

Expand All @@ -92,7 +92,7 @@ syntax and serves to distinguish a macro from an ordinary function.
The macro is defined through a series of rules, which are pattern-matching
cases. Above, we had

```ignore
```rust,ignore
( $( $x:expr ),* ) => { ... };
```

Expand All @@ -112,7 +112,7 @@ separated by commas.
Aside from the special matcher syntax, any Rust tokens that appear in a matcher
must match exactly. For example,

```rust
```rust,ignore
macro_rules! foo {
(x => $e:expr) => (println!("mode X: {}", $e));
(y => $e:expr) => (println!("mode Y: {}", $e));
Expand Down Expand Up @@ -147,7 +147,7 @@ The right-hand side of a macro rule is ordinary Rust syntax, for the most part.
But we can splice in bits of syntax captured by the matcher. From the original
example:

```ignore
```rust,ignore
$(
temp_vec.push($x);
)*
Expand All @@ -165,7 +165,7 @@ within the repeated block.
Another detail: the `vec!` macro has *two* pairs of braces on the right-hand
side. They are often combined like so:

```ignore
```rust,ignore
macro_rules! foo {
() => {{
...
Expand Down
2 changes: 2 additions & 0 deletions src/doc/book/mutability.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,8 @@ fn foo(mut x: i32) {
# }
```

Note that here, the `x` is mutable, but not the `y`.

[pattern]: patterns.html

# Interior vs. Exterior Mutability
Expand Down
2 changes: 1 addition & 1 deletion src/doc/book/operators-and-overloading.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ fn main() {
For `HasArea` and `Square`, we declare a type parameter `T` and replace
`f64` with it. The `impl` needs more involved modifications:

```ignore
```rust,ignore
impl<T> HasArea<T> for Square<T>
where T: Mul<Output=T> + Copy { ... }
```
Expand Down
2 changes: 1 addition & 1 deletion src/doc/book/trait-objects.md
Original file line number Diff line number Diff line change
Expand Up @@ -306,7 +306,7 @@ let y = TraitObject {
Not every trait can be used to make a trait object. For example, vectors implement
`Clone`, but if we try to make a trait object:

```ignore
```rust,ignore
let v = vec![1, 2, 3];
let o = &v as &Clone;
```
Expand Down
2 changes: 1 addition & 1 deletion src/doc/book/traits.md
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ fn main() {
`is_square()` needs to check that the sides are equal, so the sides must be of
a type that implements the [`core::cmp::PartialEq`][PartialEq] trait:

```ignore
```rust,ignore
impl<T: PartialEq> Rectangle<T> { ... }
```

Expand Down
Loading