Commit Graph

49 Commits

Author SHA1 Message Date
Joshua Nelson d7ead280b4 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
Eric Huss 95d5ac8462 Remove nll compare mode. (#1366) 2022-06-08 14:21:15 -03:00
Yuki Okushi 6ec2a84d4d Update some links and docs (#1340) 2022-05-17 07:54:45 +09:00
Eric Huss 121b57d498 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 e3da6331dd Spelling: Rename `rust` to `Rust` (#1288) 2022-01-18 11:09:37 -03:00
Nicholas Nethercote 940fbb5f7a Address review comments in #1286. 2022-01-05 23:26:43 -06:00
Nicholas Nethercote e3512c8cd8 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
Lucas Kent 9074afb8da Improve 'Running tests manually' section 2021-11-27 03:45:39 -05:00
Ken Matsui e1babf580d Unify `x.py` usage (#1258) 2021-11-16 07:44:50 +09:00
Lucas Kent 363f6ce09c Spelling fixes 2021-11-15 08:23:01 -06:00
Lucas Kent 7b93c858f0 Fix compare-mode documentation 2021-11-14 17:01:35 -06:00
Yuki Okushi 1373d5beed Document how to run unit tests (#1141) 2021-06-17 17:25:28 -03:00
bstrie 87b317f966 Update running.md 2021-02-17 17:13:07 -05:00
Iñaki Garay 7a80b01e01 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
Ben Striegel 5661848ab9 Address feedback 2020-11-30 18:06:43 -05:00
Ben Striegel 680e35a172 Add notes about running the UI test suite 2020-11-30 18:06:43 -05:00
Joshua Nelson 7609eb11ee 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
Yuki Okushi 9c351189e9 Adjust mentions about CI to GitHub Actions 2020-08-02 08:38:26 -05:00
Yuki Okushi 68a2b034c5 Rename `src/libstd` to `library/std` etc. (#815) 2020-07-30 22:47:22 +09:00
Joshua Nelson 879ca582de Update docs to match the new x.py defaults (#813) 2020-07-29 04:20:00 +09:00
Tshepang Lekhonkhobe 5aad3d043d improve info regarding incremental a little 2020-05-01 09:18:42 -05:00
Santiago Pastorino 464f90bd19 This is no longer true since rust#49219 2020-03-17 12:16:02 -05:00
Chris Simpkins 3524cac4b4 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
Yuki Okushi 47b5a863ac Move bless section to running chapter 2020-02-27 11:10:14 -06:00
Hanif Bin Ariffin 5306b68e05 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 63156423fd some cleanup 2019-11-14 14:14:39 -06:00
Tshepang Lekhonkhobe dcf77e10b3 run-pass dir is gone (#409)
Fixes #405
2019-08-01 23:25:07 -03:00
Yuki Okushi a8b434de11 Document `--pass $mode` 2019-07-17 10:33:16 -05:00
varkor c2c7085f77 Mention running tests for subdirectories 2019-05-15 09:38:51 -05:00
Edd Barrett 0d5c72a88d Provide a Python example. 2018-12-03 12:07:30 -06:00
Edd Barrett 2da7be9ca0 Explain how to check if gdb supports Python. 2018-12-03 12:07:30 -06:00
Edd Barrett 15d8147eb2 Mention that tests need a Python-enabled gdb. 2018-12-03 12:07:30 -06:00
Rajkumar Natarajan e2d42fd84c issue-130 updated the review comments 2018-09-29 08:50:30 -05:00
Rajkumar Natarajan 497925ada7 issue-130 incorporate the review comments 2018-09-29 08:50:30 -05:00
Rajkumar Natarajan df96e80e0d issue-130 copy contents related x.py from rust-forge 2018-09-29 08:50:30 -05:00
Philipp Hansch 528783be87 Fix line lengths 2018-09-12 07:33:41 +02:00
Niko Matsakis ca8c8774ef wrap lines in `running.md` 2018-09-11 16:22:15 -04:00
Philipp Hansch bae1d4f2d3 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
mark 8a49eb7686 fix all the not-en-dashes 2018-07-09 21:45:49 -05:00
varkor ad35712ddc Consolidate and fix code blocks 2018-04-06 14:18:08 -05:00
Tomáš Gavenčiak c355768c91 Fix a typo 2018-03-27 20:03:56 +02:00
Tomáš Gavenčiak db6ecb92f9 Add info on test result caching 2018-03-27 11:36:14 -05:00
Alexander Regueiro b3d8fba198 Hard-wrapped lines that are too long. 2018-03-26 20:28:00 -05:00
Eric Huss 7df929b7e1 Add some more information about the various tests that get run.
CC #10
2018-02-23 12:45:17 -06:00
Niko Matsakis 8605464d3b correct links (mdbook seems to want them relative to the book root) 2018-02-17 10:51:29 -06:00
Niko Matsakis bcf38b78a4 mention tidy 2018-02-17 10:51:29 -06:00
Niko Matsakis dbb6900498 fix typo 2018-02-17 10:51:29 -06:00
Niko Matsakis 4680105b89 complete sentence 2018-02-17 10:51:29 -06:00
Niko Matsakis 228ecd29a8 document the test infrastructure 2018-02-17 10:51:29 -06:00