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
Jakob Degen
b7970e6c5e
Remove reference to copyright notices.
...
Immediately below the section on copyright notices being removed,
it is mentioned that a particular thing should be placed below the
notices. This seems confusing.
2020-09-24 11:45:35 -04:00
Bastian Kauschke
e74b4ab3a4
update conventions ( #735 )
...
* update conventions
* typo
Co-authored-by: Santiago Pastorino <spastorino@gmail.com>
Co-authored-by: Santiago Pastorino <spastorino@gmail.com>
2020-06-05 13:06:39 -03:00
Santiago Pastorino
0a31a71b7d
Update some projects locations ( #658 )
2020-04-02 18:40:15 +02: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
YOUNGSUK KIM
3b62664aa7
minor grammar fixes
2019-12-28 17:02:38 -06:00
Mazdak Farrokhzad
fbe5ef0f93
Please don't rustfmt.
2019-11-05 09:10:33 -06:00
Mark Mansi
fd50812b27
fix typos
2019-06-15 17:29:12 -05:00
Eduard-Mihai Burtescu
2309adfd9d
Update for TyCtxt<'a, 'gcx, 'tcx> -> TyCtxt<'tcx>.
2019-06-15 16:58:30 -05:00
Mark Mansi
c79621e333
update conventions
2019-01-23 12:56:40 -06:00
Mark Mansi
1d57e3bdd1
update text about copyright headers
2019-01-23 12:41:18 -06:00
Alcaro
b9d3a71115
conventions: Fix semicolon/colon typo
2018-09-28 20:04:05 -05:00
Josh Triplett
45482cb170
Update copyright guidance to omit notices for new files.
...
Previously approved in https://github.com/rust-lang/rust/pull/43498 ;
update the guide to match.
2018-08-20 11:08:22 -05:00
mark
8a49eb7686
fix all the not-en-dashes
2018-07-09 21:45:49 -05:00
Sunjay Varma
5f01a3b60b
Closing all <a> tags
2018-05-10 14:46:44 -05:00
gnzlbg
eb7955313d
Add how to run tidy script in isolation to text
...
This is already mentioned elsewhere, but important things are repeated twice.
Closes #124
2018-05-08 09:57:21 -05:00
varkor
ad35712ddc
Consolidate and fix code blocks
2018-04-06 14:18:08 -05:00
Mark Mansi
a0b171b868
Fix long lines in conventions
2018-03-26 20:28:00 -05:00
Phlosioneer
c2560d523f
Fix typo in conventions.md
2018-03-06 19:09:22 -06:00
Niko Matsakis
49da9c9030
remove humorous footnote which is not supported
2018-02-17 10:51:29 -06:00
Niko Matsakis
bcf38b78a4
mention tidy
2018-02-17 10:51:29 -06:00
Niko Matsakis
747cea1ae7
add some more conventions
2018-02-17 10:51:29 -06:00
Niko Matsakis
e2a7f6f3ad
add some notes on coding conventions and link to copyright notice
2018-02-17 10:51:29 -06:00