Skip to content

Markdown cleanup #40309

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

Closed
wants to merge 20 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
7b04f7f
rustbuild: Fix compiler docs
ollie27 Mar 12, 2017
0e0bac9
rustbuild: Fix tests
ollie27 Mar 12, 2017
19e0505
rustdoc: Fix string escaping in implementors js files
ollie27 Mar 12, 2017
9b8b3b2
rustbuild: Add option for enabling partial LLVM rebuilds
petrochenkov Mar 7, 2017
362aa9a
Default llvm.clean-rebuild to false
petrochenkov Mar 8, 2017
4cda4d6
Allow cleaning llvm build dir to fail
alexcrichton Mar 10, 2017
9eff235
Fix a typo in Rev docs
Mar 12, 2017
c433f5e
A couple of sentence edits for grammar, and some line length tweaks for
iangneal Mar 6, 2017
8b8df62
Tiding up the CONTRIBUTING.md document.
iangneal Mar 6, 2017
295df14
Fixed markdown syntax error.
iangneal Mar 8, 2017
75fb56f
Auto merge of #40448 - ollie27:rustbuild_docs_compiler, r=alexcrichton
bors Mar 13, 2017
40e5b18
Auto merge of #40461 - stjepang:iterator-typo, r=frewsxcv
bors Mar 13, 2017
32c9893
emit !align attributes on stores of operand pairs
arielb1 Mar 9, 2017
ddc1708
Auto merge of #40385 - arielb1:packed-again, r=eddyb
bors Mar 13, 2017
a5483a7
Auto merge of #40451 - ollie27:rustdoc_impls_js_escape, r=GuillaumeGomez
bors Mar 13, 2017
fd182c4
Auto merge of #40329 - petrochenkov:llreuse, r=alexcrichton
bors Mar 13, 2017
6b02b01
A couple of sentence edits for grammar, and some line length tweaks for
iangneal Mar 6, 2017
01baed6
Tiding up the CONTRIBUTING.md document.
iangneal Mar 6, 2017
03f5cb8
Fixed markdown syntax error.
iangneal Mar 8, 2017
7f4850a
Merge branch 'master' of github.com:Dahca/rust
iangneal Mar 14, 2017
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
70 changes: 39 additions & 31 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Contributing to Rust

Thank you for your interest in contributing to Rust! There are many ways to
contribute, and we appreciate all of them. This document is a bit long, so here's
links to the major sections:
contribute, and we appreciate all of them. This document is a bit long, so here
are some links to the major sections:

* [Feature Requests](#feature-requests)
* [Bug Reports](#bug-reports)
Expand All @@ -13,10 +13,12 @@ links to the major sections:
* [Out-of-tree Contributions](#out-of-tree-contributions)
* [Helpful Links and Information](#helpful-links-and-information)

If you have questions, please make a post on [internals.rust-lang.org][internals] or
hop on [#rust-internals][pound-rust-internals].
If you have questions, please make a post on
[internals.rust-lang.org][internals] or hop on
[#rust-internals][pound-rust-internals].

As a reminder, all contributors are expected to follow our [Code of Conduct][coc].
As a reminder, all contributors are expected to follow our
[Code of Conduct][coc].

[pound-rust-internals]: http://chat.mibbit.com/?server=irc.mozilla.org&channel=%23rust-internals
[internals]: https://internals.rust-lang.org
Expand All @@ -35,14 +37,15 @@ While bugs are unfortunate, they're a reality in software. We can't fix what we
don't know about, so please report liberally. If you're not sure if something
is a bug or not, feel free to file a bug anyway.

**If you believe reporting your bug publicly represents a security risk to Rust users,
please follow our [instructions for reporting security vulnerabilities](https://www.rust-lang.org/security.html)**.
**If you believe reporting your bug publicly represents a security risk to Rust
users, please follow our [instructions for reporting security vulnerabilities]
(https://www.rust-lang.org/security.html)**.

If you have the chance, before reporting a bug, please [search existing
issues](https://github.com/rust-lang/rust/search?q=&type=Issues&utf8=%E2%9C%93),
as it's possible that someone else has already reported your error. This doesn't
always work, and sometimes it's hard to know what to search for, so consider this
extra credit. We won't mind if you accidentally file a duplicate report.
always work, and sometimes it's hard to know what to search for, so consider
this extra credit. We won't mind if you accidentally file a duplicate report.

Opening an issue is as easy as following [this
link](https://github.com/rust-lang/rust/issues/new) and filling out the fields.
Expand Down Expand Up @@ -99,12 +102,12 @@ Before you can start building the compiler you need to configure the build for
your system. In most cases, that will just mean using the defaults provided
for Rust.

To change configuration, you must copy the file `src/bootstrap/config.toml.example`
to `config.toml` in the directory from which you will be running the build, and
change the settings provided.
To change configuration, you must copy the file
`src/bootstrap/config.toml.example` to `config.toml` in the directory from which
you will be running the build, and change the settings provided.

There are large number of options provided in this config file that will alter the
configuration used in the build process. Some options to note:
There are large number of options provided in this config file that will alter
the configuration used in the build process. Some options to note:

#### `[llvm]`:
- `ccache = true` - Use ccache when building llvm
Expand All @@ -114,7 +117,8 @@ configuration used in the build process. Some options to note:

#### `[rust]`:
- `debuginfo = true` - Build a compiler with debuginfo
- `optimize = false` - Disable optimizations to speed up compilation of stage1 rust
- `optimize = false` - Disable optimizations to speed up compilation of stage1
rust

For more options, the `config.toml` file contains commented out defaults, with
descriptions of what each option will do.
Expand All @@ -126,9 +130,9 @@ file. If you still have a `config.mk` file in your directory - from

### Building

The build system uses the `x.py` script to control the build process. This script
is used to build, test, and document various parts of the compiler. You can
execute it as:
The build system uses the `x.py` script to control the build process. This
script is used to build, test, and document various parts of the compiler. You
can execute it as:

```sh
python x.py build
Expand Down Expand Up @@ -262,7 +266,8 @@ guidelines by running
$ python x.py test src/tools/tidy

Make this check before every pull request (and every new commit in a pull
request) ; you can add [git hooks](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks)
request) ; you can add
[git hooks](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks)
before every push to make sure you never forget to make this check.

All pull requests are reviewed by another person. We have a bot,
Expand Down Expand Up @@ -305,20 +310,20 @@ though you may see a slightly different form of `r+`:

@bors: r+ 38fe8d2 rollup

That additional `rollup` tells @bors that this change is eligible for a 'rollup'.
To save @bors some work, and to get small changes through more quickly, when
@bors attempts to merge a commit that's rollup-eligible, it will also merge
the other rollup-eligible patches too, and they'll get tested and merged at
the same time.
That additional `rollup` tells @bors that this change is eligible for a
'rollup'. To save @bors some work, and to get small changes through more
quickly, when @bors attempts to merge a commit that's rollup-eligible, it will
also merge the other rollup-eligible patches too, and they'll get tested and
merged at the same time.

To find documentation-related issues, sort by the [A-docs label][adocs].

[adocs]: https://github.com/rust-lang/rust/issues?q=is%3Aopen+is%3Aissue+label%3AA-docs

In many cases, you don't need a full `./x.py doc`. You can use `rustdoc` directly
to check small fixes. For example, `rustdoc src/doc/reference.md` will render
reference to `doc/reference.html`. The CSS might be messed up, but you can
verify that the HTML is right.
In many cases, you don't need a full `./x.py doc`. You can use `rustdoc`
directly to check small fixes. For example, `rustdoc src/doc/reference.md` will
render reference to `doc/reference.html`. The CSS might be messed up, but you
can verify that the HTML is right.

## Issue Triage

Expand Down Expand Up @@ -392,12 +397,15 @@ are:
* The [Rust Internals forum][rif], a place to ask questions and
discuss Rust's internals
* The [generated documentation for rust's compiler][gdfrustc]
* The [rust reference][rr], even though it doesn't specifically talk about Rust's internals, it's a great resource nonetheless
* The [rust reference][rr], even though it doesn't specifically talk about
Rust's internals, it's a great resource nonetheless
* Although out of date, [Tom Lee's great blog article][tlgba] is very helpful
* [rustaceans.org][ro] is helpful, but mostly dedicated to IRC
* The [Rust Compiler Testing Docs][rctd]
* For @bors, [this cheat sheet][cheatsheet] is helpful (Remember to replace `@homu` with `@bors` in the commands that you use.)
* **Google!** ([search only in Rust Documentation][gsearchdocs] to find types, traits, etc. quickly)
* For @bors, [this cheat sheet][cheatsheet] is helpful (Remember to replace
`@homu` with `@bors` in the commands that you use.)
* **Google!** ([search only in Rust Documentation][gsearchdocs] to find types,
traits, etc. quickly)
* Don't be afraid to ask! The Rust community is friendly and helpful.

[gdfrustc]: http://manishearth.github.io/rust-internals-docs/rustc/
Expand Down
9 changes: 4 additions & 5 deletions COPYRIGHT
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,7 @@ terms.

Longer version:

The Rust Project is copyright 2010, The Rust Project
Developers.
The Rust Project is copyright 2010, The Rust Project Developers.

Licensed under the Apache License, Version 2.0
<LICENSE-APACHE or
Expand Down Expand Up @@ -270,9 +269,9 @@ their own copyright notices and license terms:
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice(s),
this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice(s),
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
2. Redistributions in binary form must reproduce the above copyright
notice(s), this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S)
``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
Expand Down
73 changes: 44 additions & 29 deletions RELEASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -305,7 +305,8 @@ Cargo
* [Fix retrying crate downloads for network errors][cargo/3348]
* [Implement string lookup for `build.rustflags` config key][cargo/3356]
* [Emit more info on --message-format=json][cargo/3319]
* [Assume `build.rs` in the same directory as `Cargo.toml` is a build script][cargo/3361]
* [Assume `build.rs` in the same directory as `Cargo.toml` is a build
script][cargo/3361]
* [Don't ignore errors in workspace manifest][cargo/3409]
* [Fix `--message-format JSON` when rustc emits non-JSON warnings][cargo/3410]

Expand All @@ -330,8 +331,8 @@ Misc
* [Rust supports i686-unknown-openbsd][38086]. Tier 3 support. No testing or
releases.
* [Rust supports the MSP430][37627]. Tier 3 support. No testing or releases.
* [Rust supports the ARMv5TE architecture][37615]. Tier 3 support. No testing or
releases.
* [Rust supports the ARMv5TE architecture][37615]. Tier 3 support. No testing
or releases.

Compatibility Notes
-------------------
Expand Down Expand Up @@ -923,13 +924,16 @@ Version 1.12.1 (2016-10-20)
Regression Fixes
----------------

* [ICE: 'rustc' panicked at 'assertion failed: concrete_substs.is_normalized_for_trans()' #36381][36381]
* [ICE: 'rustc' panicked at 'assertion failed: concrete_substs.is_normalized_
for_trans()' #36381][36381]
* [Confusion with double negation and booleans][36856]
* [rustc 1.12.0 fails with SIGSEGV in release mode (syn crate 0.8.0)][36875]
* [Rustc 1.12.0 Windows build of `ethcore` crate fails with LLVM error][36924]
* [1.12.0: High memory usage when linking in release mode with debug info][36926]
* [1.12.0: High memory usage when linking in release mode with debug
info][36926]
* [Corrupted memory after updated to 1.12][36936]
* ["Let NullaryConstructor = something;" causes internal compiler error: "tried to overwrite interned AdtDef"][37026]
* ["Let NullaryConstructor = something;" causes internal compiler error: "tried
to overwrite interned AdtDef"][37026]
* [Fix ICE: inject bitcast if types mismatch for invokes/calls/stores][37112]
* [debuginfo: Handle spread_arg case in MIR-trans in a more stable way.][37153]

Expand Down Expand Up @@ -1165,7 +1169,7 @@ Tooling
* [Test binaries now support a `--test-threads` argument to specify the number
of threads used to run tests, and which acts the same as the
`RUST_TEST_THREADS` environment variable]
(https://github.com/rust-lang/rust/pull/35414)
(https://github.com/rust-lang/rust/pull/35414)
* [The test runner now emits a warning when tests run over 60 seconds]
(https://github.com/rust-lang/rust/pull/35405)
* [rustdoc: Fix methods in search results]
Expand Down Expand Up @@ -2217,15 +2221,22 @@ Libraries
be the same length
* `<[T]>::`[`sort_by_key`]
* checked, saturated, and overflowing operations
* [`i32::checked_rem`], [`i32::checked_neg`], [`i32::checked_shl`], [`i32::checked_shr`]
* [`i32::checked_rem`], [`i32::checked_neg`], [`i32::checked_shl`],
[`i32::checked_shr`]
* [`i32::saturating_mul`]
* [`i32::overflowing_add`], [`i32::overflowing_sub`], [`i32::overflowing_mul`], [`i32::overflowing_div`]
* [`i32::overflowing_rem`], [`i32::overflowing_neg`], [`i32::overflowing_shl`], [`i32::overflowing_shr`]
* [`u32::checked_rem`], [`u32::checked_neg`], [`u32::checked_shl`], [`u32::checked_shl`]
* [`i32::overflowing_add`], [`i32::overflowing_sub`],
[`i32::overflowing_mul`], [`i32::overflowing_div`]
* [`i32::overflowing_rem`], [`i32::overflowing_neg`],
[`i32::overflowing_shl`], [`i32::overflowing_shr`]
* [`u32::checked_rem`], [`u32::checked_neg`], [`u32::checked_shl`],
[`u32::checked_shl`]
* [`u32::saturating_mul`]
* [`u32::overflowing_add`], [`u32::overflowing_sub`], [`u32::overflowing_mul`], [`u32::overflowing_div`]
* [`u32::overflowing_rem`], [`u32::overflowing_neg`], [`u32::overflowing_shl`], [`u32::overflowing_shr`]
* and checked, saturated, and overflowing operations for other primitive types
* [`u32::overflowing_add`], [`u32::overflowing_sub`],
[`u32::overflowing_mul`], [`u32::overflowing_div`]
* [`u32::overflowing_rem`], [`u32::overflowing_neg`],
[`u32::overflowing_shl`], [`u32::overflowing_shr`]
* and checked, saturated, and overflowing operations for other primitive
types
* FFI
* [`ffi::IntoStringError`]
* [`CString::into_string`]
Expand Down Expand Up @@ -3321,7 +3332,8 @@ Highlights
access to all underlying information.
* The compiler now contains extended explanations of many errors. When an error
with an explanation occurs the compiler suggests using the `--explain` flag
to read the explanation. Error explanations are also [available online][err-index].
to read the explanation. Error explanations are also
[available online][err-index].
* Thanks to multiple [improvements][sk] to [type checking][pre], as
well as other work, the time to bootstrap the compiler decreased by
32%.
Expand Down Expand Up @@ -4156,7 +4168,8 @@ Version 0.10 (2014-04-03)
* Trailing commas are now allowed in argument lists and tuple patterns.
* The `do` keyword has been removed, it is now a reserved keyword.
* Default type parameters have been implemented, but are feature gated.
* Borrowed variables through captures in closures are now considered soundly.
* Borrowed variables through captures in closures are now considered
soundly.
* `extern mod` is now `extern crate`
* The `Freeze` trait has been removed.
* The `Share` trait has been added for types that can be shared among
Expand Down Expand Up @@ -4187,8 +4200,8 @@ Version 0.10 (2014-04-03)
* std: The `vec` module has been renamed to `slice`.
* std: A new vector type, `Vec<T>`, has been added in preparation for DST.
This will become the only growable vector in the future.
* std: `std::io` now has more public-reexports. Types such as `BufferedReader`
are now found at `std::io::BufferedReader` instead of
* std: `std::io` now has more public-reexports. Types such as
`BufferedReader` are now found at `std::io::BufferedReader` instead of
`std::io::buffered::BufferedReader`.
* std: `print` and `println` are no longer in the prelude, the `print!` and
`println!` macros are intended to be used instead.
Expand All @@ -4210,7 +4223,8 @@ Version 0.10 (2014-04-03)
can be found on the wiki's style guide.
* std: `eof()` has been removed from the `Reader` trait. Specific types may
still implement the function.
* std: Networking types are now cloneable to allow simultaneous reads/writes.
* std: Networking types are now cloneable to allow simultaneous
reads/writes.
* std: `assert_approx_eq!` has been removed
* std: The `e` and `E` formatting specifiers for floats have been added to
print them in exponential notation.
Expand Down Expand Up @@ -4331,24 +4345,25 @@ Version 0.9 (2014-01-09)
* Comments may be nested.
* Values automatically coerce to trait objects they implement, without
an explicit `as`.
* Enum discriminants are no longer an entire word but as small as needed to
contain all the variants. The `repr` attribute can be used to override
the discriminant size, as in `#[repr(int)]` for integer-sized, and
`#[repr(C)]` to match C enums.
* Enum discriminants are no longer an entire word but as small as needed
to contain all the variants. The `repr` attribute can be used to
override the discriminant size, as in `#[repr(int)]` for integer-sized,
and `#[repr(C)]` to match C enums.
* Non-string literals are not allowed in attributes (they never worked).
* The FFI now supports variadic functions.
* Octal numeric literals, as in `0o7777`.
* The `concat!` syntax extension performs compile-time string concatenation.
* The `concat!` syntax extension performs compile-time string
concatenation.
* The `#[fixed_stack_segment]` and `#[rust_stack]` attributes have been
removed as Rust no longer uses segmented stacks.
* Non-ascii identifiers are feature-gated (`#[feature(non_ascii_idents)]`).
* Ignoring all fields of an enum variant or tuple-struct is done with `..`,
not `*`; ignoring remaining fields of a struct is also done with `..`,
not `_`; ignoring a slice of a vector is done with `..`, not `.._`.
* Ignoring all fields of an enum variant or tuple-struct is done with
`..`, not `*`; ignoring remaining fields of a struct is also done with
`..`, not `_`; ignoring a slice of a vector is done with `..`, not `.._`.
* `rustc` supports the "win64" calling convention via `extern "win64"`.
* `rustc` supports the "system" calling convention, which defaults to the
preferred convention for the target platform, "stdcall" on 32-bit Windows,
"C" elsewhere.
preferred convention for the target platform, "stdcall" on 32-bit
Windows, "C" elsewhere.
* The `type_overflow` lint (default: warn) checks literals for overflow.
* The `unsafe_block` lint (default: allow) checks for usage of `unsafe`.
* The `attribute_usage` lint (default: warn) warns about unknown
Expand Down
8 changes: 4 additions & 4 deletions appveyor.yml
Original file line number Diff line number Diff line change
Expand Up @@ -144,10 +144,10 @@ on_failure:
- cat %CD%/sccache.log

cache:
- "build/i686-pc-windows-msvc/llvm -> src/rustllvm/llvm-auto-clean-trigger"
- "build/x86_64-pc-windows-msvc/llvm -> src/rustllvm/llvm-auto-clean-trigger"
- "i686-pc-windows-msvc/llvm -> src/rustllvm/llvm-auto-clean-trigger"
- "x86_64-pc-windows-msvc/llvm -> src/rustllvm/llvm-auto-clean-trigger"
- "build/i686-pc-windows-msvc/llvm -> src/rustllvm/llvm-rebuild-trigger"
- "build/x86_64-pc-windows-msvc/llvm -> src/rustllvm/llvm-rebuild-trigger"
- "i686-pc-windows-msvc/llvm -> src/rustllvm/llvm-rebuild-trigger"
- "x86_64-pc-windows-msvc/llvm -> src/rustllvm/llvm-rebuild-trigger"

branches:
only:
Expand Down
1 change: 1 addition & 0 deletions configure
Original file line number Diff line number Diff line change
Expand Up @@ -437,6 +437,7 @@ opt local-rust 0 "use an installed rustc rather than downloading a snapshot"
opt local-rebuild 0 "assume local-rust matches the current version, for rebuilds; implies local-rust, and is implied if local-rust already matches the current version"
opt llvm-static-stdcpp 0 "statically link to libstdc++ for LLVM"
opt llvm-link-shared 0 "prefer shared linking to LLVM (llvm-config --link-shared)"
opt llvm-clean-rebuild 0 "delete LLVM build directory on rebuild"
opt rpath 1 "build rpaths into rustc itself"
opt stage0-landing-pads 1 "enable landing pads during bootstrap with stage0"
# This is used by the automation to produce single-target nightlies
Expand Down
Loading