Rename rustc guide to rustc dev guide

This commit is contained in:
Santiago Pastorino 2020-03-05 18:07:42 -03:00
parent 0037f4e37c
commit 9d4fdba8be
No known key found for this signature in database
GPG Key ID: 8131A24E0C79EFAF
40 changed files with 83 additions and 83 deletions

View File

@ -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
@ -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

View File

@ -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
@ -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

View File

@ -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

View File

@ -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/

View File

@ -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

View File

@ -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
@ -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,

View File

@ -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;

View File

@ -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

View File

@ -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
//!

View File

@ -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};

View File

@ -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;

View File

@ -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;

View File

@ -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::*;

View File

@ -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> {

View File

@ -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

View File

@ -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

View File

@ -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)

View File

@ -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

View File

@ -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

View File

@ -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>,

View File

@ -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 `&[]`

View File

@ -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

View File

@ -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
@ -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>(
@ -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>

View File

@ -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

View File

@ -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
@ -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>(

View File

@ -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

View File

@ -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>,

View File

@ -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

View File

@ -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
//!

View File

@ -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;

View File

@ -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::*;
@ -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>(
@ -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(

View File

@ -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;

View File

@ -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::*;

View File

@ -1,6 +1,6 @@
`librustc_target` contains some very low-level details that are
specific to different compilation targets and so forth.
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/

View File

@ -108,13 +108,13 @@ impl<'tcx> Lower<PolyDomainGoal<'tcx>> for ty::Predicate<'tcx> {
}
}
/// Used for implied bounds related rules (see rustc guide).
/// Used for implied bounds related rules (see rustc dev guide).
trait IntoFromEnvGoal {
/// Transforms an existing goal into a `FromEnv` goal.
fn into_from_env_goal(self) -> Self;
}
/// Used for well-formedness related rules (see rustc guide).
/// Used for well-formedness related rules (see rustc dev guide).
trait IntoWellFormedGoal {
/// Transforms an existing goal into a `WellFormed` goal.
fn into_well_formed_goal(self) -> Self;
@ -178,7 +178,7 @@ crate fn program_clauses_for(tcx: TyCtxt<'_>, def_id: DefId) -> Clauses<'_> {
fn program_clauses_for_trait(tcx: TyCtxt<'_>, def_id: DefId) -> Clauses<'_> {
// `trait Trait<P1..Pn> where WC { .. } // P0 == Self`
// Rule Implemented-From-Env (see rustc guide)
// Rule Implemented-From-Env (see rustc dev guide)
//
// ```
// forall<Self, P1..Pn> {
@ -282,7 +282,7 @@ fn program_clauses_for_impl(tcx: TyCtxt<'tcx>, def_id: DefId) -> Clauses<'tcx> {
return List::empty();
}
// Rule Implemented-From-Impl (see rustc guide)
// Rule Implemented-From-Impl (see rustc dev guide)
//
// `impl<P0..Pn> Trait<A1..An> for A0 where WC { .. }`
//
@ -501,7 +501,7 @@ pub fn program_clauses_for_associated_type_def(tcx: TyCtxt<'_>, item_id: DefId)
}
pub fn program_clauses_for_associated_type_value(tcx: TyCtxt<'_>, item_id: DefId) -> Clauses<'_> {
// Rule Normalize-From-Impl (see rustc guide)
// Rule Normalize-From-Impl (see rustc dev guide)
//
// ```
// impl<P0..Pn> Trait<A1..An> for A0 {

View File

@ -1,5 +1,5 @@
For high-level intro to how type checking works in rustc, see the
[type checking] chapter of the [rustc guide].
[type checking] chapter of the [rustc dev guide].
[type checking]: https://rust-lang.github.io/rustc-dev-guide/type-checking.html
[rustc guide]: https://rust-lang.github.io/rustc-dev-guide/
[rustc dev guide]: https://rust-lang.github.io/rustc-dev-guide/

View File

@ -1,6 +1,6 @@
//! Method lookup: the secret sauce of Rust. See the [rustc guide] for more information.
//! Method lookup: the secret sauce of Rust. See the [rustc dev guide] for more information.
//!
//! [rustc guide]: https://rust-lang.github.io/rustc-dev-guide/method-lookup.html
//! [rustc dev guide]: https://rust-lang.github.io/rustc-dev-guide/method-lookup.html
mod confirm;
pub mod probe;

View File

@ -1,7 +1,7 @@
//! Module for inferring the variance of type and lifetime parameters. See the [rustc guide]
//! Module for inferring the variance of type and lifetime parameters. See the [rustc dev guide]
//! chapter for more info.
//!
//! [rustc guide]: https://rust-lang.github.io/rustc-dev-guide/variance.html
//! [rustc dev guide]: https://rust-lang.github.io/rustc-dev-guide/variance.html
use hir::Node;
use rustc::ty::query::Providers;

View File

@ -1,3 +1,3 @@
For more information about how `librustdoc` works, see the [rustc guide].
For more information about how `librustdoc` works, see the [rustc dev guide].
[rustc guide]: https://rust-lang.github.io/rustc-dev-guide/rustdoc.html
[rustc dev guide]: https://rust-lang.github.io/rustc-dev-guide/rustdoc.html

View File

@ -1,4 +1,4 @@
# Compiler Test Documentation
Documentation for the compiler testing framework can be found in
[the rustc guide](https://rust-lang.github.io/rustc-dev-guide/tests/intro.html).
[the rustc dev guide](https://rust-lang.github.io/rustc-dev-guide/tests/intro.html).