Commit graph

1353 commits

Author SHA1 Message Date
Who? Me?!
7d32ccbc6c Link to .md files, rather than .html
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-10-04 10:14:22 -04:00
mark
6c32b8ead2 address lingering reviewer comments 2020-10-04 10:14:22 -04:00
Gus Wynn
825b63b62b Apply suggestions from code review
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-10-04 10:14:22 -04:00
Gus Wynn
512900ee69 add note 2020-10-04 10:14:22 -04:00
Gus Wynn
939210d3ec add suggested workflow to setup nightly rustup for rustc 2020-10-04 10:14:22 -04:00
Julian Wollersberger
ef29de5301 Did more measurements on what exactly affects llvm-lines:
optimize, codegen-units and mir-opt do, but debug-assertions doesn't.
2020-10-04 10:12:47 -04:00
Julian Wollersberger
194af2b992 Document the usage of cargo-llvm-lines and -Ztimings. 2020-10-04 10:12:47 -04:00
Aleksey Kladov
eb1c1fa27e Document new way to not build LLVM
Implemented in https://github.com/rust-lang/rust/pull/76349
2020-10-03 20:39:32 -04:00
Santiago Pastorino
3bbc7f387b hir_map -> hir() 2020-10-03 19:38:38 -05:00
LeSeulArtichaut
e7c8adc14d Fix time periods for Triage WG procedure 2020-10-03 19:25:05 -05:00
Tshepang Lekhonkhobe
9180ec2139 Update src/getting-started.md
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-10-03 19:25:05 -05:00
Tshepang Lekhonkhobe
d380f2ea09 Update src/getting-started.md
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-10-03 19:25:05 -05:00
LeSeulArtichaut
86b81f478b Add a paragraph about reviewers and review latency in Getting Started chapter 2020-10-03 19:25:05 -05:00
Camelid
0eaa94c090 Use HTTPS whenever possible in bibliography links (#909)
Also updated a few links that redirected.
2020-10-03 22:56:29 +02:00
Yuki Okushi
33b684b115 Fix the report link 2020-10-03 16:12:04 -04:00
Camelid
2571db38e4 Fix instructions for squashing
`git merge-base master` does not work, you need
`git merge-base master HEAD` instead.
2020-10-02 15:08:28 -04:00
Roman
c1c6dac0b5 add the last missing code highlight to t-compiler in the docs 2020-10-02 12:37:27 +02:00
Joshua Nelson
2e299034d0 Fix incorrect windows link
Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
2020-10-01 01:27:11 -04:00
Joshua Nelson
3187a75639 Add windows instructions 2020-10-01 01:27:11 -04:00
Joshua Nelson
059dc43601 Recommend setting up check_line_lengths as a pre-commit script
I've run into lots of annoying failures from this.

- Make it runnable without arguments
- Add it in the README
2020-10-01 01:27:11 -04:00
Joshua Nelson
2bb145daa4 Fix typo 2020-09-30 22:39:25 +02:00
Jakob Degen
04a36c83e7 Incorporated suggestions into git page and edit for more brevity.
The Advanced Rebasing section has been mostly rewritten to include
both a major suggestion from jyn and a general rewrite. Additional
thanks to camelid for some suggestions!
2020-09-30 10:13:42 -04:00
Jakob Degen
40b87ba3a1 Edit using git page for brevity and clarity.
The previous iteration of the page was often wordy and
occasionally unclear. This has been cleaned up in places.

Additionally, the TODO in the no-merge policy section has been
removed and addressed.
2020-09-30 10:13:42 -04:00
Jakob Degen
61b48efae1 Add a section on using git.
This section addresses the biggest issues that new contributors,
especially those with limited familiarity with git, are likely to
face. This is still a WIP.

Thanks to jyn for the recommended improvements!
2020-09-30 10:13:42 -04:00
Santiago Pastorino
c714aed30a --verbose is useful when not compiling and when compiling (#901) 2020-09-29 17:18:00 +02:00
follower
2e9a2f3c75 Use implicit reference links for shorter lines
(As suggested by jyn514.)
2020-09-27 10:37:22 -04:00
follower
0e2c9cccb9 Fix line length error.
Reduced line length to <100 (as indicated by PR build error).

(Also removed extra space character before link.)
2020-09-27 10:37:22 -04:00
follower
edceee064f Add links to documentation sources.
Linking directly to the relevant/example document source locations makes it easier for potential contributors to find them.
2020-09-27 10:37:22 -04:00
Joshua Nelson
8a8ae8ca9b Add docs for x.py setup 2020-09-27 04:24:18 +02:00
follower
df11ed503f Add link from "Writing Documentation" suggestion
A link to the relevant section of the contributing documentation makes it easier for contributors to locate the relevant information. (e.g. via an in-page search for "doc".)

This is particularly important currently as 85072e3303/CONTRIBUTING.md links directly to the (currently `rustc`-focused) "Getting Started" guide rather than the general Rust contribution content to which it used to point.
2020-09-26 11:52:14 -04:00
Shahar Or (mightyiam)
aace4f0c24 correct output path in Writing Documentation 2020-09-26 08:45:48 -04:00
Youngsuk_Kim
14fc590808 update link to 'BorrowKind' to be implicit in markdown 2020-09-25 22:55:49 -04:00
Youngsuk_Kim
34cfcbcf26 add link to 'BorrowKind' in closure.md 2020-09-25 22:55:49 -04:00
Youngsuk_Kim
3ee6367d1e update description of 'ByRef' borrows of closures 2020-09-25 22:55:49 -04:00
Youngsuk_Kim
268028e259 minor punctuation/grammar error fix 2020-09-25 22:55:49 -04:00
Jakob Degen
370b79975c 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
Dániel Buga
9373c8d588 Link to the -Zmir-opt-level proposal
I was confused about what the different levels mean. This PR adds a paragraph that shortly explains the rationale behind different mir-opt-levels and links to the current proposal where there's some information about them.

Let me know if I wrote something unreasonable or incorrect.

Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-09-23 18:42:23 -04:00
Joshua Nelson
30ca044a71 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
Camelid
08162cbd1e ConstEvalResult is now EvalToConstValueResult (#885)
Also fixed typo.
2020-09-22 22:52:05 +02:00
Joshua Nelson
0d195f113b 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
Camelid
3fd9f3bd08 Fix typo in table of contents 2020-09-17 11:35:14 -04:00
Camelid
9d5753910d Revert "Mention that places are sometimes called "lvalues""
This reverts commit bf5e1c451de505fa453672c1168b09db07a145cb.
2020-09-17 11:35:14 -04:00
Camelid
c72daace49 Mention that places are sometimes called "lvalues" 2020-09-17 11:35:14 -04:00
Camelid
d706ba09db More improvements 2020-09-17 11:35:14 -04:00
Camelid
3829c92694 Improve MIR sections in appendix
Add a new graphical representation of one of the examples of MIR and
basic blocks!

And make other minor improvements.
2020-09-17 11:35:14 -04:00
Macdonald Umoren
72d3b5ab28 debug-logging=true instead of debug-assertions=yes 2020-09-16 21:56:05 -04:00
Dylan MacKenzie
4b013d3193 Add link for AnalysisDomain::NAME 2020-09-16 00:21:55 -04:00
Dylan MacKenzie
32ea891485 Describe how to generate graphviz diagrams for dataflow 2020-09-16 00:21:55 -04:00
Santiago Pastorino
bcf72c5049 Remove EN1 2020-09-15 18:13:33 -04:00
Santiago Pastorino
6651dfc4e4 Complete text about salsa base inputs 2020-09-15 18:13:33 -04:00