Upgrade to mdbook 0.4 and switch to book parts (#764)
* upgrade to mdbook 0.4 and switch to book parts * update linkcheck * fix links, update about-this-guide
This commit is contained in:
parent
541f88e8dd
commit
32c4f1aa61
|
|
@ -11,8 +11,8 @@ before_install:
|
||||||
- MAX_LINE_LENGTH=100 bash ci/check_line_lengths.sh src/**/*.md
|
- MAX_LINE_LENGTH=100 bash ci/check_line_lengths.sh src/**/*.md
|
||||||
install:
|
install:
|
||||||
- source ~/.cargo/env || true
|
- source ~/.cargo/env || true
|
||||||
- cargo install mdbook --version 0.3.7
|
- cargo install mdbook --version 0.4.0
|
||||||
- cargo install mdbook-linkcheck --version 0.5.0
|
- cargo install mdbook-linkcheck --version 0.7.0
|
||||||
script:
|
script:
|
||||||
- git checkout -b ci
|
- git checkout -b ci
|
||||||
- git rebase origin/master
|
- git rebase origin/master
|
||||||
|
|
|
||||||
|
|
@ -4,10 +4,9 @@
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
- [Part 1: Building, debugging, and contributing to Rustc](./part-1-intro.md)
|
# Building and debugging `rustc`
|
||||||
- [Prerequisites](./building/prerequisites.md)
|
|
||||||
- [Getting Started](./getting-started.md)
|
- [Getting Started](./getting-started.md)
|
||||||
- [About the compiler team](./compiler-team.md)
|
|
||||||
- [How to Build and Run the Compiler](./building/how-to-build-and-run.md)
|
- [How to Build and Run the Compiler](./building/how-to-build-and-run.md)
|
||||||
- [Prerequisites](./building/prerequisites.md)
|
- [Prerequisites](./building/prerequisites.md)
|
||||||
- [Suggested Workflows](./building/suggested.md)
|
- [Suggested Workflows](./building/suggested.md)
|
||||||
|
|
@ -20,26 +19,33 @@
|
||||||
- [Running tests](./tests/running.md)
|
- [Running tests](./tests/running.md)
|
||||||
- [Adding new tests](./tests/adding.md)
|
- [Adding new tests](./tests/adding.md)
|
||||||
- [Using `compiletest` + commands to control test execution](./compiletest.md)
|
- [Using `compiletest` + commands to control test execution](./compiletest.md)
|
||||||
|
- [Debugging the Compiler](./compiler-debugging.md)
|
||||||
|
- [Profiling the compiler](./profiling.md)
|
||||||
|
- [with the linux perf tool](./profiling/with_perf.md)
|
||||||
|
- [crates.io Dependencies](./crates-io.md)
|
||||||
|
- [Errors and Lints](diagnostics.md)
|
||||||
|
- [`LintStore`](./diagnostics/lintstore.md)
|
||||||
|
- [Diagnostic Codes](./diagnostics/diagnostic-codes.md)
|
||||||
|
|
||||||
|
# Contributing to Rust
|
||||||
|
|
||||||
|
- [About the compiler team](./compiler-team.md)
|
||||||
- [Walkthrough: a typical contribution](./walkthrough.md)
|
- [Walkthrough: a typical contribution](./walkthrough.md)
|
||||||
- [Bug Fix Procedure](./bug-fix-procedure.md)
|
- [Bug Fix Procedure](./bug-fix-procedure.md)
|
||||||
- [Implementing new features](./implementing_new_features.md)
|
- [Implementing new features](./implementing_new_features.md)
|
||||||
- [Stability attributes](./stability.md)
|
- [Stability attributes](./stability.md)
|
||||||
- [Stabilizing Features](./stabilization_guide.md)
|
- [Stabilizing Features](./stabilization_guide.md)
|
||||||
- [Debugging the Compiler](./compiler-debugging.md)
|
|
||||||
- [Profiling the compiler](./profiling.md)
|
|
||||||
- [with the linux perf tool](./profiling/with_perf.md)
|
|
||||||
- [Coding conventions](./conventions.md)
|
- [Coding conventions](./conventions.md)
|
||||||
- [crates.io Dependencies](./crates-io.md)
|
|
||||||
- [Errors and Lints](diagnostics.md)
|
|
||||||
- [`LintStore`](./diagnostics/lintstore.md)
|
|
||||||
- [Diagnostic Codes](./diagnostics/diagnostic-codes.md)
|
|
||||||
- [Notification groups](notification-groups/about.md)
|
- [Notification groups](notification-groups/about.md)
|
||||||
- ["Cleanup Crew"](notification-groups/cleanup-crew.md)
|
- ["Cleanup Crew"](notification-groups/cleanup-crew.md)
|
||||||
- [LLVM](notification-groups/llvm.md)
|
- [LLVM](notification-groups/llvm.md)
|
||||||
- [Windows](notification-groups/windows.md)
|
- [Windows](notification-groups/windows.md)
|
||||||
- [ARM](notification-groups/arm.md)
|
- [ARM](notification-groups/arm.md)
|
||||||
- [Licenses](./licenses.md)
|
- [Licenses](./licenses.md)
|
||||||
- [Part 2: High-level Compiler Architecture](./part-2-intro.md)
|
|
||||||
|
# High-level Compiler Architecture
|
||||||
|
|
||||||
|
- [Prologue](./part-2-intro.md)
|
||||||
- [Overview of the Compiler](./overview.md)
|
- [Overview of the Compiler](./overview.md)
|
||||||
- [The compiler source code](./compiler-src.md)
|
- [The compiler source code](./compiler-src.md)
|
||||||
- [Queries: demand-driven compilation](./query.md)
|
- [Queries: demand-driven compilation](./query.md)
|
||||||
|
|
@ -53,9 +59,12 @@
|
||||||
- [Parallel Compilation](./parallel-rustc.md)
|
- [Parallel Compilation](./parallel-rustc.md)
|
||||||
- [Rustdoc](./rustdoc-internals.md)
|
- [Rustdoc](./rustdoc-internals.md)
|
||||||
|
|
||||||
- [Part 3: Source Code Representations](./part-3-intro.md)
|
# Source Code Representations
|
||||||
|
|
||||||
|
- [Prologue](./part-3-intro.md)
|
||||||
- [Command-line arguments](./cli.md)
|
- [Command-line arguments](./cli.md)
|
||||||
- [The Rustc Driver and Interface](./rustc-driver.md)
|
- [The Rustc Driver and Interface](./rustc-driver.md)
|
||||||
|
- [Rustdoc](./rustdoc.md)
|
||||||
- [Ex: Type checking through `rustc_interface`](./rustc-driver-interacting-with-the-ast.md)
|
- [Ex: Type checking through `rustc_interface`](./rustc-driver-interacting-with-the-ast.md)
|
||||||
- [Ex: Getting diagnostics through `rustc_interface`](./rustc-driver-getting-diagnostics.md)
|
- [Ex: Getting diagnostics through `rustc_interface`](./rustc-driver-getting-diagnostics.md)
|
||||||
- [Syntax and the AST](./syntax-intro.md)
|
- [Syntax and the AST](./syntax-intro.md)
|
||||||
|
|
@ -75,7 +84,9 @@
|
||||||
- [MIR passes: getting the MIR for a function](./mir/passes.md)
|
- [MIR passes: getting the MIR for a function](./mir/passes.md)
|
||||||
- [Closure expansion](./closure.md)
|
- [Closure expansion](./closure.md)
|
||||||
|
|
||||||
- [Part 4: Analysis](./part-4-intro.md)
|
# Analysis
|
||||||
|
|
||||||
|
- [Prologue](./part-4-intro.md)
|
||||||
- [The `ty` module: representing types](./ty.md)
|
- [The `ty` module: representing types](./ty.md)
|
||||||
- [Generics and substitutions](./generics.md)
|
- [Generics and substitutions](./generics.md)
|
||||||
- [`TypeFolder` and `TypeFoldable`](./ty-fold.md)
|
- [`TypeFolder` and `TypeFoldable`](./ty-fold.md)
|
||||||
|
|
@ -110,7 +121,9 @@
|
||||||
- [Two-phase-borrows](./borrow_check/two_phase_borrows.md)
|
- [Two-phase-borrows](./borrow_check/two_phase_borrows.md)
|
||||||
- [Parameter Environments](./param_env.md)
|
- [Parameter Environments](./param_env.md)
|
||||||
|
|
||||||
- [Part 5: From MIR to binaries](./part-5-intro.md)
|
# MIR to Binaries
|
||||||
|
|
||||||
|
- [Prologue](./part-5-intro.md)
|
||||||
- [The MIR (Mid-level IR)](./mir/index.md)
|
- [The MIR (Mid-level IR)](./mir/index.md)
|
||||||
- [MIR optimizations](./mir/optimizations.md)
|
- [MIR optimizations](./mir/optimizations.md)
|
||||||
- [Debugging](./mir/debugging.md)
|
- [Debugging](./mir/debugging.md)
|
||||||
|
|
|
||||||
|
|
@ -6,9 +6,12 @@ development.
|
||||||
|
|
||||||
There are six parts to this guide:
|
There are six parts to this guide:
|
||||||
|
|
||||||
1. [Building, Debugging, and Contributing to `rustc`][p1]: Contains information that should be useful no matter how
|
1. [Building and Debugging to `rustc`][p1]: Contains information that should be
|
||||||
you are contributing, such as procedures for contribution, building the
|
useful no matter how you are contributing, about building, debugging,
|
||||||
compiler, etc.
|
profiling, etc.
|
||||||
|
2. [Contributing to `rustc`][p1-5]: Contains information that should be useful
|
||||||
|
no matter how you are contributing, about procedures for contribution,
|
||||||
|
stabilizing features, etc.
|
||||||
2. [High-Level Compiler Architecture][p2]: Discusses the high-level
|
2. [High-Level Compiler Architecture][p2]: Discusses the high-level
|
||||||
architecture of the compiler and stages of the compile process.
|
architecture of the compiler and stages of the compile process.
|
||||||
3. [Source Code Representation][p3]: Describes the process of taking raw source code from the user and
|
3. [Source Code Representation][p3]: Describes the process of taking raw source code from the user and
|
||||||
|
|
@ -19,7 +22,8 @@ There are six parts to this guide:
|
||||||
6. [Appendices][app] at the end with useful reference information. There are a
|
6. [Appendices][app] at the end with useful reference information. There are a
|
||||||
few of these with different information, inluding a glossary.
|
few of these with different information, inluding a glossary.
|
||||||
|
|
||||||
[p1]: ./part-1-intro.md
|
[p1]: ./getting-started.md
|
||||||
|
[p1-5]: ./compiler-team.md
|
||||||
[p2]: ./part-2-intro.md
|
[p2]: ./part-2-intro.md
|
||||||
[p3]: ./part-3-intro.md
|
[p3]: ./part-3-intro.md
|
||||||
[p4]: ./part-4-intro.md
|
[p4]: ./part-4-intro.md
|
||||||
|
|
|
||||||
|
|
@ -1,7 +0,0 @@
|
||||||
# Part 1: Building, Debugging, and Contributing to `rustc`
|
|
||||||
|
|
||||||
This section of the rustc-dev-guide contains knowledge that should be useful to you
|
|
||||||
regardless of what part of the compiler you are working on. This includes both
|
|
||||||
technical info and tips (e.g. how to compile and debug the compiler) and info
|
|
||||||
about processes in the Rust project (e.g. stabilization and info about the
|
|
||||||
compiler team).
|
|
||||||
Loading…
Reference in New Issue