Commit Graph

1514 Commits

Author SHA1 Message Date
Jorge Aparicio
ed56c15ceb remove NoSendItem and NoSyncItem 2015-01-21 00:45:35 -05:00
Alfie John
1f6eb344d0 docs: Update for clarity
Compiling won't produce an executable just yet because (as stated in the next
paragraph) there are errors. By removing this sentance, the reader won't get
confused when they expect a successful compile i.e. if they don't read ahead one
paragraph, they are going to be checking their code and wondering why it's not
compiling.
2015-01-21 01:37:39 +00:00
bors
29bd9a06ef Auto merge of #21439 - alexcrichton:rollup, r=alexcrichton
Continuation of https://github.com/rust-lang/rust/pull/21428
2015-01-20 23:03:09 +00:00
Alex Crichton
631896dc19 Test fixes and rebase conflicts 2015-01-20 12:35:51 -08:00
Alfie John
1f50542a0d docs: typo 2015-01-20 19:02:09 +00:00
Barosl LEE
9752924dff Rollup merge of #21179 - nodakai:reference-mod-to-self, r=huonw
This should have been done together with 56dcbd17fd for rust-lang/rust#20361
2015-01-21 02:16:53 +09:00
Barosl LEE
01ae97b45e Rollup merge of #21427 - steveklabnik:generics_fix, r=alexcrichton
Multiple people have asked me if this is a reference to Hacker News, and
I _certainly_ don't want to give them that impression.
2015-01-21 02:16:52 +09:00
Barosl LEE
a79f1921a9 Rollup merge of #21375 - petrochenkov:ssbsl, r=alexcrichton
After PR #19766 added implicit coersions `*mut T -> *const T`, the explicit casts can be removed.
(The number of such casts turned out to be relatively small).
2015-01-21 02:16:50 +09:00
Barosl LEE
75efb22808 Rollup merge of #21359 - WiSaGaN:bugfix/fix_marker, r=alexcrichton
From std::markers to std::marker.
2015-01-21 02:16:49 +09:00
Barosl LEE
33ea011574 Rollup merge of #21358 - glacjay:patch-2, r=alexcrichton 2015-01-21 02:16:49 +09:00
Barosl LEE
567bf6ca8c Rollup merge of #21357 - kimroen:patch-1, r=sanxiyn
Having both "Right now" and "at the moment" in the same statement is redundant.
2015-01-21 02:16:49 +09:00
Barosl LEE
4419fa39c2 Rollup merge of #21345 - glacjay:patch-1, r=alexcrichton
The reference should be `x`, not `FOO` itself.
2015-01-21 02:16:48 +09:00
Barosl LEE
b3f6e82beb Rollup merge of #21048 - aroben:patch-1, r=steveklabnik
Now both the enum values and the prose describing them mention the values in the same order.
2015-01-21 02:16:47 +09:00
Barosl LEE
d8a892303c Rollup merge of #21294 - alfie:typo, r=steveklabnik
Wrong verb.
2015-01-21 02:16:46 +09:00
Barosl LEE
b7afe5ec27 Rollup merge of #21355 - alfie:suffix, r=steveklabnik
More [u]int => [i|u]size and [i|u] => [i|u]s changes
2015-01-21 02:16:46 +09:00
Barosl LEE
9db869b348 Rollup merge of #21280 - timparenti:old-guide-stub-grammar, r=alexcrichton
This removes the extra "the" from the phrase "the the Rust Programming Language book", which isn't particularly grammatical, in stub documents introduced in #20802 to direct users from the old guides to the corresponding sections of the book.
2015-01-21 02:16:45 +09:00
Barosl LEE
1d8b917811 Rollup merge of #20998 - estsauver:20984, r=steveklabnik
There are a large number of places that incorrectly refer
to deriving in comments, instead of derives.

If someone could look at src/etc/generate-deriving-span-tests.py,
I'm not sure how those tests were passing before/if they were.
2015-01-21 02:16:45 +09:00
Steve Klabnik
e361b38888 Small fix in TRPL 3.9
Multiple people have asked me if this is a reference to Hacker News, and
I _certainly_ don't want to give them that impression.
2015-01-20 11:36:29 -05:00
bors
a0f86de497 Auto merge of #19353 - icorderi:docs/grammar, r=steveklabnik
Original [issue](https://github.com/rust-lang/rust/issues/19278) that inspired this patch.

The [reference.md] has evolved past simple grammatical constructs, and it serves a different purpose. 
The intent for the proposed _grammar.md_ is to hold **only** the official reference for the language grammar. This document would keep track of grammatical changes to the language over time, facilitate discussions over proposed changes to the existing grammar, and serve as basis for building parsers by third-parties (IDE's, GitHub linguist, CodeMirror, etc.). 

The current state of the PR contains all the grammars that were available in [reference.md] and nothing else. 
There are still a lot of missing pieces that weren't available. The following are just a few of the definitions missing:
- [Functions](https://github.com/icorderi/rust/blob/docs/grammar/src/doc/grammar.md#functions)
- [Structures](https://github.com/icorderi/rust/blob/docs/grammar/src/doc/grammar.md#structures)
- [Traits](https://github.com/icorderi/rust/blob/docs/grammar/src/doc/grammar.md#traits)
- [Implementations](https://github.com/icorderi/rust/blob/docs/grammar/src/doc/grammar.md#implementations)
- [Operators](https://github.com/icorderi/rust/blob/docs/grammar/src/doc/grammar.md#unary-operator-expressions)
- [Statements](https://github.com/icorderi/rust/blob/docs/grammar/src/doc/grammar.md#statements)
- [Expressions](https://github.com/icorderi/rust/blob/docs/grammar/src/doc/grammar.md#expressions)

[reference.md]: https://github.com/rust-lang/rust/blob/master/src/doc/reference.md

We need help from people familiar with those grammatical constructs to fill in the missing pieces.
2015-01-20 16:05:33 +00:00
bors
e375a892f1 Auto merge of #21257 - alexcrichton:issue-20064, r=pnkfelix
These two attributes are used to change the entry point into a Rust program, but
for now they're being put behind feature gates until we have a chance to think
about them a little more. The #[start] attribute specifically may have its
signature changed.

This is a breaking change to due the usage of these attributes generating errors
by default now. If your crate is using these attributes, add this to your crate
root:

    #![feature(start)] // if you're using the #[start] attribute
    #![feature(main)]  // if you're using the #[main] attribute

cc #20064
2015-01-20 02:23:49 +00:00
Logan Chien
8c3d914ca4 Change the title of if statement in trpl book. 2015-01-20 00:41:59 +08:00
Matt Roche
9293607f8f quick formatting fix 2015-01-18 15:28:12 -05:00
Matt Roche
4347cbbd66 Error message fixes and removed explicit returns in example code 2015-01-18 15:22:16 -05:00
Wangshan Lu
e28da7ad44 Fix std::marker.
From std::markers to std::marker.
2015-01-18 22:17:44 +08:00
Jay True
ab73d455fe fix formatting 2015-01-18 21:23:22 +08:00
Alfie John
5431727b6e docs: replacing more deprecated integer suffixes 2015-01-18 12:43:12 +00:00
Kim Røen
17ffe51aa3 Remove redundant "Right now"
Having both "Right now" and "at the moment" in the same statement is redundant.
2015-01-18 13:24:13 +01:00
Alfie John
66003c06a1 docs: replace deprecated integer suffixes from examples 2015-01-18 11:49:37 +00:00
Jay True
2b6efbf92d fix an error about the static lifetime
The reference should be `x`, not `FOO` itself.
2015-01-18 10:58:55 +08:00
Alfie John
8da284a045 docs: typo 2015-01-17 23:31:13 +00:00
Steve Klabnik
6553c0f5eb Fix more rollup problems 2015-01-17 15:25:42 -05:00
Earl St Sauver
6ab95bdd62 s/deriving/derives in Comments/Docs
There are a large number of places that incorrectly refer
to deriving in comments, instead of derives.

Fixes #20984
2015-01-17 11:08:02 -08:00
Alfie John
2c64023e3e docs: grammar fix 2015-01-17 10:51:53 -05:00
Nick Howell
0c26524134 doc: Remove extra whitespace in the middle of lines to provide alignment
"Idiomatic code should not use extra whitespace in the middle of a line to provide alignment."
http://aturon.github.io/style/whitespace.html

I realize the linked page still needs an RFC, but the docs should be written in accordance with the guidelines nevertheless.
2015-01-17 10:51:53 -05:00
Steve Klabnik
433ea0bd55 Add C -> Rust example to FFI chapter of the book.
Fixes #10489.
2015-01-17 10:51:07 -05:00
Steve Klabnik
d5091c9cc9 Fix up titles of TRPL chapters 2015-01-17 10:51:07 -05:00
Ms2ger
0109ceaf82 Fix typo. 2015-01-17 10:51:07 -05:00
Steve Klabnik
899ffcf62a Intpocalypse, book edition.
Fix all usage of int/uint/i/u in the book.
2015-01-17 10:51:07 -05:00
Steve Klabnik
078bd498b9 Evaluate # fn in docs
I searched for times when we were hiding functions with # in the documentation,
and fixed them to not use it unless neccesary.

I also made random improvements whenever I changed something. For example,
I changed Example to Examples, for consistency.

Fixes #13423
2015-01-17 10:49:49 -05:00
Steve Klabnik
a03701defa Remove segmented stack info from the FFI chapter of the book.
Fixes #20071.
2015-01-17 10:49:49 -05:00
Andrew Barchuk
5f1ba93ad2 Replace obsolete constructions in into examples
Replace deprecated integer suffixes. Remove integer type notations
altogether where possible. Replace uses of deprecated `range()`
function with range notation.
2015-01-17 10:49:49 -05:00
Andrew Barchuk
f77208972a Remove Thread::detach() call from intro example
The mentioned method are no longer part of Thread. Spawned threads are
detached by default as of now.
2015-01-17 10:49:49 -05:00
Andrew Barchuk
9ed27df180 Fix intro concurrency examples compilation warns
* Use range notation instead of deprecated `range()`

* Remove deprecated `u` integer suffixes used in ranges

* Replace deprecated `i` integer suffixes with `is` for vector numbers

`Thread::spawn()` still gives "use of unstable item" warning which I
hadn't found a way to fix.
2015-01-17 10:49:49 -05:00
Steve Klabnik
a2e277edf4 Add enum discriminats to the reference.
Fixes #15755
2015-01-17 10:49:49 -05:00
we
812ce6c190 Remove unnecessary explicit conversions to *const T 2015-01-17 07:34:10 +03:00
Tim Parenti
fbcc34f483 Grammar tweak to old guide stub documents.
Removes extra "the" from the phrase "the the Rust Programming Language
book", which isn't particularly grammatical.
2015-01-16 22:25:22 -05:00
Alex Crichton
38cb91e66c syntax: Feature gate #[start] and #[main]
These two attributes are used to change the entry point into a Rust program, but
for now they're being put behind feature gates until we have a chance to think
about them a little more. The #[start] attribute specifically may have its
signature changed.

This is a breaking change to due the usage of these attributes generating errors
by default now. If your crate is using these attributes, add this to your crate
root:

    #![feature(start)] // if you're using the #[start] attribute
    #![feature(main)]  // if you're using the #[main] attribute

cc #20064
2015-01-16 14:59:03 -08:00
bors
f3d71be65c Merge pull request #21214 from sleepynate/spacing-in-book
Fix commented graphs in src/doc/trpl/ownership.md

Reviewed-by: huonw
2015-01-16 06:31:03 +00:00
nathan dotz
3626a308f3 Fix commented graphs in src/doc/trpl/ownership.md 2015-01-15 18:15:18 -05:00
Alex Crichton
5f32992b31 rollup merge of #21206: steveklabnik/expressions
Suggested here: http://stackoverflow.com/a/27962076/24817
2015-01-15 14:12:08 -08:00
Alex Crichton
7be39b0c03 rollup merge of #21164: richo/doc/servo-link
Tiny docfix to make the urls point to the canonical endpoint.
2015-01-15 14:11:59 -08:00
Alex Crichton
8c81800170 rollup merge of #21148: bombless/patch-1 2015-01-15 14:11:55 -08:00
Alex Crichton
b86a84867a rollup merge of #21141: tcard/master
Really small correction.

This anti-example in the Closures section is supposed to fail because of a borrow, but it was failing at the type inference because of insufficient type information.

This makes it fail for the expected reason.
2015-01-15 14:11:54 -08:00
Alex Crichton
7e2ef2cbc6 rollup merge of #21133: iKevinY/mobile-rustdoc
Just a couple of tweaks to improve the appearance of pages like [The Rust Reference](http://doc.rust-lang.org/reference.html) on mobile to advance the progress of #20850. Changing the viewport wasn't quite good enough to make it mobile-friendly, as large tables forced the page to become wider than the screen width. Using `overflow-x`, tables that are too large become horizontally scrollable instead of forcing the *entire page* to become horizontally scrollable.

Also, there was at least one case where an extremely long piece of inline code was wider than the actual width of the screen (`std::ptr::copy_nonoverlapping_memory`), so I changed `word-wrap` to allow inline code to break in the middle of words instead of only text within `pre` tags.

This isn't a change included in this PR, but rather something up for discussion. Currently, code blocks that contain long lines simply wrap onto the next line. What if rather than wrapping, they were horizontally scrollable instead? I'm not sure what the general preference is regarding this.

r? @steveklabnik
2015-01-15 14:11:53 -08:00
Alex Crichton
68c3f8c0c3 rollup merge of #21124: steveklabnik/fix_redirect
Why redirect Tutorial -> Guide -> Book when you can just Tutorial -> Book?

Suggested here: http://www.reddit.com/r/rust/comments/2schav/is_it_possible_to_automatically_redirect/
2015-01-15 14:11:52 -08:00
Alex Crichton
65b286d834 rollup merge of #21109: steveklabnik/gh17224
Fixes #17224
2015-01-15 14:11:48 -08:00
Alex Crichton
d7009e6f31 rollup merge of #21105: csouth3/kill-box-import
Closes #21093.
r? @steveklabnik
cc @alexcrichton

I tested with `make check-docs` and this passes that.  Hope that was enough.
2015-01-15 14:11:46 -08:00
Alex Crichton
46a490f42b rollup merge of #21075: iKevinY/intro-changes
- Make punctuation/formatting consistent with the changes made to *The Rust Programming Language* in #20782.
- Use title casing for "Safety and Speed" section.
- Reword some phrases to improve clarity.
2015-01-15 14:11:41 -08:00
Alex Crichton
2890266b27 rollup merge of #21041: steveklabnik/gh17554
Fixes #17554
2015-01-15 14:11:37 -08:00
Alex Crichton
7aa7707af9 rollup merge of #21040: steveklabnik/gh20037
Fixes #20037.
2015-01-15 14:11:37 -08:00
Alex Crichton
9d6e1f921b rollup merge of #21038: steveklabnik/gh20471
Fixes #20471.
2015-01-15 14:11:36 -08:00
Alex Crichton
21effeb611 rollup merge of #21031: steveklabnik/gh19067
Fixes #19067
2015-01-15 14:11:35 -08:00
Alex Crichton
8d0b937964 rollup merge of #21029: steveklabnik/gh19924
Fixes #19924
2015-01-15 14:11:35 -08:00
Alex Crichton
b8751b8410 rollup merge of #21028: steveklabnik/gh17368
Fixes #17368
2015-01-15 14:11:35 -08:00
Alex Crichton
cfbf313282 rollup merge of #21023: steveklabnik/gh20840
Fixes #20840
2015-01-15 14:11:34 -08:00
Alex Crichton
6155ce53b6 rollup merge of #21020: steveklabnik/gh20844
Thank you @bluss for the suggested implementation.

Fixes #20844
2015-01-15 14:11:34 -08:00
Alex Crichton
e06863ef64 rollup merge of #21015: steveklabnik/gh20852
Fixes #20852
2015-01-15 14:11:33 -08:00
Alex Crichton
ff9ae8815b rollup merge of #21014: steveklabnik/gh20876
Fixes #20876
2015-01-15 14:11:33 -08:00
Alex Crichton
c6a9877039 rollup merge of #21013: steveklabnik/gh20914
Fixes #20914
2015-01-15 14:11:33 -08:00
Alex Crichton
73660a11c9 rollup merge of #21011: steveklabnik/gh20993
Fixes #20993
2015-01-15 14:11:32 -08:00
Alex Crichton
dbbe506c10 rollup merge of #21001: camjackson/master
With the code samples as they are, the compiler says:
`feature has been added to Rust, directive not necessary`
2015-01-15 14:11:31 -08:00
Alex Crichton
c478c6ac91 rollup merge of #20988: ciphergoth/task-to-thread
"Tasks" are no longer a thing in Rust; refer to threads instead. Work is still needed on [threads.md](threads.md).
2015-01-15 14:11:30 -08:00
Alex Crichton
37d20f256a rollup merge of #20986: alkor/doc-fixes
Corrections in TRPL macros guide
2015-01-15 14:11:29 -08:00
Alex Crichton
eb94c357d0 rollup merge of #20929: laurilehmijoki/master
The sentence is easier to read once we move the word "again" away from the last position.
2015-01-15 14:11:28 -08:00
Alex Crichton
d3c5cf1b35 rollup merge of #20892: CarVac/master
`uint` was recently deprecated, so in following the use of `i32` in the first parts, replace all copies of `uint` with `u32`.
2015-01-15 14:11:28 -08:00
Alex Crichton
855c3e5af5 rollup merge of #20632: gchp/reference
I noticed that the `deriving` keyword is deprecated and that `derive` is the replacement. This updates the reference (and other docs) to remove the use `deriving`.
2015-01-15 14:11:27 -08:00
Steve Klabnik
fd603cd263 Clarify function return style.
Suggested here: http://stackoverflow.com/a/27962076/24817
2015-01-15 14:47:21 -05:00
Steve Klabnik
462dd64716 Add explanation of main to rustdoc docs
Fixes #17554
2015-01-15 09:58:58 -05:00
NODA, Kai
195fd9a2b4 reference.md: change "mod" to "self" in "use" declaration.
This should have been done together with 56dcbd17fd
for rust-lang/rust#20361

Signed-off-by: NODA, Kai <nodakai@gmail.com>
2015-01-15 13:57:02 +08:00
bors
0c96037ec1 auto merge of #20980 : richo/rust/final-power, r=alexcrichton
Originally, this was going to be discussed and revisted, however I've been working on this for months, and a rebase on top of master was about 1 flight's worth of work so I just went ahead and did it.

This gets you as far as being able to target powerpc with, eg:

    LD_LIBRARY_PATH=./x86_64-unknown-linux-gnu/stage2/lib/ x86_64-unknown-linux-gnu/stage2/bin/rustc -C linker=powerpc-linux-gnu-gcc --target powerpc-unknown-linux-gnu hello.rs

Would really love to get this out before 1.0. r? @alexcrichton
2015-01-15 05:12:30 +00:00
Richo Healey
5e646755f4 doc: fix links to servo 2015-01-14 16:13:58 -08:00
York Xiang
bf899e997e fix wrong link 2015-01-15 01:11:28 +08:00
Toni Cárdenas
428da78de1 TRPL: Anti-example failing for the wrong reason.
Really small correction.

This anti-example in the Closures section is supposed to fail because of a borrow, but it was failing at the type inference because of insufficient type information.

This makes it fail for the expected reason.
2015-01-14 15:24:41 +01:00
Kevin Yap
5a16ceb291 Improve Rust Documentation & Reference on mobile
- Tables that are too wide for the screen scroll horizontally.
- Inline code that would force the page to become wider than the width
  of the screen is broken in the middle of the word.
2015-01-13 22:39:52 -08:00
Steve Klabnik
40219249cf Re-direct to the right place.
Why redirect Tutorial -> Guide -> Book when you can just Tutorial -> Book?

Suggested here: http://www.reddit.com/r/rust/comments/2schav/is_it_possible_to_automatically_redirect/
2015-01-13 21:11:47 -05:00
Steve Klabnik
ad0ce88c6c Provide example of generic inverse()
Fixes #17224
2015-01-13 15:42:38 -05:00
Chase Southwood
07f723f19b Remove unneeded box import in examples 2015-01-13 12:56:10 -06:00
Greg Chapple
4b14f67df3 Replace usage of deriving with derive in docs 2015-01-13 13:57:09 +00:00
JONNALAGADDA Srinivas
ac110df0ff Expand the section on closures in TRPL.
* Include an illustration of a function that accepts two closures.
2015-01-13 10:14:18 +05:30
Kevin Yap
31ac1fb93d Various changes to Rust Introduction
- Make punctuation/formatting consistent with the changes made to "The
  Rust Programming Language" in #20782.
- Use title casing for "Safety and Speed" section.
- Reword some phrases to improve clarity.
2015-01-12 19:25:17 -08:00
Adam Roben
1c0acb9d91 Match prose with code when discussing Ordering values
Now both the enum values and the prose describing them mention the values in the same order.
2015-01-12 16:18:02 -05:00
Steve Klabnik
16a8c4d238 Don't use 'synonym' with regards to newtypes
Fixes #20037.
2015-01-12 15:30:11 -05:00
Steve Klabnik
2297b0cb00 Elaborate on destructuring let
Fixes #20471.
2015-01-12 15:28:09 -05:00
Steve Klabnik
e485d297ea Improve example in the intro.
Thank you @bluss for the suggested implementation.

Fixes #20844
2015-01-12 15:14:17 -05:00
Steve Klabnik
b704983ee9 Improve the ownership guide a tad
Fixes #19924
2015-01-12 15:12:51 -05:00
Steve Klabnik
db7de969cf Improve clarity of paragraph in the pointer guide
Fixes #19067
2015-01-12 13:57:09 -05:00
Steve Klabnik
425f449fda Remove PDF link on 404 page
Fixes #17368
2015-01-12 13:16:07 -05:00
Lauri Lehmijoki
eabf208285 Ease parsing of an English sentence 2015-01-12 19:42:52 +02:00
Steve Klabnik
95f9e309f7 Clean up wording around uninitialized values.
Fixes #20840
2015-01-12 11:49:54 -05:00
Steve Klabnik
be407180d7 Link to sections in the book's README.md
Fixes #20852
2015-01-12 10:59:21 -05:00