Skip to content

Fixed links broken by merging chalks rules and solve #322

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 1 commit into from
May 15, 2019
Merged
Changes from all 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
20 changes: 9 additions & 11 deletions src/traits/chalk-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,18 +126,18 @@ things", chalk_ir defines [`ProgramEnvironment`] which is "pure logic".
The main field in that struct is `program_clauses`, which contains the
[`ProgramClause`]s generated by the rules module.

### Rules ([chalk_rules])
### Rules ([chalk_solve])

The `chalk_rules` crate ([source code][chalk_rules]) defines the logic rules we use
for each item in the Rust IR. It works by iterating over every trait, impl,
The `chalk_solve` crate ([source code][chalk_solve]) defines the logic rules we
use for each item in the Rust IR. It works by iterating over every trait, impl,
etc. and emitting the rules that come from each one.

*See also: [Lowering Rules][lowering-rules]*

#### Well-formedness checks

As part of lowering to logic, we also do some "well formedness" checks. See
the [`chalk_rules::wf` source code][rules-wf-src] for where those are done.
the [`chalk_solve::wf` source code][solve-wf-src] for where those are done.

*See also: [Well-formedness checking][wf-checking]*

Expand All @@ -163,12 +163,11 @@ Chalk's functionality is broken up into the following crates:
- [**chalk_ir**][chalk_ir]: Defines chalk's internal representation of
types, lifetimes, and goals.
- [**chalk_solve**][chalk_solve]: Combines `chalk_ir` and `chalk_engine`,
effectively.
effectively, which implements logic rules converting `chalk_rust_ir` to
`chalk_ir`
- Defines the `coherence` module, which implements coherence rules
- [`chalk_engine::context`][engine-context] provides the necessary hooks.
- [**chalk_parse**][chalk_parse]: Defines the raw AST and a parser.
- [**chalk_rules**][chalk_rules]: which implements logic rules converting
`chalk_rust_ir` to `chalk_ir`
- Defines the `coherence` module, which implements coherence rules
- [**chalk**][doc-chalk]: Brings everything together. Defines the following
modules:
- `chalk::lowering`, which converts AST to `chalk_rust_ir`
Expand Down Expand Up @@ -236,7 +235,6 @@ Likewise, lowering tests use the [`lowering_success!` and
[chalk_ir]: https://rust-lang.github.io/chalk/doc/chalk_ir/index.html
[chalk_parse]: https://rust-lang.github.io/chalk/doc/chalk_parse/index.html
[chalk_solve]: https://rust-lang.github.io/chalk/doc/chalk_solve/index.html
[chalk_rules]: https://rust-lang.github.io/chalk/doc/chalk_rules/index.html
[chalk_rust_ir]: https://rust-lang.github.io/chalk/doc/chalk_rust_ir/index.html
[doc-chalk]: https://rust-lang.github.io/chalk/doc/chalk/index.html
[engine-context]: https://rust-lang.github.io/chalk/doc/chalk_engine/context/index.html
Expand All @@ -250,9 +248,9 @@ Likewise, lowering tests use the [`lowering_success!` and
[chalk-test-wf]: https://github.com/rust-lang/chalk/blob/4bce000801de31bf45c02f742a5fce335c9f035f/src/rules/wf/test.rs#L1
[chalki]: https://rust-lang.github.io/chalk/doc/chalki/index.html
[clause]: https://github.com/rust-lang/chalk/blob/master/GLOSSARY.md#clause
[coherence-src]: http://rust-lang.github.io/chalk/doc/chalk_rules/coherence/index.html
[coherence-src]: http://rust-lang.github.io/chalk/doc/chalk_solve/coherence/index.html
[ir-code]: http://rust-lang.github.io/chalk/doc/chalk_rust_ir/
[rules-wf-src]: http://rust-lang.github.io/chalk/doc/chalk_rules/wf/index.html
[solve-wf-src]: http://rust-lang.github.io/chalk/doc/chalk_solve/wf/index.html
[solve_goal]: https://github.com/rust-lang/chalk/blob/4bce000801de31bf45c02f742a5fce335c9f035f/src/test.rs#L85
[test-lowering-macros]: https://github.com/rust-lang/chalk/blob/4bce000801de31bf45c02f742a5fce335c9f035f/src/test_util.rs#L21-L54
[test-macro]: https://github.com/rust-lang/chalk/blob/4bce000801de31bf45c02f742a5fce335c9f035f/src/test.rs#L33