mirror
/
rustc-dev-guide
mirror of https://github.com/rust-lang/rustc-dev-guide.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
2,340 Commits 3 Branches 0 Tags 114 MiB
Commit Graph

188 Commits

Author SHA1 Message Date
Luqman Aden d5201cddac Debuginfo tests now also support revisions. 2022-07-21 04:48:49 +02:00
Joshua Nelson f92263e45b Update the build instructions for the standard library 
Since https://github.com/rust-lang/rust/pull/95503, `library/std` means
"build just std and its dependencies"; to get the old behavior that built
`proc_macro` and `test`, you need `x build library`.

- Update `library/std` to `library`
- Remove the `-i` suggestions; `incremental = true` is already the default for most profiles, in
  which case `-i` does nothing. If you don't have incremental enabled, I still think suggesting `-i`
  is bad idea, because it's easy to forget once, at which point you'll end up rebuilding the whole
  compiler / standard library.
- Remove a few repetitive sections and don't discuss incremental in such detail
  Incremental works well enough that it should "just work" for most people;
  I don't think it needs multiple paragraphs of explanation so early in the guide.
- Clarify that `test library/std` *only* tests libstd in a few places
 2022-07-11 07:22:24 +02:00
Edwin Rybarczyk ee64179f12 later -> latter 2022-06-13 00:17:41 +02:00
Eric Huss 375a9f06e3
Remove mention of -Zborrowck=mir with Polonius. (#1367) 2022-06-08 19:30:43 -03:00
Eric Huss e83cd73692
Remove nll compare mode. (#1366) 2022-06-08 14:21:15 -03:00
Yuki Okushi 0b2c9db969
Update some links and docs (#1340) 2022-05-17 07:54:45 +09:00
Guillaume Gomez 4b8d939889 Add missing rustdoc tests explanations 2022-03-09 12:45:59 -08:00
Eric Huss 24e474c276
Add known-bug header. (#1311) 2022-02-24 22:40:58 -06:00
Yuki Okushi d1822b9998
Triage some date references (#1293) 2022-02-10 17:34:23 -03:00
Eric Huss 78dd6a4684
Reorganize and expand the testing chapters. (#1281) 
* Reorganize and expand the testing chapters.

* Update tests chapters for review comments.

* Fix typo.
 2022-01-18 14:44:26 -03:00
Georgiy Komarov 60bc9abf72
Spelling: Rename `rust` to `Rust` (#1288) 2022-01-18 11:09:37 -03:00
Nicholas Nethercote acc6718c51 Address review comments in #1286. 2022-01-05 23:26:43 -06:00
Nicholas Nethercote a992723654 Streamline "Getting Started" some more. 
This is a follow-up to #1279.

The "Getting Started" chapter is, TBH, pretty bad when it comes to the
stuff about building and testing. It has far too much detail and lots of
repetition, which would be overwhelming to a newcomer.

This commit removes most of it, leaving behind just quick mentions of
the most common `x.py` commands: `check`, `build`, `test`, `fmt`, with
links to the appropriate chapters for details. There were a few
interesting details that weren't covered elsewhere, so I moved those
into other chapters.
 2022-01-05 23:26:43 -06:00
Wang Qilin 9bf0028b55
remove rustfix item in test intro (#1277) 2021-12-20 21:53:57 +09:00
Lucas Kent 2cee5a9be8 Improve 'Running tests manually' section 2021-11-27 03:45:39 -05:00
Eric Huss 8a817bc6ca Update for review comments. 2021-11-24 10:22:37 -05:00
Eric Huss aaf6ccc951 Document rustfix-only-machine-applicable 2021-11-24 10:22:37 -05:00
Eric Huss 9660c153fe Apply suggestions from pierwill 
Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
 2021-11-24 10:22:37 -05:00
Eric Huss 285b3e4410 Document more compiletest headers. 2021-11-24 10:22:37 -05:00
Ken Matsui 24132faa13
Unify `x.py` usage (#1258) 2021-11-16 07:44:50 +09:00
Lucas Kent 0fc1fa9f1e Spelling fixes 2021-11-15 08:23:01 -06:00
Lucas Kent f1297f5560 Fix compare-mode documentation 2021-11-14 17:01:35 -06:00
Eric Huss 8a8452cfcc Remove some legacy test suites. 2021-11-04 14:18:39 -05:00
Noah Lev f146da3734 Update some date-check comments 
I removed one of them because it doesn't seem necessary.
 2021-11-04 09:33:03 -07:00
Tomasz Miąsko cec5879a86 Mention needs-sanitizer-hwaddress directive 2021-10-08 15:49:53 -05:00
Frank Steffahn 2f447292ff
Trailing date comments in a line inside of a paragraph caused beginning of a new paragraph. (#1196) 
This PR fixes the 2 occurrences of that.
(I'm not sure if there's an underlying issue with mdbook or if this is working as intended.)
 2021-08-28 08:26:16 -03:00
Yuki Okushi a58da1ba0d
Document how to run unit tests (#1141) 2021-06-17 17:25:28 -03:00
Joshua Nelson dda441c42e
Add back example of {{cwd}} (#1099) 
I force-pushed this in the last commit and accidentally deleted the
github suggestion.
 2021-04-01 04:04:46 +09:00
Joshua Nelson a05852eec0 Document test input normalization 2021-03-31 14:51:19 -04:00
Camelid 9214d4a8c3
Fix formatting of more date references (#1067) 2021-02-22 18:22:23 +09:00
Camelid c4c0f33a1d
Update docs from date triage for 2021-02 (#1048) 
The biggest change was updating the list of rustdoc passes. Several new
ones have been added since that documentation was written, so I added
those, and I also sorted the list so it is roughly alphabetical (except
for the part for the `strip-*` passes, which I left in the same order
since one of the list items has two passes so there's no "correct"
order).
 2021-02-20 19:27:24 -08:00
bstrie 5b2ef08416 Update running.md 2021-02-17 17:13:07 -05:00
Camelid 5e57035110 Add lots of date-check annotations 
Also added dates for things that previously said "as of now" or "as of
this writing" and cleaned up a couple of things along the way.
 2021-02-03 19:29:07 -05:00
Eric Huss 85c995de1b
Update test suite descriptions. (#1042) 2021-01-30 20:12:01 +09:00
Iñaki Garay bee2fd52ce
Add mdbook-toc, markers, and documentation (#1028) 
* Add mdbook-toc to travis, book.toml  and documentation

* Add toc markers

* Whitespace cleanup and some punctuation

* Addressed comments
 2021-01-20 14:33:11 -03:00
Yuki Okushi 3e731b7934
Add a note about UI test entry limitation (#1019) 2021-01-12 07:55:13 +09:00
Iñaki Garay 0a5bb7f5e6
Add context to dated information (#1013) 
* Fixes #924 Add context to dated information

* Fixes #924 Addressed comments and some uses of 'currently'

* Update src/contributing.md

Co-authored-by: Joshua Nelson <joshua@yottadb.com>

* Update src/salsa.md

Co-authored-by: Joshua Nelson <joshua@yottadb.com>

* Fixes #924 Addressed comments

* Fixes #924 Fixed line lengths.

Co-authored-by: Joshua Nelson <joshua@yottadb.com>
 2021-01-10 19:23:22 -03:00
Sebastian Widua a0819a6d98 Fix some typos 2021-01-04 10:02:33 -05:00
Iñaki Garay 320df682bd
rustc invocation standarized (#992) 
* rustc invocation standarized

* Addressed comments

* Addressed comments

* Addressed comments

* Updated command output
 2020-12-28 23:34:51 +01:00
Yuki Okushi 3eb86119dc
Document `error-pattern` header (#989) 
* Document `error-pattern` header

* Address some reviews
 2020-12-12 16:06:30 +01:00
Ben Striegel dc72220925 Address feedback 2020-11-30 18:06:43 -05:00
Ben Striegel fb6176d2a2 Add notes about running the UI test suite 2020-11-30 18:06:43 -05:00
Yuki Okushi 97eebb9adb Replace links to `buildbot2.r-l.o` with `bors.r-l.o` 2020-10-21 17:34:07 -04:00
Joshua Nelson 22b096ba2f
Don't recommend building the compiler for running tests on the standard library (#887) 
Thought of this while reading https://internals.rust-lang.org/t/contributing-changes-to-std/12829/.
 2020-09-23 15:46:43 +00:00
Joshua Nelson 447064120f
Improve instructions for adding a new test (#881) 
* Improve instructions for adding a new test

- Add a section for library tests
- Expand section on rustdoc tests

* Address review comments

- Say what should be considered a library test
- Mention adding error numbers to doc tests
- Link to #ui section
- Line wrapping

* Fix incorrect link

It shouldn't have been a link in the first place.

Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>

Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
 2020-09-19 23:40:17 +00:00
Joshua Nelson 434556f9e0 Address nits 2020-09-12 13:12:14 -05:00
Joshua Nelson d333d1e74f Note that the default is 2015 2020-09-12 13:12:14 -05:00
Joshua Nelson e7b11c1d89 Document edition flag for UI tests 2020-09-12 13:12:14 -05:00
Yuki Okushi c7a3bca829 Adjust mentions about CI to GitHub Actions 2020-08-02 08:38:26 -05:00
Yuki Okushi f8012dbf42
Rename `src/libstd` to `library/std` etc. (#815) 2020-07-30 22:47:22 +09:00
Joshua Nelson eeca3757b8
Update docs to match the new x.py defaults (#813) 2020-07-29 04:20:00 +09:00
Yuki Okushi 87b9ecf2bb Fix link for armhf-gnu Dockerfile 2020-07-04 13:06:27 -05:00
Eric Huss 689eca469d Update docs on using Docker images. 2020-07-04 12:44:57 -05:00
Eric Huss 4228f46777 Add some more detail on compiletest normalization. 2020-06-16 23:14:05 -05:00
Tomasz Miąsko 42520d3ca8 Document needs-* compiletest directives 2020-06-08 12:33:35 -05:00
Tom Eccles 8a5438b4b1 Document more //ignore-X test headers 2020-05-29 13:27:03 -05:00
Tom Eccles a6bace14e4 Document remote testing 2020-05-29 13:27:03 -05:00
Chris Simpkins c9850bb7d2 Update src/tests/adding.md 
Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
 2020-05-28 19:57:59 -05:00
Chris Simpkins 8ca0464e65 add documentation of UI test error annotation substring support 2020-05-28 19:57:59 -05:00
Chris Simpkins 6a54bc6dab
Expand error annotations section with examples (#724) 
* expand error annotations section with examples

Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
 2020-05-29 02:43:22 +09:00
Tshepang Lekhonkhobe 98e94be044 improve info regarding incremental a little 2020-05-01 09:18:42 -05:00
Ralf Jung f9b673309f
codegen tests: add link to LLVM FileCheck docs (#673) 2020-04-12 02:34:25 +09:00
Santiago Pastorino 27269235d3
Update some projects locations (#658) 2020-04-02 18:40:15 +02:00
mark 595f2f386c and a few more links 2020-03-31 15:43:14 -05:00
Santiago Pastorino 9263df7668 Fix line lengths 2020-03-17 12:16:02 -05:00
Santiago Pastorino 4215ea9f25 This is no longer true since rust#49219 2020-03-17 12:16:02 -05:00
Santiago Pastorino 7afd3c3eb1 Avoid as of this writing given that everything is as of this writing :) 2020-03-17 12:16:02 -05:00
Santiago Pastorino 831a8709c9 Rephrase where compiletest is located 2020-03-17 12:16:02 -05:00
Chris Simpkins 56cff94ce7
Update ./x.py tidy testing documentation (#607) 
* update all docs to use ./x.py test tidy syntax
 2020-03-10 12:02:24 +09:00
Who? Me?! cf476b2adc
typo (#599) 2020-03-04 01:41:36 +09:00
Yuki Okushi 692f81f35d Move bless section to running chapter 2020-02-27 11:10:14 -06:00
Mark Mansi 4b34444364 mention tidy bless 2020-02-20 10:28:24 -06:00
Mark Mansi 1938249be0 tidy runs rustfmt check 2020-02-20 10:28:24 -06:00
Mark Mansi 04832fa1be document ./x.py fmt 2020-02-20 10:28:24 -06:00
Laurențiu Nicola d0b93fd015 Remove reference to run-pass tests 2019-12-03 19:37:21 -06:00
Hanif Bin Ariffin d373bca885 Couple of changes to code so that its safe 
Specifically, `> $1` causes it to write into the file $1 if it exist
And `> ./x.py` is particularly bad because it overwrite the script with
empty spaces...
 2019-11-26 17:18:04 -06:00
Mark Mansi fe8585a9b6 some cleanup 2019-11-14 14:14:39 -06:00
PotHix a7beb12a13 Update the "Testing infrastructure" section 
The testing infrastructure was migrated from Travis and AppVeyor to
Azure Pipelines some time ago. This commit updates the documentation to
reflect this change.

Fixes #500.
 2019-11-08 10:14:17 -06:00
Eric Huss d3bfd4ad13 Fix some broken fragment links. 2019-11-05 11:35:34 -06:00
Mazdak Farrokhzad 02d96fdcd8 issues/issue-12345.rs is an anti-pattern (#456) 2019-10-01 08:39:48 -03:00
Tshepang Lekhonkhobe bfe0a08ea4 run-pass dir is gone (#409) 
Fixes #405
 2019-08-01 23:25:07 -03:00
Yuki Okushi fc18a79ef6 Document `--pass $mode` 2019-07-17 10:33:16 -05:00
Yuki Okushi 92f3f8e3b8 Update pass modes for ui tests (#380) 2019-07-04 14:39:45 +03:00
varkor 72bafaca4f Mention running tests for subdirectories 2019-05-15 09:38:51 -05:00
Denys Zariaiev 9df878f4b8 Add a note about `assembly` test suite. 2019-03-22 16:30:05 -05:00
Edd Barrett 87830ff034 Provide a Python example. 2018-12-03 12:07:30 -06:00
Edd Barrett 8f0eaf3961 Explain how to check if gdb supports Python. 2018-12-03 12:07:30 -06:00
Edd Barrett 0f5df93b13 Mention that tests need a Python-enabled gdb. 2018-12-03 12:07:30 -06:00
Aleksey Kladov 76be9f99d7 Remove reference to copyright comment 
We don't need them anymore
 2018-11-08 20:02:48 -06:00
Tom Tromey 351f75b4eb Document ignore-llvm-version 
This documents the ignore-llvm-version directive.
 2018-11-06 16:35:13 -06:00
Tom Tromey 34af41dddb Document the rust-lldb directive 
Commit ac33b2e578de58016271012452e4f1be6af9d516 added a `rust-lldb`
directive to restrict the lldb part of a debuginfo test to only
versions of lldb that include the Rust plugin.
 2018-10-26 18:23:38 -05:00
Rajkumar Natarajan 61cadd2097 issue-130 updated the review comments 2018-09-29 08:50:30 -05:00
Rajkumar Natarajan 062e158a67 issue-130 incorporate the review comments 2018-09-29 08:50:30 -05:00
Rajkumar Natarajan 0f65024f26 issue-130 copy contents related x.py from rust-forge 2018-09-29 08:50:30 -05:00
Tom Tromey 8871bd77b9 Document no-system-llvm 2018-09-28 13:00:41 -05:00
Mark Mansi 9297caaac3 Fix all the links! 2018-09-21 15:54:25 -05:00
Mark Mansi 5ca9b3b326 Fix all the links to be relative for mdbook 2 2018-09-21 15:54:25 -05:00
Philipp Hansch 5ec3e1a620
Fix line lengths 2018-09-12 07:33:41 +02:00
Niko Matsakis b655878d2c wrap lines in `running.md` 2018-09-11 16:22:15 -04:00
Philipp Hansch 732dc4782e Mention incremental compilation in testing chapter 
The `--incremental` flag was only mentioned in [how_to_build_and_run] so
far. Faster testing means faster iteration and perhaps even more added
tests.

[how_to_build_and_run]: https://rust-lang-nursery.github.io/rustc-guide/how-to-build-and-run.html
 2018-09-10 19:30:07 -05:00