Skip to content

Instantly share code, notes, and snippets.

@chrissimpkins

chrissimpkins/rustc-guide-references.md

Created March 3, 2020 02:11
Show Gist options
  • Save chrissimpkins/b61be20a52d209a8d0ed226a273839f5 to your computer and use it in GitHub Desktop.
Save chrissimpkins/b61be20a52d209a8d0ed226a273839f5 to your computer and use it in GitHub Desktop.
Download ZIP
rustc-guide references in rust-lang/rust repository
Raw
rustc-guide-references.md

Output from rg "rustc-guide":

rustfmt.toml
23:    "src/doc/rustc-guide",

triagebot.toml
20:[instructions]: https://rust-lang.github.io/rustc-guide/ice-breaker/llvm.html
31:[instructions]: https://rust-lang.github.io/rustc-guide/ice-breaker/cleanup-crew.html

README.md
18:chapter][rustcguidebuild] of the rustc-guide instead of this section._
24:[rustcguidebuild]: https://rust-lang.github.io/rustc-guide/building/how-to-build-and-run.html
258:[rustc guide]: https://rust-lang.github.io/rustc-guide/about-this-guide.html

CONTRIBUTING.md
22:The [rustc-guide] is your friend! It describes how the compiler works and how
32:[rustc-guide]: https://rust-lang.github.io/rustc-guide/
33:[walkthrough]: https://rust-lang.github.io/rustc-guide/walkthrough.html
106:chapter][rustcguidebuild] of the rustc-guide. This chapter contains info for
111:[rustcguidebuild]: https://rust-lang.github.io/rustc-guide/building/how-to-build-and-run.html
339:Additionally, contributions to the [rustc-guide] are always welcome. Contributions
341:rust-lang/rustc-guide](https://github.com/rust-lang/rustc-guide) repo. The issue
451:[rustc guide]: https://rust-lang.github.io/rustc-guide/about-this-guide.html
459:[rctd]: https://rust-lang.github.io/rustc-guide/tests/intro.html

src/README.md
8:[rustc guide]: https://rust-lang.github.io/rustc-guide/about-this-guide.html

src/tools/publish_toolstate.py
44:    'rustc-guide': {'mark-i-m', 'spastorino', 'amanjeev', 'JohnTitor'},
58:    'rustc-guide': 'https://github.com/rust-lang/rustc-guide',

src/test/COMPILER_TESTS.md
4:[the rustc guide](https://rust-lang.github.io/rustc-guide/tests/intro.html).

src/bootstrap/test.rs
1496:        run.path("src/doc/rustc-guide")
1504:        let src = builder.src.join("src/doc/rustc-guide");
1511:        builder.save_toolstate("rustc-guide", toolstate);

src/bootstrap/toolstate.rs
92:    ("rustc-guide", "src/doc/rustc-guide"),
390:                if !["rustc-guide", "miri", "embedded-book"].contains(&tool.as_str()) {

src/librustc_typeck/README.md
4:[type checking]: https://rust-lang.github.io/rustc-guide/type-checking.html
5:[rustc guide]: https://rust-lang.github.io/rustc-guide/

src/librustc/lib.rs
19://! [rustc guide]: https://rust-lang.github.io/rustc-guide/

src/librustc/README.md
3:[rustc guide]: https://rust-lang.github.io/rustc-guide/

src/librustc_hir/lib.rs
3://! [rustc guide]: https://rust-lang.github.io/rustc-guide/hir.html

src/librustc_hir/hir.rs
614:/// [rustc guide]: https://rust-lang.github.io/rustc-guide/hir.html

src/librustdoc/README.md
3:[rustc guide]: https://rust-lang.github.io/rustc-guide/rustdoc.html

src/librustc_codegen_llvm/README.md
7:[rustc guide]: https://rust-lang.github.io/rustc-guide/codegen.html

src/librustc_infer/lib.rs
10://! [rustc guide]: https://rust-lang.github.io/rustc-guide/

src/libsyntax/README.md
8:- [Parsing](https://rust-lang.github.io/rustc-guide/the-parser.html)
9:- [Macro Expansion](https://rust-lang.github.io/rustc-guide/macro-expansion.html)

src/doc/index.md
123:[The `rustc` Guide](https://rust-lang.github.io/rustc-guide/) documents how

src/librustc_codegen_ssa/README.md
1:Please read the rustc-guide chapter on [Backend Agnostic Codegen][bac].
3:[bac]: https://rust-lang.github.io/rustc-guide/codegen/backend-agnostic.html

src/librustc_target/README.md
6:[rustc guide]: https://rust-lang.github.io/rustc-guide/

src/librustc_driver/README.md
10:[rustc guide]: https://rust-lang.github.io/rustc-guide/rustc-driver.html

src/librustc_passes/region.rs
7://! [rustc guide]: https://rust-lang.github.io/rustc-guide/borrow_check.html

src/librustc_typeck/variance/terms.rs
80:    // - https://rust-lang.github.io/rustc-guide/query.html
81:    // - https://rust-lang.github.io/rustc-guide/variance.html

src/librustc_typeck/variance/mod.rs
4://! [rustc guide]: https://rust-lang.github.io/rustc-guide/variance.html

src/librustc/middle/region.rs
7://! [rustc guide]: https://rust-lang.github.io/rustc-guide/mir/borrowck.html

src/librustc/hir/mod.rs
3://! [rustc guide]: https://rust-lang.github.io/rustc-guide/hir.html

src/librustc/traits/select.rs
3://! [rustc guide]: https://rust-lang.github.io/rustc-guide/traits/resolution.html#selection

src/librustc/ty/sty.rs
1403:/// [rustc guide]: https://rust-lang.github.io/rustc-guide/traits/hrtb.html

src/librustc/ty/context.rs
921:/// [rustc guide]: https://rust-lang.github.io/rustc-guide/ty.html

src/librustc/traits/mod.rs
3://! [rustc guide]: https://rust-lang.github.io/rustc-guide/traits/resolution.html

src/librustc/infer/canonical.rs
22://! [c]: https://rust-lang.github.io/rustc-guide/traits/canonicalization.html

src/librustc/dep_graph/graph.rs
197:    /// [rustc guide]: https://rust-lang.github.io/rustc-guide/incremental-compilation.html

src/librustc/dep_graph/README.md
4:[rustc guide]: https://rust-lang.github.io/rustc-guide/query.html

src/librustc/mir/mod.rs
3://! [rustc guide]: https://rust-lang.github.io/rustc-guide/mir/index.html

src/librustc_incremental/persist/README.md
3:[rustc guide]: https://rust-lang.github.io/rustc-guide/query.html

src/doc/rustc-guide/README.md
1:![Travis CI badge](https://api.travis-ci.com/rust-lang/rustc-guide.svg?branch=master)
9:[You can read the latest version of the guide here.](https://rust-lang.github.io/rustc-guide/)
21:tracker](https://github.com/rust-lang/rustc-guide/issues). Just post a
58:5. There will be approximately 1 billion different jobs for the build. They are for different configurations and platforms. The rustc-guide build only runs on the Linux x86_64-gnu-tools job. So click on that job in the list, which is about 60% down in the list.
64:8. Search for rustc-guide. This gets you to the place where the links are checked. It is usually ~11K lines into the log
68:10. Fix those links in the rustc-guide (by making a PR in the rustc-guide repo)
70:11. Make a PR on the rust-lang/rust repo to update the rustc-guide git submodule in src/docs/rustc-guide.
75:git submodule update --remote src/doc/rustc-guide
77:git commit -m "Update rustc-guide"
79:./x.py test --incremental --stage 1 src/doc/rustc-guide # This is optional and should succeed anyway

src/doc/rustc-guide/book.toml
10:git-repository-url = "https://github.com/rust-lang/rustc-guide"

src/librustc_infer/traits/coherence.rs
4://! [trait-resolution]: https://rust-lang.github.io/rustc-guide/traits/resolution.html
5://! [trait-specialization]: https://rust-lang.github.io/rustc-guide/traits/specialization.html

src/librustc_infer/traits/mod.rs
3://! [rustc guide]: https://rust-lang.github.io/rustc-guide/traits/resolution.html

src/librustc_infer/traits/select.rs
5://! [rustc guide]: https://rust-lang.github.io/rustc-guide/traits/resolution.html#selection
937:    // https://rust-lang.github.io/rustc-guide/traits/resolution.html#candidate-assembly
2453:    // https://rust-lang.github.io/rustc-guide/traits/resolution.html#confirmation

src/tools/clippy/doc/adding_lints.md
462:[rustc_guide]: https://rust-lang.github.io/rustc-guide/

src/ci/docker/x86_64-gnu-tools/checktools.sh
17:    src/doc/rustc-guide \

src/librustc/ty/query/README.md
3:[rustc guide]: https://rust-lang.github.io/rustc-guide/query.html

src/librustc_typeck/check/method/mod.rs
3://! [rustc guide]: https://rust-lang.github.io/rustc-guide/method-lookup.html

src/doc/rustc/src/contributing.md
11:[rustc_guide]: https://rust-lang.github.io/rustc-guide/

src/doc/rustc-guide/src/about-this-guide.md
28:[GitHub repository]: https://github.com/rust-lang/rustc-guide/

src/doc/rustc-guide/src/part-2-intro.md
10:an issue on the [rustc-guide repo](https://github.com/rust-lang/rustc-guide)

src/doc/rustc-guide/src/macro-expansion.md
231:mark-i-m: The goal is to fill out that long-standing gap in the rustc-guide
632:also plan to summarize the info from this thread into the rustc-guide.
652:Santiago Pastorino: btw https://github.com/rust-lang/rustc-guide/issues/398

src/doc/rustc-guide/src/debugging-support-in-rustc.md
80:[This comment by Tom](https://github.com/rust-lang/rustc-guide/pull/316#discussion_r284027340)
86:[This question by Aman](https://github.com/rust-lang/rustc-guide/pull/316#discussion_r285401353)
279:[Question on Github](https://github.com/rust-lang/rustc-guide/pull/316#discussion_r283062536).

src/doc/rustc-guide/src/part-1-intro.md
3:This section of the rustc-guide contains knowledge that should be useful to you

src/doc/rustc-guide/src/implementing_new_features.md
109:- [ ] Adjust the documentation. ([See instructions on rustc-guide.](https://rust-lang.github.io/rustc-guide/stabilization_guide.html#documentation-prs))
110:- [ ] Stabilize the feature. ([See instructions on rustc-guide.](https://rust-lang.github.io/rustc-guide/stabilization_guide.html#stabilization-pr))

src/librustc_infer/traits/specialize/mod.rs
10://! [rustc guide]: https://rust-lang.github.io/rustc-guide/traits/specialization.html

src/librustc_infer/infer/region_constraints/README.md
3:[rustc guide]: https://rust-lang.github.io/rustc-guide/borrow_check.html

src/librustc_infer/infer/lexical_region_resolve/README.md
5:chapter][bc] in the rustc-guide.
7:[bc]: https://rust-lang.github.io/rustc-guide/borrow_check/region_inference.html

src/librustc_infer/infer/higher_ranked/README.md
2:solver, see [this chapter][oldhrtb] of the rustc-guide.
7:[oldhrtb]: https://rust-lang.github.io/rustc-guide/traits/hrtb.html
8:[newhrtb]: https://rust-lang.github.io/rustc-guide/borrow_check/region_inference.html#placeholders-and-universes

src/librustc_infer/infer/canonical/substitute.rs
7://! [c]: https://rust-lang.github.io/rustc-guide/traits/canonicalization.html

src/librustc_infer/infer/canonical/query_response.rs
8://! [c]: https://rust-lang.github.io/rustc-guide/traits/canonicalization.html
200:    /// [c]: https://rust-lang.github.io/rustc-guide/traits/canonicalization.html#processing-the-canonicalized-query-result

src/librustc_infer/infer/canonical/mod.rs
22://! [c]: https://rust-lang.github.io/rustc-guide/traits/canonicalization.html

src/librustc_infer/infer/canonical/canonicalizer.rs
6://! [c]: https://rust-lang.github.io/rustc-guide/traits/canonicalization.html
38:    /// [c]: https://rust-lang.github.io/rustc-guide/traits/canonicalization.html#canonicalizing-the-query
82:    /// [c]: https://rust-lang.github.io/rustc-guide/traits/canonicalization.html#canonicalizing-the-query-result

src/librustc_infer/infer/higher_ranked/mod.rs
76:    /// [rustc guide]: https://rust-lang.github.io/rustc-guide/traits/hrtb.html

src/doc/rustc-guide/src/traits/chalk-overview.md
229:[rustc-issues]: https://github.com/rust-lang/rustc-guide/issues

src/doc/rustc-guide/src/ice-breaker/llvm.md
19:rustc-guide gives a step-by-step process for how to help debug bugs

src/doc/rustc-guide/src/mir/optimizations.md
11:[mir]: https://rust-lang.github.io/rustc-guide/mir/index.html
12:[monomorph]: https://rust-lang.github.io/rustc-guide/appendix/glossary.html?highlight=monomorphize#appendix-c-glossary
25:[query]: https://rust-lang.github.io/rustc-guide/query.html
26:[defid]: https://rust-lang.github.io/rustc-guide/appendix/glossary.html?highlight=DefId#appendix-c-glossary
27:[steal]: https://rust-lang.github.io/rustc-guide/mir/passes.html?highlight=steal#stealing

src/doc/reference/src/types/inferred.md
16:  The only documentation I am aware of is https://rust-lang.github.io/rustc-guide/type-inference.html

src/librustc_infer/traits/query/type_op/mod.rs
47:/// [c]: https://rust-lang.github.io/rustc-guide/traits/canonicalization.html
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment