Commit Graph

131 Commits

Author SHA1 Message Date
kennytm 3a037f113c Rollup merge of #44935 - vitiral:dependencies, r=steveklabnik
Add links to headers in README and CONTRIBUTING

this also adds dependencies to CONTRIBUTING

I'm just getting started building the rust compiler and noticed this information/ability was missing.

It was also missing the gdb dependency for running tests. I pulled the information out of `appveyor.yml` and recommended later than 7.1 because that is what [apt ships](https://packages.ubuntu.com/search?suite=trusty&keywords=gdb). Feel free to tell me something different!
2017-10-05 20:22:30 +08:00
Suriyaa ✌️️ 2d108ec00b Use HTTPS protocol for `chat.mibbit.com` 2017-10-03 12:36:16 +02:00
Michal Budzynski e6c3c7f2dc Corrected the CONTRIBUTING.md "External Dependencies" section 2017-10-02 00:18:19 +02:00
Garrett Berg daf3ed5651 Add links to headers in README and CONTRIBUTING and dependencies to CONTRIBUTING 2017-09-29 17:44:55 -06:00
Corey Farwell bbd8ac59fa Rollup merge of #44776 - spastorino:add_forge, r=nikomatsakis
Link to Rust forge from CONTRIBUTING.md
2017-09-23 00:29:22 -04:00
Niko Matsakis 9276b8b9b8 expand text, make link to forge more prominent 2017-09-22 16:27:55 -04:00
Santiago Pastorino 84dfade3cc Link to Rust forge from CONTRIBUTING.md 2017-09-22 17:16:03 -03:00
Oliver Schneider d64a067423
Add clippy to `toolstate.toml` 2017-09-19 09:20:35 +02:00
Carol (Nichols || Goulding) 28fc93fc43 Add explanations for undocumented labels 2017-09-10 13:31:08 -04:00
Carol (Nichols || Goulding) 69b949455d Alphabetize current label explanations
So that you can scroll down the list of labels along with these
explanations.
2017-09-10 13:21:37 -04:00
bors 088216fb99 Auto merge of #44194 - QuietMisdreavus:hey-how-do-i-use-this-new-fangled-thing, r=aturon
expand on using rustup custom toolchains in CONTRIBUTING.md

fixes #42484

Should i include more notes about how to use a local build *without* rustup? It can kinda feel like a cop-out otherwise. Other means that come to mind are setting `$RUSTC` directly and fully installing it.

cc @rust-lang/docs
2017-09-04 10:33:53 +00:00
bors 204c0a47e7 Auto merge of #43886 - oli-obk:clippy, r=nrc
Add clippy as a submodule

~~This builds clippy as part of `./x.py build` (locally and in CI).~~

This allows building clippy with `./x.py build src/tools/clippy`

~~Needs https://github.com/nrc/dev-tools-team/issues/18#issuecomment-322456461 to be resolved before it can be merged.~~ Contributers can simply open a PR to clippy and point the submodule at the `pull/$pr_number/head` branch.

This does **not** build clippy or test the clippy test suite at all as per https://github.com/nrc/dev-tools-team/issues/18#issuecomment-321411418

r? @nrc

cc @Manishearth @llogiq @mcarton @alexcrichton
2017-09-02 17:17:14 +00:00
QuietMisdreavus 1615d3502c expand on using rustup custom toolchains in CONTRIBUTING.md
fixes #42484
2017-08-30 17:06:12 -05:00
Corey Farwell c7cd79b58f Fix broken homu link in CONTRIBUTING.md.
Fixes the docs aspect of https://github.com/rust-lang/rust/issues/43898.
2017-08-20 21:24:14 -04:00
Oliver Schneider 93a9183256 Update workflow to git oddities 2017-08-15 18:32:04 +02:00
Oliver Schneider f46777696c Fetch the pull request before checkout 2017-08-15 18:14:16 +02:00
Oliver Schneider 49fca85b19 Document the process of updating external dependencies 2017-08-15 18:06:10 +02:00
bors 0269acbb10 Auto merge of #43820 - sfackler:move-config-template, r=alexcrichton
Move config.toml.example to the root dir

It's way more discoverable here.

r? @alexcrichton
2017-08-12 16:48:31 +00:00
Tej Chajed a746129bdb
Update GitHub pull request documentation link 2017-08-12 12:34:49 +01:00
Steven Fackler 1126a85e87 Move config.toml.example to the root dir
It's way more discoverable here.
2017-08-11 22:24:25 -07:00
Sam Cappleman-Lynes c329311b54 Update merge queue link 2017-07-17 11:57:26 +01:00
Kornel 1297b2d952 Suggest rustup toolchain link 2017-07-06 12:26:34 +01:00
faso bf2e0c2fe1 Typo 2017-05-16 10:56:07 +03:00
lukaramu 7643ccd29c Split paragraph in CONTRIBUTING.md 2017-03-24 21:28:59 +01:00
lukaramu 3b0add459c Update CONTRIBUTING.md
Changed link to documentation issues from A-docs to T-doc as this has just been migrated.
Added a link to the documentation style guidelines.
2017-03-24 21:16:00 +01:00
CrazyMerlyn b5533d2953 Update link to COMPILER_TESTS.md in CONTRIBUTING.md 2017-03-07 23:13:31 +05:30
Josh Driver fb2d763eee Replace ./configure with config.toml in README.md and CONTRIBUTING.md 2017-02-28 21:40:00 +10:30
Glyne J. Gittens b3f61ce538 Removed a typo from CONTRIBUTING.md 2017-02-19 17:30:50 -05:00
Alex Crichton 77c3bfa742 std: Remove cfg(cargobuild) annotations
These are all now no longer needed that we've only got rustbuild in tree.
2017-02-06 08:42:54 -08:00
Seo Sanghyeon 8ed52ed27d Document --test-args for rustbuild 2016-12-14 01:31:48 +09:00
Alex Crichton 0e272de69f mk: Switch rustbuild to the default build system
This commit switches the default build system for Rust from the makefiles to
rustbuild. The rustbuild build system has been in development for almost a year
now and has become quite mature over time. This commit is an implementation of
the proposal on [internals] which slates deletion of the makefiles on
2016-01-02.

[internals]: https://internals.rust-lang.org/t/proposal-for-promoting-rustbuild-to-official-status/4368

This commit also updates various documentation in `README.md`,
`CONTRIBUTING.md`, `src/bootstrap/README.md`, and throughout the source code of
rustbuild itself.

Closes #37858
2016-12-07 00:30:23 -08:00
Cobrand 9d9c029a66 doc: Contributing.md: mention of `make tidy` 2016-09-03 12:51:16 +02:00
Amit Levy 4b6477f062 Minor type in CONTRIBUTING.md
A single missing article
2016-08-21 22:42:33 -04:00
flo-l 4e87986514 add documentation on howto build just rustc without libstd to the build system 2016-06-05 21:03:38 +02:00
Sebastian Thiel eface32e41 Add `make tips` as useful make target
By accident, I found the `make tips` target, which helped me to gain more insight on how to work with the system more quickly.
2016-05-26 10:08:45 +02:00
Florian Berger daa48a294f Fix link in contributing page 2016-04-15 22:28:32 +03:00
Emanuel Czirai e1d2eda7f3 allow RUST_BACKTRACE=0 to act as if unset
/# This is a combination of 16 commits.
/# The first commit's message is:
allow RUST_BACKTRACE=disabled to act as if unset

When RUST_BACKTRACE is set to "disabled" then this acts as if the env.
var is unset.

/# This is the 2nd commit message:

case insensitive "DiSaBLeD" RUST_BACKTRACE value

previously it expected a lowercase "disabled" to treat the env. var as
unset

/# This is the 3rd commit message:

RUST_BACKTRACE=0 acts as if unset

previously RUST_BACKTRACE=disabled was doing the same thing

/# This is the 4th commit message:

RUST_BACKTRACE=0|n|no|off acts as if unset

previously only RUST_BACKTRACE=0 acted as if RUST_BACKTRACE was unset
Now added more options (case-insensitive): 'n','no' and 'off'
eg. RUST_BACKTRACE=oFF

/# This is the 5th commit message:

DRY on the value of 2

DRY=don't repeat yourself
Because having to remember to keep the two places of '2' in sync is not
ideal, even though this is a simple enough case.

/# This is the 6th commit message:

Revert "DRY on the value of 2"

This reverts commit 95a0479d5cf72a2b2d9d21ec0bed2823ed213fef.

Nevermind this DRY on 2, because we already have a RY on 1,
besides the code is less readable this way...

/# This is the 7th commit message:

attempt to document unsetting RUST_BACKTRACE

/# This is the 8th commit message:

curb allocations when checking for RUST_BACKTRACE

this means we don't check for case-insensitivity anymore

/# This is the 9th commit message:

as decided, RUST_BACKTRACE=0 turns off backtrace

/# This is the 10th commit message:

RUST_TEST_NOCAPTURE=0 acts as if unset

(that is, capture is on)

Any other value acts as if nocapture is enabled (that is, capture is off)

/# This is the 11th commit message:

update other RUST_TEST_NOCAPTURE occurrences

apparently only one place needs updating

/# This is the 12th commit message:

update RUST_BACKTRACE in man page

/# This is the 13th commit message:

handle an occurrence of RUST_BACKTRACE

/# This is the 14th commit message:

ensure consistency with new rules for backtrace

/# This is the 15th commit message:

a more concise comment for RUST_TEST_NOCAPTURE

/# This is the 16th commit message:

update RUST_TEST_NOCAPTURE in man page
2016-03-31 23:02:59 +02:00
Florian Berger ccafdae9a1 Remove trailing whitespace at the end of lines 2016-03-22 19:31:39 +02:00
Ryan Thomas df31868cac Update TESTNAME description 2016-02-02 10:58:59 +11:00
Ryan Thomas a5e491fa92 Update TESTNAME matching description 2016-02-02 10:57:24 +11:00
Ryan Thomas a58d3303f2 Update docs about how to run specific tests 2016-02-01 17:04:39 +11:00
Greg Chapple 05f7b59352 Re-worded intro paragraph to be more positive 2016-01-26 14:44:27 +00:00
Greg Chapple 6fd728db6d Updated to reflect comments from review
- Tweaked the build system intro paragraph
- Added some more configure options & explanations
- Added additional make target
2016-01-26 14:29:26 +00:00
Greg Chapple dc6ed63655 Added info on the build system to contributing guide
I recently wrote a blog post on contributing to the Rust compiler which
gained some interest. It was mentioned in a comment on Reddit that it
would be useful to integrate some of the information from that post to
the official contributing guide.

This is the start of my efforts to integrate what I wrote with the
official guide.

This commit adds information on the build system. It is not a complete
guide on the build system, but it should be enough to provide a good
starting place for those wishing to contribute.
2016-01-25 14:25:32 +00:00
Greg Chapple a5836fa48f Fix note about B-prefixed issue labels
'B' labels are for blockers, not issues which belong elsewhere.

Prompted by this comment on Reddit:
https://www.reddit.com/r/rust/comments/40nzkd/contributing_to_the_rust_compiler_a_short_guide/cyxcjtd
2016-01-14 10:47:04 +00:00
fbergr aa219d9412 doc: Change Google link to generic top level domain 2015-12-23 22:42:36 +02:00
Brian Anderson 0d0cb3bb62 Direct security bugs to the security policy. 2015-11-06 21:56:40 -08:00
Aleksey Kladov c3753ce074 docs: add rustdoc example to CONTRIBUTING.md 2015-10-03 03:42:28 +03:00
Aleksey Kladov e3596e34ce docs: whitespace cleanup 2015-10-03 00:08:14 +03:00
Andreas Sommer aa9666e5c1 Fix typo, add link to Google-search in documentation 2015-10-02 14:38:31 +02:00
christopherdumas 4543dadd6b Cheat sheet 2015-09-14 07:28:06 -07:00
christopherdumas 35209dcda8 Fix typo 2015-09-14 06:29:32 -07:00
christopherdumas 00cbe1db95 Added link to @bors cheetsheet (thanks, @nagisa) 2015-09-13 08:21:10 -07:00
christopherdumas d09ba5d3ce Compiler test manual 2015-09-12 08:02:01 -07:00
christopherdumas 3f86602e00 Added useful links section 2015-09-11 18:24:11 -07:00
Eli Friedman bbbfed2f93 Use https URLs to refer to rust-lang.org where appropriate.
Also fixes a few outdated links.
2015-08-09 14:28:46 -07:00
Manish Goregaokar 98475320f2 Rollup merge of #26693 - rutsky:patch-1, r=Manishearth
r? @steveklabnik
2015-07-16 10:48:28 +05:30
Steve Klabnik 8d94bbf106 Rollup merge of #26832 - steveklabnik:doc_rustc_cycle_time, r=huonw 2015-07-06 18:06:30 -04:00
Steve Klabnik 720da310a9 Add note about special make targets 2015-07-06 17:01:04 -04:00
Steve Klabnik 8cb1faaa90 Link to test suite information from CONTRIBUTING.md
Fixes #24802
2015-07-06 12:14:49 -04:00
Vladimir Rutsky b85aa7800d fix typo: "requests function in the same [way] as other" 2015-07-01 01:57:54 +03:00
edunham 177531e3d5 Document issue tracker tags
A discussion at https://github.com/rust-lang/rust/pull/25832 established what
the abbreviations mean.
2015-05-28 16:00:04 -07:00
Darrell Hamilton a6b47c0efa Fixes "Code of Conduct" Link
Replaces the markdown link delimiters for the "Code of Conduct" link with the appropriate delimiters for using a link id

r? @steveklabnik
2015-02-18 20:53:00 -07:00
Steve Klabnik f645cad3a1 CONTRIBUTING.md redux
This redux of CONTRIBUTING.md adds in more information, including
subsuming both compliment-bugreport.md and Note-development-policy
in the wiki.

I only glanced at the broad TOC of Note-development-policy, and did
not use the text as the basis for the re-write. This will then address
the last outstanding part of #5831.
2015-02-16 04:46:40 -05:00
Brian Anderson 94404070d6 discuss.rust-lang.org -> internals.rust-lang.org 2015-01-27 15:44:05 -08:00
Aidan Hobson Sayers 9002fdbc50 Make link to style guide direct 2015-01-15 00:52:33 +00:00
Brian Anderson 36c63a3abe Put links to discuss.rust-lang.org and #rust-internals in CONTRIBUTING.md 2015-01-02 15:42:38 -08:00
Nick Cameron 852cef8a93 Update CONTRIBUTING.md with new issues policy 2014-09-22 12:46:24 +12:00
Alexis Beingessner e8006f3c74 Make small doc contributions less onerous/intimidating 2014-08-08 19:36:32 -04:00
Brian Anderson f4ae8a83f9 Update repo location 2014-06-16 18:16:36 -07:00
Alex Crichton 799ddba8da Change static.rust-lang.org to doc.rust-lang.org
The new documentation site has shorter urls, gzip'd content, and index.html
redirecting functionality.
2014-05-21 19:55:39 -07:00
Aaron Raimist ea46a7406a Updated CONTRIBUTING.md for 2014 2014-05-05 15:46:10 -05:00
Adrien Tétar a30d61b05a Various READMEs and docs cleanup
Noticeably closes #11428.
2014-01-11 19:41:31 +01:00
Tim Chevalier 5afd760834 syntax: Add the Bug Report HOWTO URL to the ICE message
And also reference the bug report HOWTO in CONTRIBUTING.md
2013-10-21 12:11:24 -07:00
Graydon Hoare b417bc8511 Update CONTRIBUTING.md 2013-06-13 15:41:34 -06:00
Ramkumar Ramachandra 4936421031 contributing: wrap lines for readability
Signed-off-by: Ramkumar Ramachandra <artagnon@gmail.com>
2013-06-05 19:34:39 +05:30
Benjamin Herr ae89328b2a Contributing.md: remove spurious verb 2013-03-01 22:46:00 +01:00
Graydon Hoare 0bc13a2401 Tweak the CONTRIBUTING.md file. 2013-02-01 17:34:09 -08:00
Tim Chevalier f8c26525ea docs: Add a note to CONTRIBUTING.md about copyright dates 2013-01-29 11:07:02 -08:00
Cody Schroeder 6707b7d08e Fix links in CONTRIBUTING.md 2013-01-26 00:09:13 -08:00
Tim Chevalier c880d0ab76 Add an xfailed test case and a CONTRIBUTING.md file 2012-12-27 14:58:45 -08:00