Skip to content

Commit 968ce25

Browse files
committed
Change links to readmes
1 parent a05c553 commit 968ce25

File tree

8 files changed

+29
-14
lines changed

8 files changed

+29
-14
lines changed

src/librustc/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
For more information about how rustc works, see the [rustc guide].
2+
3+
[rustc guide]: https://rust-lang-nursery.github.io/rustc-guide/

src/librustc/dep_graph/graph.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ impl DepGraph {
166166
/// what state they have access to. In particular, we want to
167167
/// prevent implicit 'leaks' of tracked state into the task (which
168168
/// could then be read without generating correct edges in the
169-
/// dep-graph -- see the module-level [README] for more details on
169+
/// dep-graph -- see the [rustc guide] for more details on
170170
/// the dep-graph). To this end, the task function gets exactly two
171171
/// pieces of state: the context `cx` and an argument `arg`. Both
172172
/// of these bits of state must be of some type that implements
@@ -186,7 +186,7 @@ impl DepGraph {
186186
/// - If you need 3+ arguments, use a tuple for the
187187
/// `arg` parameter.
188188
///
189-
/// [README]: https://github.com/rust-lang/rust/blob/master/src/librustc/dep_graph/README.md
189+
/// [rustc guide]: https://rust-lang-nursery.github.io/rustc-guide/incremental-compilation.html
190190
pub fn with_task<C, A, R, HCX>(&self,
191191
key: DepNode,
192192
cx: C,

src/librustc/hir/mod.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -601,9 +601,9 @@ pub type CrateConfig = HirVec<P<MetaItem>>;
601601
/// The top-level data structure that stores the entire contents of
602602
/// the crate currently being compiled.
603603
///
604-
/// For more details, see the module-level [README].
604+
/// For more details, see the [rustc guide].
605605
///
606-
/// [README]: https://github.com/rust-lang/rust/blob/master/src/librustc/hir/README.md.
606+
/// [rustc guide]: https://rust-lang-nursery.github.io/rustc-guide/hir.html
607607
#[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Debug)]
608608
pub struct Crate {
609609
pub module: Mod,

src/librustc/lib.rs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,9 @@
2828
//! this code handles low-level equality and subtyping operations. The
2929
//! type check pass in the compiler is found in the `librustc_typeck` crate.
3030
//!
31-
//! For a deeper explanation of how the compiler works and is
32-
//! organized, see the README.md file in this directory.
31+
//! For more information about how rustc works, see the [rustc guide].
32+
//!
33+
//! [rustc guide]: https://rust-lang-nursery.github.io/rustc-guide/
3334
//!
3435
//! # Note
3536
//!

src/librustc/traits/coherence.rs

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,11 @@
88
// option. This file may not be copied, modified, or distributed
99
// except according to those terms.
1010

11-
//! See `README.md` for high-level documentation
11+
//! See rustc guide chapters on [trait-resolution] and [trait-specialization] for more info on how
12+
//! this works.
13+
//!
14+
//! [trait-resolution]: https://rust-lang-nursery.github.io/rustc-guide/trait-resolution.html
15+
//! [trait-specialization]: https://rust-lang-nursery.github.io/rustc-guide/trait-specialization.html
1216
1317
use hir::def_id::{DefId, LOCAL_CRATE};
1418
use syntax_pos::DUMMY_SP;

src/librustc/traits/mod.rs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@
88
// option. This file may not be copied, modified, or distributed
99
// except according to those terms.
1010

11-
//! Trait Resolution. See README.md for an overview of how this works.
11+
//! Trait Resolution. See [rustc guide] for more info on how this works.
12+
//!
13+
//! [rustc guide]: https://rust-lang-nursery.github.io/rustc-guide/trait-resolution.html
1214
1315
pub use self::SelectionError::*;
1416
pub use self::FulfillmentErrorCode::*;

src/librustc/traits/select.rs

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@
88
// option. This file may not be copied, modified, or distributed
99
// except according to those terms.
1010

11-
//! See `README.md` for high-level documentation
11+
//! See [rustc guide] for more info on how this works.
12+
//!
13+
//! [rustc guide]: https://rust-lang-nursery.github.io/rustc-guide/trait-resolution.html#selection
1214
1315
use self::SelectionCandidate::*;
1416
use self::EvaluationResult::*;
@@ -1025,8 +1027,9 @@ impl<'cx, 'gcx, 'tcx> SelectionContext<'cx, 'gcx, 'tcx> {
10251027
//
10261028
// The selection process begins by examining all in-scope impls,
10271029
// caller obligations, and so forth and assembling a list of
1028-
// candidates. See `README.md` and the `Candidate` type for more
1029-
// details.
1030+
// candidates. See [rustc guide] for more details.
1031+
//
1032+
// [rustc guide]: https://rust-lang-nursery.github.io/rustc-guide/trait-resolution.html#candidate-assembly
10301033

10311034
fn candidate_from_obligation<'o>(&mut self,
10321035
stack: &TraitObligationStack<'o, 'tcx>)
@@ -2312,7 +2315,9 @@ impl<'cx, 'gcx, 'tcx> SelectionContext<'cx, 'gcx, 'tcx> {
23122315
//
23132316
// Confirmation unifies the output type parameters of the trait
23142317
// with the values found in the obligation, possibly yielding a
2315-
// type error. See `README.md` for more details.
2318+
// type error. See [rustc guide] for more details.
2319+
//
2320+
// [rustc guide]: https://rust-lang-nursery.github.io/rustc-guide/trait-resolution.html#confirmation
23162321

23172322
fn confirm_candidate(&mut self,
23182323
obligation: &TraitObligation<'tcx>,

src/librustc/ty/context.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -779,9 +779,9 @@ impl<'tcx> CommonTypes<'tcx> {
779779
/// The central data structure of the compiler. It stores references
780780
/// to the various **arenas** and also houses the results of the
781781
/// various **compiler queries** that have been performed. See the
782-
/// module-level [README] for more details.
782+
/// [rustc guide] for more details.
783783
///
784-
/// [README]: https://github.com/rust-lang/rust/blob/master/src/librustc/ty/README.md
784+
/// [rustc guide]: https://rust-lang-nursery.github.io/rustc-guide/ty.html
785785
#[derive(Copy, Clone)]
786786
pub struct TyCtxt<'a, 'gcx: 'a+'tcx, 'tcx: 'a> {
787787
gcx: &'a GlobalCtxt<'gcx>,

0 commit comments

Comments
 (0)