Skip to content

Commit

Permalink
Rename rustc guide to rustc dev guide
Browse files Browse the repository at this point in the history
  • Loading branch information
spastorino committed Mar 10, 2020
1 parent 0037f4e commit 9d4fdba
Show file tree
Hide file tree
Showing 40 changed files with 83 additions and 83 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -434,7 +434,7 @@ For people new to Rust, and just starting to contribute, or even for
more seasoned developers, some useful places to look for information
are:

* The [rustc guide] contains information about how various parts of the compiler work and how to contribute to the compiler
* The [rustc dev guide] contains information about how various parts of the compiler work and how to contribute to the compiler
* [Rust Forge][rustforge] contains additional documentation, including write-ups of how to achieve common tasks
* The [Rust Internals forum][rif], a place to ask questions and
discuss Rust's internals
Expand All @@ -448,7 +448,7 @@ are:
* **Google!** ([search only in Rust Documentation][gsearchdocs] to find types, traits, etc. quickly)
* Don't be afraid to ask! The Rust community is friendly and helpful.

[rustc guide]: https://rust-lang.github.io/rustc-dev-guide/about-this-guide.html
[rustc dev guide]: https://rust-lang.github.io/rustc-dev-guide/about-this-guide.html
[gdfrustc]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc/
[gsearchdocs]: https://www.google.com/search?q=site:doc.rust-lang.org+your+query+here
[rif]: http://internals.rust-lang.org
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ chapter][rustcguidebuild] of the rustc-dev-guide instead of this section._

The Rust build system has a Python script called `x.py` to bootstrap building
the compiler. More information about it may be found by running `./x.py --help`
or reading the [rustc guide][rustcguidebuild].
or reading the [rustc dev guide][rustcguidebuild].

[rustcguidebuild]: https://rust-lang.github.io/rustc-dev-guide/building/how-to-build-and-run.html

Expand Down Expand Up @@ -249,13 +249,13 @@ Most real-time collaboration happens in a variety of channels on the
community, documentation, and all major contribution areas in the Rust ecosystem.
A good place to ask for help would be the #help channel.
The [rustc guide] might be a good place to start if you want to find out how
The [rustc dev guide] might be a good place to start if you want to find out how
various parts of the compiler work.
Also, you may find the [rustdocs for the compiler itself][rustdocs] useful.
[rust-discord]: https://discord.gg/rust-lang
[rustc guide]: https://rust-lang.github.io/rustc-dev-guide/about-this-guide.html
[rustc dev guide]: https://rust-lang.github.io/rustc-dev-guide/about-this-guide.html
[rustdocs]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc/
## License
Expand Down
4 changes: 2 additions & 2 deletions src/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@ This directory contains the source code of the rust project, including:
- `libstd`
- Various submodules for tools, like rustdoc, rls, etc.

For more information on how various parts of the compiler work, see the [rustc guide].
For more information on how various parts of the compiler work, see the [rustc dev guide].

[rustc guide]: https://rust-lang.github.io/rustc-dev-guide/about-this-guide.html
[rustc dev guide]: https://rust-lang.github.io/rustc-dev-guide/about-this-guide.html
4 changes: 2 additions & 2 deletions src/librustc/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
For more information about how rustc works, see the [rustc guide].
For more information about how rustc works, see the [rustc dev guide].

[rustc guide]: https://rust-lang.github.io/rustc-dev-guide/
[rustc dev guide]: https://rust-lang.github.io/rustc-dev-guide/
2 changes: 1 addition & 1 deletion src/librustc/dep_graph/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
To learn more about how dependency tracking works in rustc, see the [rustc
guide].

[rustc guide]: https://rust-lang.github.io/rustc-dev-guide/query.html
[rustc dev guide]: https://rust-lang.github.io/rustc-dev-guide/query.html
4 changes: 2 additions & 2 deletions src/librustc/dep_graph/graph.rs
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ impl DepGraph {
/// what state they have access to. In particular, we want to
/// prevent implicit 'leaks' of tracked state into the task (which
/// could then be read without generating correct edges in the
/// dep-graph -- see the [rustc guide] for more details on
/// dep-graph -- see the [rustc dev guide] for more details on
/// the dep-graph). To this end, the task function gets exactly two
/// pieces of state: the context `cx` and an argument `arg`. Both
/// of these bits of state must be of some type that implements
Expand All @@ -194,7 +194,7 @@ impl DepGraph {
/// - If you need 3+ arguments, use a tuple for the
/// `arg` parameter.
///
/// [rustc guide]: https://rust-lang.github.io/rustc-dev-guide/incremental-compilation.html
/// [rustc dev guide]: https://rust-lang.github.io/rustc-dev-guide/incremental-compilation.html
pub fn with_task<'a, C, A, R>(
&self,
key: DepNode,
Expand Down
4 changes: 2 additions & 2 deletions src/librustc/hir/mod.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//! HIR datatypes. See the [rustc guide] for more info.
//! HIR datatypes. See the [rustc dev guide] for more info.
//!
//! [rustc guide]: https://rust-lang.github.io/rustc-dev-guide/hir.html
//! [rustc dev guide]: https://rust-lang.github.io/rustc-dev-guide/hir.html

pub mod exports;
pub mod map;
Expand Down
2 changes: 1 addition & 1 deletion src/librustc/infer/canonical.rs
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
//! `instantiate_query_result` method.
//!
//! For a more detailed look at what is happening here, check
//! out the [chapter in the rustc guide][c].
//! out the [chapter in the rustc dev guide][c].
//!
//! [c]: https://rust-lang.github.io/rustc-dev-guide/traits/canonicalization.html

Expand Down
4 changes: 2 additions & 2 deletions src/librustc/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@
//! (or `tcx`), which is the central context during most of
//! compilation, containing the interners and other things.
//!
//! For more information about how rustc works, see the [rustc guide].
//! For more information about how rustc works, see the [rustc dev guide].
//!
//! [rustc guide]: https://rust-lang.github.io/rustc-dev-guide/
//! [rustc dev guide]: https://rust-lang.github.io/rustc-dev-guide/
//!
//! # Note
//!
Expand Down
4 changes: 2 additions & 2 deletions src/librustc/middle/region.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
//! the parent links in the region hierarchy.
//!
//! For more information about how MIR-based region-checking works,
//! see the [rustc guide].
//! see the [rustc dev guide].
//!
//! [rustc guide]: https://rust-lang.github.io/rustc-dev-guide/mir/borrowck.html
//! [rustc dev guide]: https://rust-lang.github.io/rustc-dev-guide/mir/borrowck.html

use crate::ich::{NodeIdHashingMode, StableHashingContext};
use crate::ty::{self, DefIdTree, TyCtxt};
Expand Down
4 changes: 2 additions & 2 deletions src/librustc/mir/mod.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//! MIR datatypes and passes. See the [rustc guide] for more info.
//! MIR datatypes and passes. See the [rustc dev guide] for more info.
//!
//! [rustc guide]: https://rust-lang.github.io/rustc-dev-guide/mir/index.html
//! [rustc dev guide]: https://rust-lang.github.io/rustc-dev-guide/mir/index.html

use crate::mir::interpret::{GlobalAlloc, Scalar};
use crate::mir::visit::MirVisitable;
Expand Down
4 changes: 2 additions & 2 deletions src/librustc/traits/mod.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//! Trait Resolution. See the [rustc guide] for more information on how this works.
//! Trait Resolution. See the [rustc dev guide] for more information on how this works.
//!
//! [rustc guide]: https://rust-lang.github.io/rustc-dev-guide/traits/resolution.html
//! [rustc dev guide]: https://rust-lang.github.io/rustc-dev-guide/traits/resolution.html

pub mod query;
pub mod select;
Expand Down
4 changes: 2 additions & 2 deletions src/librustc/traits/select.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//! Candidate selection. See the [rustc guide] for more information on how this works.
//! Candidate selection. See the [rustc dev guide] for more information on how this works.
//!
//! [rustc guide]: https://rust-lang.github.io/rustc-dev-guide/traits/resolution.html#selection
//! [rustc dev guide]: https://rust-lang.github.io/rustc-dev-guide/traits/resolution.html#selection

use self::EvaluationResult::*;

Expand Down
4 changes: 2 additions & 2 deletions src/librustc/ty/context.rs
Original file line number Diff line number Diff line change
Expand Up @@ -916,9 +916,9 @@ pub struct FreeRegionInfo {
/// The central data structure of the compiler. It stores references
/// to the various **arenas** and also houses the results of the
/// various **compiler queries** that have been performed. See the
/// [rustc guide] for more details.
/// [rustc dev guide] for more details.
///
/// [rustc guide]: https://rust-lang.github.io/rustc-dev-guide/ty.html
/// [rustc dev guide]: https://rust-lang.github.io/rustc-dev-guide/ty.html
#[derive(Copy, Clone)]
#[rustc_diagnostic_item = "TyCtxt"]
pub struct TyCtxt<'tcx> {
Expand Down
4 changes: 2 additions & 2 deletions src/librustc/ty/query/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
For more information about how the query system works, see the [rustc guide].
For more information about how the query system works, see the [rustc dev guide].

[rustc guide]: https://rust-lang.github.io/rustc-dev-guide/query.html
[rustc dev guide]: https://rust-lang.github.io/rustc-dev-guide/query.html
4 changes: 2 additions & 2 deletions src/librustc/ty/sty.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1396,11 +1396,11 @@ pub type Region<'tcx> = &'tcx RegionKind;
/// the inference variable is supposed to satisfy the relation
/// *for every value of the placeholder region*. To ensure that doesn't
/// happen, you can use `leak_check`. This is more clearly explained
/// by the [rustc guide].
/// by the [rustc dev guide].
///
/// [1]: http://smallcultfollowing.com/babysteps/blog/2013/10/29/intermingled-parameter-lists/
/// [2]: http://smallcultfollowing.com/babysteps/blog/2013/11/04/intermingled-parameter-lists/
/// [rustc guide]: https://rust-lang.github.io/rustc-dev-guide/traits/hrtb.html
/// [rustc dev guide]: https://rust-lang.github.io/rustc-dev-guide/traits/hrtb.html
#[derive(Clone, PartialEq, Eq, Hash, Copy, RustcEncodable, RustcDecodable, PartialOrd, Ord)]
pub enum RegionKind {
/// Region bound in a type or fn declaration which will be
Expand Down
2 changes: 1 addition & 1 deletion src/librustc_ast/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ The `rustc_ast` crate contains those things concerned purely with syntax
lexer, macro expander, and utilities for traversing ASTs.

For more information about how these things work in rustc, see the
rustc guide:
rustc dev guide:

- [Parsing](https://rust-lang.github.io/rustc-dev-guide/the-parser.html)
- [Macro Expansion](https://rust-lang.github.io/rustc-dev-guide/macro-expansion.html)
4 changes: 2 additions & 2 deletions src/librustc_codegen_llvm/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@ The `codegen` crate contains the code to convert from MIR into LLVM IR,
and then from LLVM IR into machine code. In general it contains code
that runs towards the end of the compilation process.

For more information about how codegen works, see the [rustc guide].
For more information about how codegen works, see the [rustc dev guide].

[rustc guide]: https://rust-lang.github.io/rustc-dev-guide/codegen.html
[rustc dev guide]: https://rust-lang.github.io/rustc-dev-guide/codegen.html
4 changes: 2 additions & 2 deletions src/librustc_driver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@ not contain any of the "main logic" of the compiler (though it does
have some code related to pretty printing or other minor compiler
options).

For more information about how the driver works, see the [rustc guide].
For more information about how the driver works, see the [rustc dev guide].

[rustc guide]: https://rust-lang.github.io/rustc-dev-guide/rustc-driver.html
[rustc dev guide]: https://rust-lang.github.io/rustc-dev-guide/rustc-driver.html
4 changes: 2 additions & 2 deletions src/librustc_hir/hir.rs
Original file line number Diff line number Diff line change
Expand Up @@ -609,9 +609,9 @@ pub struct ModuleItems {
/// The top-level data structure that stores the entire contents of
/// the crate currently being compiled.
///
/// For more details, see the [rustc guide].
/// For more details, see the [rustc dev guide].
///
/// [rustc guide]: https://rust-lang.github.io/rustc-dev-guide/hir.html
/// [rustc dev guide]: https://rust-lang.github.io/rustc-dev-guide/hir.html
#[derive(RustcEncodable, RustcDecodable, Debug)]
pub struct Crate<'hir> {
pub module: Mod<'hir>,
Expand Down
4 changes: 2 additions & 2 deletions src/librustc_hir/lib.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//! HIR datatypes. See the [rustc guide] for more info.
//! HIR datatypes. See the [rustc dev guide] for more info.
//!
//! [rustc guide]: https://rust-lang.github.io/rustc-dev-guide/hir.html
//! [rustc dev guide]: https://rust-lang.github.io/rustc-dev-guide/hir.html

#![feature(crate_visibility_modifier)]
#![feature(const_fn)] // For the unsizing cast on `&[]`
Expand Down
4 changes: 2 additions & 2 deletions src/librustc_incremental/persist/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
For info on how the incremental compilation works, see the [rustc guide].
For info on how the incremental compilation works, see the [rustc dev guide].

[rustc guide]: https://rust-lang.github.io/rustc-dev-guide/query.html
[rustc dev guide]: https://rust-lang.github.io/rustc-dev-guide/query.html
6 changes: 3 additions & 3 deletions src/librustc_infer/infer/canonical/canonicalizer.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
//! This module contains the "canonicalizer" itself.
//!
//! For an overview of what canonicalization is and how it fits into
//! rustc, check out the [chapter in the rustc guide][c].
//! rustc, check out the [chapter in the rustc dev guide][c].
//!
//! [c]: https://rust-lang.github.io/rustc-dev-guide/traits/canonicalization.html

Expand Down Expand Up @@ -33,7 +33,7 @@ impl<'cx, 'tcx> InferCtxt<'cx, 'tcx> {
/// with a mapping M that maps `'?0` to `'static`.
///
/// To get a good understanding of what is happening here, check
/// out the [chapter in the rustc guide][c].
/// out the [chapter in the rustc dev guide][c].
///
/// [c]: https://rust-lang.github.io/rustc-dev-guide/traits/canonicalization.html#canonicalizing-the-query
pub fn canonicalize_query<V>(
Expand Down Expand Up @@ -77,7 +77,7 @@ impl<'cx, 'tcx> InferCtxt<'cx, 'tcx> {
/// reference to `'static` alone.
///
/// To get a good understanding of what is happening here, check
/// out the [chapter in the rustc guide][c].
/// out the [chapter in the rustc dev guide][c].
///
/// [c]: https://rust-lang.github.io/rustc-dev-guide/traits/canonicalization.html#canonicalizing-the-query-result
pub fn canonicalize_response<V>(&self, value: &V) -> Canonicalized<'tcx, V>
Expand Down
2 changes: 1 addition & 1 deletion src/librustc_infer/infer/canonical/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
//! `instantiate_query_result` method.
//!
//! For a more detailed look at what is happening here, check
//! out the [chapter in the rustc guide][c].
//! out the [chapter in the rustc dev guide][c].
//!
//! [c]: https://rust-lang.github.io/rustc-dev-guide/traits/canonicalization.html

Expand Down
4 changes: 2 additions & 2 deletions src/librustc_infer/infer/canonical/query_response.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
//! encode them therein.
//!
//! For an overview of what canonicaliation is and how it fits into
//! rustc, check out the [chapter in the rustc guide][c].
//! rustc, check out the [chapter in the rustc dev guide][c].
//!
//! [c]: https://rust-lang.github.io/rustc-dev-guide/traits/canonicalization.html

Expand Down Expand Up @@ -195,7 +195,7 @@ impl<'cx, 'tcx> InferCtxt<'cx, 'tcx> {
/// the query before applying this function.)
///
/// To get a good understanding of what is happening here, check
/// out the [chapter in the rustc guide][c].
/// out the [chapter in the rustc dev guide][c].
///
/// [c]: https://rust-lang.github.io/rustc-dev-guide/traits/canonicalization.html#processing-the-canonicalized-query-result
pub fn instantiate_query_response_and_region_obligations<R>(
Expand Down
2 changes: 1 addition & 1 deletion src/librustc_infer/infer/canonical/substitute.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
//! `Canonical<'tcx, T>`.
//!
//! For an overview of what canonicalization is and how it fits into
//! rustc, check out the [chapter in the rustc guide][c].
//! rustc, check out the [chapter in the rustc dev guide][c].
//!
//! [c]: https://rust-lang.github.io/rustc-dev-guide/traits/canonicalization.html

Expand Down
4 changes: 2 additions & 2 deletions src/librustc_infer/infer/higher_ranked/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,9 @@ impl<'a, 'tcx> InferCtxt<'a, 'tcx> {
/// needed (but is also permitted).
///
/// For more information about how placeholders and HRTBs work, see
/// the [rustc guide].
/// the [rustc dev guide].
///
/// [rustc guide]: https://rust-lang.github.io/rustc-dev-guide/traits/hrtb.html
/// [rustc dev guide]: https://rust-lang.github.io/rustc-dev-guide/traits/hrtb.html
pub fn replace_bound_vars_with_placeholders<T>(
&self,
binder: &ty::Binder<T>,
Expand Down
4 changes: 2 additions & 2 deletions src/librustc_infer/infer/region_constraints/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
For info on how the current borrowck works, see the [rustc guide].
For info on how the current borrowck works, see the [rustc dev guide].

[rustc guide]: https://rust-lang.github.io/rustc-dev-guide/borrow_check.html
[rustc dev guide]: https://rust-lang.github.io/rustc-dev-guide/borrow_check.html
4 changes: 2 additions & 2 deletions src/librustc_infer/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
//! this code handles low-level equality and subtyping operations. The
//! type check pass in the compiler is found in the `librustc_typeck` crate.
//!
//! For more information about how rustc works, see the [rustc guide].
//! For more information about how rustc works, see the [rustc dev guide].
//!
//! [rustc guide]: https://rust-lang.github.io/rustc-dev-guide/
//! [rustc dev guide]: https://rust-lang.github.io/rustc-dev-guide/
//!
//! # Note
//!
Expand Down
4 changes: 2 additions & 2 deletions src/librustc_infer/traits/mod.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//! Trait Resolution. See the [rustc guide] for more information on how this works.
//! Trait Resolution. See the [rustc dev guide] for more information on how this works.
//!
//! [rustc guide]: https://rust-lang.github.io/rustc-dev-guide/traits/resolution.html
//! [rustc dev guide]: https://rust-lang.github.io/rustc-dev-guide/traits/resolution.html

#[allow(dead_code)]
pub mod auto_trait;
Expand Down
12 changes: 6 additions & 6 deletions src/librustc_infer/traits/select.rs
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
// ignore-tidy-filelength

//! Candidate selection. See the [rustc guide] for more information on how this works.
//! Candidate selection. See the [rustc dev guide] for more information on how this works.
//!
//! [rustc guide]: https://rust-lang.github.io/rustc-dev-guide/traits/resolution.html#selection
//! [rustc dev guide]: https://rust-lang.github.io/rustc-dev-guide/traits/resolution.html#selection

use self::EvaluationResult::*;
use self::SelectionCandidate::*;
Expand Down Expand Up @@ -931,9 +931,9 @@ impl<'cx, 'tcx> SelectionContext<'cx, 'tcx> {
//
// The selection process begins by examining all in-scope impls,
// caller obligations, and so forth and assembling a list of
// candidates. See the [rustc guide] for more details.
// candidates. See the [rustc dev guide] for more details.
//
// [rustc guide]:
// [rustc dev guide]:
// https://rust-lang.github.io/rustc-dev-guide/traits/resolution.html#candidate-assembly

fn candidate_from_obligation<'o>(
Expand Down Expand Up @@ -2447,9 +2447,9 @@ impl<'cx, 'tcx> SelectionContext<'cx, 'tcx> {
//
// Confirmation unifies the output type parameters of the trait
// with the values found in the obligation, possibly yielding a
// type error. See the [rustc guide] for more details.
// type error. See the [rustc dev guide] for more details.
//
// [rustc guide]:
// [rustc dev guide]:
// https://rust-lang.github.io/rustc-dev-guide/traits/resolution.html#confirmation

fn confirm_candidate(
Expand Down
4 changes: 2 additions & 2 deletions src/librustc_infer/traits/specialize/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@
//! At the moment, this implementation support only the simple "chain" rule:
//! If any two impls overlap, one must be a strict subset of the other.
//!
//! See the [rustc guide] for a bit more detail on how specialization
//! See the [rustc dev guide] for a bit more detail on how specialization
//! fits together with the rest of the trait machinery.
//!
//! [rustc guide]: https://rust-lang.github.io/rustc-dev-guide/traits/specialization.html
//! [rustc dev guide]: https://rust-lang.github.io/rustc-dev-guide/traits/specialization.html

pub mod specialization_graph;
use specialization_graph::GraphExt;
Expand Down
4 changes: 2 additions & 2 deletions src/librustc_passes/region.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
//! the parent links in the region hierarchy.
//!
//! For more information about how MIR-based region-checking works,
//! see the [rustc guide].
//! see the [rustc dev guide].
//!
//! [rustc guide]: https://rust-lang.github.io/rustc-dev-guide/borrow_check.html
//! [rustc dev guide]: https://rust-lang.github.io/rustc-dev-guide/borrow_check.html

use rustc::hir::map::Map;
use rustc::middle::region::*;
Expand Down
Loading

0 comments on commit 9d4fdba

Please sign in to comment.