Skip to content

Fix outdated dev guide links #436

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 6, 2020
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,4 +92,4 @@ of the terminology used in chalk.
### Trait solving in rustc-dev-guide
The rustc-dev-guide describes [new-style trait solving][trait-solving], which is slowly replacing the old trait resolution.

[trait-solving]: https://rustc-dev-guide.rust-lang.org/traits/index.html
[trait-solving]: https://rustc-dev-guide.rust-lang.org/traits/chalk.html
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@ See the [Chalk book](https://rust-lang.github.io/chalk/book/) for more informati

## FAQ

**How does chalk relate to rustc?** The plan is to have rustc use the `chalk-engine` crate (in this repo), which defines chalk's solver. The rest of chalk can then be considered an elaborate unit testing harness. For more details, see [the Traits chapter of the rustc-dev-guide](https://rustc-dev-guide.rust-lang.org/traits/index.html).
**How does chalk relate to rustc?** The plan is to have rustc use the `chalk-engine` crate (in this repo), which defines
chalk's solver. The rest of chalk can then be considered an elaborate unit testing harness. For more details, see
[this chapter of the rustc-dev-guide](https://rustc-dev-guide.rust-lang.org/traits/chalk.html).

**Where does the name come from?** `chalk` is named after [Chalkidiki], the area where [Aristotle] was
born. Since Prolog is a logic programming language, this seemed a
Expand Down
4 changes: 2 additions & 2 deletions book/src/what_is_chalk.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

> Chalk is under heavy development, so if any of these links are broken or if
> any of the information is inconsistent with the code or outdated, please
> [open an issue][rustc-issues] so we can fix it. If you are able to fix the
> [open an issue][issues] so we can fix it. If you are able to fix the
> issue yourself, we would love your contribution!

Chalk is a library that implements the Rust trait system. The implementation is
Expand All @@ -11,7 +11,7 @@ full specification. It is also meant to be an independent library that can be
integrated both into the main rustc compiler and also other programs and
contexts.

[rustc-issues]: https://github.com/rust-lang/rustc-dev-guide/issues
[issues]: https://github.com/rust-lang/chalk/issues

## High-level view of how chalk works

Expand Down
4 changes: 2 additions & 2 deletions chalk-engine/src/context.rs
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,9 @@ pub trait Context: Clone + Debug {

/// A canonicalized `GoalInEnvironment` -- that is, one where all
/// free inference variables have been bound into the canonical
/// binder. See [the rustc-dev-guide] for more information.
/// binder. See [the chalk book] for more information.
///
/// [the rustc-dev-guide]: https://rustc-dev-guide.rust-lang.org/traits/canonicalization.html
/// [the chalk book]: https://rust-lang.github.io/chalk/book/canonical_queries/canonicalization.html
type CanonicalGoalInEnvironment: Debug;

/// A u-canonicalized `GoalInEnvironment` -- this is one where the
Expand Down
4 changes: 2 additions & 2 deletions chalk-engine/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
//! An alternative solver based around the SLG algorithm, which
//! implements the well-formed semantics. For an overview of how the solver
//! works, see [The On-Demand SLG Solver][guide] in the rustc-dev-guide.
//! works, see [The On-Demand SLG Solver][guide] in the chalk book.
//!
//! [guide]: https://rustc-dev-guide.rust-lang.org/traits/slg.html
//! [guide]: https://rust-lang.github.io/chalk/book/engine/slg.html
//!
//! This algorithm is very closed based on the description found in the
//! following paper, which I will refer to in the comments as EWFS:
Expand Down