Skip to content

Commit dfc5c0f

Browse files
committed
Manual merge of #22475 - alexcrichton:rollup, r=alexcrichton
One windows bot failed spuriously.
2 parents 6c065fc + 47f91a9 commit dfc5c0f

File tree

381 files changed

+6860
-3224
lines changed

Some content is hidden

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

381 files changed

+6860
-3224
lines changed

CONTRIBUTING.md

+139-43
Original file line numberDiff line numberDiff line change
@@ -1,60 +1,156 @@
1-
## How to submit a bug report
1+
# Contributing to Rust
22

3-
If you're just reporting a bug, please see:
3+
Thank you for your interest in contributing to Rust! There are many ways to
4+
contribute, and we appreciate all of them. This document is a bit long, so here's
5+
links to the major sections:
46

5-
http://doc.rust-lang.org/complement-bugreport.html
7+
* [Feature Requests](#feature-requests)
8+
* [Bug Reports](#bug-reports)
9+
* [Pull Requests](#pull-requests)
10+
* [Writing Documentation](#writing-documentation)
11+
* [Issue Triage](#issue-triage)
12+
* [Out-of-tree Contributions](#out-of-tree-contributions)
613

7-
## Submitting an issue
14+
If you have questions, please make a post on [internals.rust-lang.org][internals] or
15+
hop on [#rust-internals][pound-rust-internals].
816

9-
Please submit issues here for bug reports or implementation details. For feature
10-
requests, language changes, or major changes to the libraries, please submit an
11-
issue against the [RFCs repository](https://github.com/rust-lang/rfcs).
17+
As a reminder, all contributors are expected to follow our [Code of Conduct](coc).
1218

13-
## Pull request procedure
19+
[pound-rust-internals]: http://chat.mibbit.com/?server=irc.mozilla.org&channel=%23rust-internals
20+
[internals]: http://internals.rust-lang.org
21+
[coc]: http://www.rust-lang.org/conduct.html
1422

15-
Pull requests should be targeted at Rust's `master` branch.
16-
Before pushing to your Github repo and issuing the pull request,
17-
please do two things:
23+
## Feature Requests
1824

19-
1. [Rebase](http://git-scm.com/book/en/Git-Branching-Rebasing) your
20-
local changes against the `master` branch. Resolve any conflicts
21-
that arise.
25+
To request a change to the way that the Rust language works, please open an
26+
issue in the [RFCs repository](https://github.com/rust-lang/rfcs/issues/new)
27+
rather than this one. New features and other significant language changes
28+
must go through the RFC process.
2229

23-
2. Run the full Rust test suite with the `make check` command. You're
24-
not off the hook even if you just stick to documentation; code
25-
examples in the docs are tested as well! Although for simple
26-
wording or grammar fixes, this is probably unnecessary.
30+
## Bug Reports
2731

28-
Pull requests will be treated as "review requests", and we will give
29-
feedback we expect to see corrected on
30-
[style](http://aturon.github.io/) and
31-
substance before pulling. Changes contributed via pull request should
32-
focus on a single issue at a time, like any other. We will not accept
33-
pull-requests that try to "sneak" unrelated changes in.
32+
While bugs are unfortunate, they're a reality in software. We can't fix what we
33+
don't know about, so please report liberally. If you're not sure if something
34+
is a bug or not, feel free to file a bug anyway.
3435

35-
Normally, all pull requests must include regression tests (see
36-
[Note-testsuite](https://github.com/rust-lang/rust/wiki/Note-testsuite))
37-
that test your change. Occasionally, a change will be very difficult
38-
to test for. In those cases, please include a note in your commit
39-
message explaining why.
36+
If you have the chance, before reporting a bug, please [search existing
37+
issues](https://github.com/rust-lang/rust/search?q=&type=Issues&utf8=%E2%9C%93),
38+
as it's possible that someone else has already reported your error. This doesn't
39+
always work, and sometimes it's hard to know what to search for, so consider this
40+
extra credit. We won't mind if you accidentally file a duplicate report.
4041

41-
In the licensing header at the beginning of any files you change,
42-
please make sure the listed date range includes the current year. For
43-
example, if it's 2014, and you change a Rust file that was created in
44-
2010, it should begin:
42+
Opening an issue is as easy as following [this
43+
link](https://github.com/rust-lang/rust/issues/new) and filling out the fields.
44+
Here's a template that you can use to file a bug, though it's not necessary to
45+
use it exactly:
4546

46-
```
47-
// Copyright 2010-2014 The Rust Project Developers.
47+
<short summary of the bug>
48+
49+
I tried this code:
50+
51+
<code sample that causes the bug>
52+
53+
I expected to see this happen: <explanation>
54+
55+
Instead, this happened: <explanation>
56+
57+
## Meta
58+
59+
`rustc --version --verbose`:
60+
61+
Backtrace:
62+
63+
All three components are important: what you did, what you expected, what
64+
happened instead. Please include the output of `rustc --version --verbose`,
65+
which includes important information about what platform you're on, what
66+
version of Rust you're using, etc.
67+
68+
Sometimes, a backtrace is helpful, and so including that is nice. To get
69+
a backtrace, set the `RUST_BACKTRACE` environment variable. The easiest way
70+
to do this is to invoke `rustc` like this:
71+
72+
```bash
73+
$ RUST_BACKTRACE=1 rustc ...
4874
```
4975

50-
# Coordination and communication
76+
## Pull Requests
5177

52-
Get feedback from other developers on
53-
[internals.rust-lang.org][internals], and
54-
[#rust-internals][pound-rust-internals].
78+
Pull requests are the primary mechanism we use to change Rust. GitHub itself
79+
has some [great documentation][pull-requests] on using the Pull Request
80+
feature. We use the 'fork and pull' model described there.
5581

56-
[pound-rust-internals]: http://chat.mibbit.com/?server=irc.mozilla.org&channel=%23rust-internals
57-
[internals]: http://internals.rust-lang.org
82+
[pull-requests]: https://help.github.com/articles/using-pull-requests/
83+
84+
Please make pull requests against the `master` branch.
85+
86+
All pull requests are reviewed by another person. We have a bot,
87+
@rust-highfive, that will automatically assign a random person to review your request.
88+
89+
If you want to request that a specific person reviews your pull request,
90+
you can add an `r?` to the message. For example, Steve usually reviews
91+
documentation changes. So if you were to make a documentation change, add
92+
93+
r? @steveklabnik
94+
95+
to the end of the message, and @rust-highfive will assign @steveklabnik instead
96+
of a random person. This is entirely optional.
97+
98+
After someone has reviewed your pull request, they will leave an annotation
99+
on the pull request with an `r+`. It will look something like this:
100+
101+
@bors: r+ 38fe8d2
102+
103+
This tells @bors, our lovable integration bot, that your pull request has
104+
been approved. The PR then enters the [merge queue][merge-queue], where @bors
105+
will run all the tests on every platform we support. If it all works out,
106+
@bors will merge your code into `master` and close the pull request.
107+
108+
[merge-queue]: http://buildbot.rust-lang.org/homu/queue/rust
109+
110+
## Writing Documentation
111+
112+
Documentation improvements are very welcome. The source of `doc.rust-lang.org`
113+
is located in `src/doc` in the tree, and standard API documentation is generated
114+
from the source code itself.
115+
116+
Documentation pull requests function in the same as other pull requests, though
117+
you may see a slightly different form of `r+`:
118+
119+
@bors: r+ 38fe8d2 rollup
120+
121+
That additional `rollup` tells @bors that this change is eligible for a 'rollup'.
122+
To save @bors some work, and to get small changes through more quickly, when
123+
@bors attempts to merge a commit that's rollup-eligible, it will also merge
124+
the other rollup-eligible patches too, and they'll get tested and merged at
125+
the same time.
126+
127+
## Issue Triage
128+
129+
Sometimes, an issue will stay open, even though the bug has been fixed. And
130+
sometimes, the original bug may go stale because something has changed in the
131+
meantime.
132+
133+
It can be helpful to go through older bug reports and make sure that they are
134+
still valid. Load up an older issue, double check that it's still true, and
135+
leave a comment letting us know if it is or is not. The [least recently updated sort][lru] is good for finding issues like this.
136+
137+
[lru]: https://github.com/rust-lang/rust/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-asc
138+
139+
## Out-of-tree Contributions
140+
141+
There are a number of other ways to contribute to Rust that don't deal with
142+
this repository.
143+
144+
Answer questions in [#rust][pound-rust], or on [users.rust-lang.org][users],
145+
or on [StackOverflow][so].
146+
147+
Participate in the [RFC process](https://github.com/rust-lang/rfcs).
148+
149+
Find a [requested community library][community-library], build it, and publish
150+
it to [Crates.io](http://crates.io). Easier said than done, but very, very
151+
valuable!
58152

59-
For more details, please refer to
60-
[Note-development-policy](https://github.com/rust-lang/rust/wiki/Note-development-policy).
153+
[pound-rust]: http://chat.mibbit.com/?server=irc.mozilla.org&channel=%23rust
154+
[users]: http://users.rust-lang.org/
155+
[so]: http://stackoverflow.com/questions/tagged/rust
156+
[community-library]: https://github.com/rust-lang/rfcs/labels/A-community-library

README.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ Read ["Installing Rust"][install] from [The Book][trpl].
1818
* GNU `make` 3.81 or later
1919
* `curl`
2020
* `git`
21+
2122
2. Download and build Rust:
2223

2324
You can either download a [tarball] or build directly from the [repo].
@@ -97,19 +98,21 @@ There is a lot more documentation in the [wiki].
9798

9899
[wiki]: https://github.com/rust-lang/rust/wiki
99100

100-
## Getting help and getting involved
101+
## Getting help
101102

102103
The Rust community congregates in a few places:
103104

104105
* [StackOverflow] - Direct questions about using the language here.
105106
* [users.rust-lang.org] - General discussion, broader questions.
106-
* [internals.rust-lang.org] - For development of the Rust language itself.
107107
* [/r/rust] - News and general discussion.
108108

109109
[StackOverflow]: http://stackoverflow.com/questions/tagged/rust
110110
[/r/rust]: http://reddit.com/r/rust
111111
[users.rust-lang.org]: http://users.rust-lang.org/
112-
[internals.rust-lang.org]: http://internals.rust-lang.org/
112+
113+
## Contributing
114+
115+
To contribute to Rust, please see [CONTRIBUTING.md](CONTRIBUTING.md).
113116

114117
## License
115118

mk/docs.mk

+8-2
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
# L10N_LANGS are the languages for which the docs have been
2626
# translated.
2727
######################################################################
28-
DOCS := index intro tutorial complement-bugreport \
28+
DOCS := index intro tutorial \
2929
complement-lang-faq complement-design-faq complement-project-faq \
3030
rustdoc reference grammar
3131

@@ -73,7 +73,7 @@ RUSTBOOK = $(RPATH_VAR2_T_$(CFG_BUILD)_H_$(CFG_BUILD)) $(RUSTBOOK_EXE)
7373

7474
D := $(S)src/doc
7575

76-
DOC_TARGETS := trpl
76+
DOC_TARGETS := trpl style
7777
COMPILER_DOC_TARGETS :=
7878
DOC_L10N_TARGETS :=
7979

@@ -275,3 +275,9 @@ trpl: doc/book/index.html
275275
doc/book/index.html: $(RUSTBOOK_EXE) $(wildcard $(S)/src/doc/trpl/*.md) | doc/
276276
$(Q)rm -rf doc/book
277277
$(Q)$(RUSTBOOK) build $(S)src/doc/trpl doc/book
278+
279+
style: doc/style/index.html
280+
281+
doc/style/index.html: $(RUSTBOOK_EXE) $(wildcard $(S)/src/doc/style/*.md) | doc/
282+
$(Q)rm -rf doc/style
283+
$(Q)$(RUSTBOOK) build $(S)src/doc/style doc/style

src/compiletest/compiletest.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@
1313
#![feature(box_syntax)]
1414
#![feature(collections)]
1515
#![feature(int_uint)]
16-
#![feature(io)]
17-
#![feature(path)]
16+
#![feature(old_io)]
17+
#![feature(old_path)]
1818
#![feature(rustc_private)]
1919
#![feature(unboxed_closures)]
2020
#![feature(std_misc)]

src/compiletest/runtest.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ use std::env;
3535
use std::iter::repeat;
3636
use std::str;
3737
use std::string::String;
38-
use std::thread::Thread;
38+
use std::thread;
3939
use std::time::Duration;
4040
use test::MetricMap;
4141

@@ -458,7 +458,7 @@ fn run_debuginfo_gdb_test(config: &Config, props: &TestProps, testfile: &Path) {
458458
loop {
459459
//waiting 1 second for gdbserver start
460460
timer::sleep(Duration::milliseconds(1000));
461-
let result = Thread::scoped(move || {
461+
let result = thread::spawn(move || {
462462
tcp::TcpStream::connect("127.0.0.1:5039").unwrap();
463463
}).join();
464464
if result.is_err() {

src/doc/complement-bugreport.md

-61
This file was deleted.

src/doc/reference.md

+7
Original file line numberDiff line numberDiff line change
@@ -2398,6 +2398,10 @@ The currently implemented features of the reference compiler are:
23982398
ways insufficient for concatenating identifiers, and may be
23992399
removed entirely for something more wholesome.
24002400

2401+
* `custom_attribute` - Allows the usage of attributes unknown to the compiler
2402+
so that new attributes can be added in a bacwards compatible
2403+
manner (RFC 572).
2404+
24012405
* `intrinsics` - Allows use of the "rust-intrinsics" ABI. Compiler intrinsics
24022406
are inherently unstable and no promise about them is made.
24032407

@@ -2458,6 +2462,9 @@ The currently implemented features of the reference compiler are:
24582462
implemented very poorly and will likely change significantly
24592463
with a proper implementation.
24602464

2465+
* `rustc_attrs` - Gates internal `#[rustc_*]` attributes which may be
2466+
for internal use only or have meaning added to them in the future.
2467+
24612468
* `rustc_diagnostic_macros`- A mysterious feature, used in the implementation
24622469
of rustc, not meant for mortals.
24632470

0 commit comments

Comments
 (0)