diff --git a/cranelift/README.md b/cranelift/README.md index c943d760be..b4c42e849b 100644 --- a/cranelift/README.md +++ b/cranelift/README.md @@ -3,7 +3,7 @@ Cranelift Code Generator Cranelift is a low-level retargetable code generator. It translates a [target-independent intermediate -representation](https://cranelift.readthedocs.io/en/latest/langref.html) +representation](https://cranelift.readthedocs.io/en/latest/ir.html) into executable machine code. [![Documentation Status](https://readthedocs.org/projects/cranelift/badge/?version=latest)](https://cranelift.readthedocs.io/en/latest/?badge=latest) diff --git a/cranelift/docs/compare-llvm.rst b/cranelift/docs/compare-llvm.rst index 7f3c320ace..6ca562bcd3 100644 --- a/cranelift/docs/compare-llvm.rst +++ b/cranelift/docs/compare-llvm.rst @@ -89,7 +89,7 @@ representation. Some target ISAs have a fast instruction selector that can translate simple code directly to MachineInstrs, bypassing SelectionDAG when possible. -:doc:`Cranelift ` uses a single intermediate representation to cover +:doc:`Cranelift ` uses a single intermediate representation to cover these levels of abstraction. This is possible in part because of Cranelift's smaller scope. diff --git a/cranelift/docs/index.rst b/cranelift/docs/index.rst index 08b27162c3..f37c83e34a 100644 --- a/cranelift/docs/index.rst +++ b/cranelift/docs/index.rst @@ -6,8 +6,8 @@ Contents: .. toctree:: :maxdepth: 1 - langref - metaref + ir + meta testing regalloc compare-llvm diff --git a/cranelift/docs/langref.rst b/cranelift/docs/ir.rst similarity index 99% rename from cranelift/docs/langref.rst rename to cranelift/docs/ir.rst index 52be70c7aa..777693ea13 100644 --- a/cranelift/docs/langref.rst +++ b/cranelift/docs/ir.rst @@ -1,6 +1,6 @@ -**************************** -Cranelift Language Reference -**************************** +********************** +Cranelift IR Reference +********************** .. default-domain:: clif .. highlight:: clif diff --git a/cranelift/docs/metaref.rst b/cranelift/docs/meta.rst similarity index 99% rename from cranelift/docs/metaref.rst rename to cranelift/docs/meta.rst index 361dca9172..f805e08875 100644 --- a/cranelift/docs/metaref.rst +++ b/cranelift/docs/meta.rst @@ -80,7 +80,7 @@ open :class:`InstructionGroup`. .. autoclass:: InstructionGroup :members: -The basic Cranelift instruction set described in :doc:`langref` is defined by the +The basic Cranelift instruction set described in :doc:`ir` is defined by the Python module :mod:`base.instructions`. This module has a global value :data:`base.instructions.GROUP` which is an :class:`InstructionGroup` instance containing all the base instructions. diff --git a/cranelift/docs/testing.rst b/cranelift/docs/testing.rst index 345940c772..747ba53d54 100644 --- a/cranelift/docs/testing.rst +++ b/cranelift/docs/testing.rst @@ -90,7 +90,7 @@ easier to provide substantial input functions for the compiler tests. File tests are :file:`*.clif` files in the :file:`filetests/` directory hierarchy. Each file has a header describing what to test followed by a number of input functions in the :doc:`Cranelift textual intermediate representation -`: +`: .. productionlist:: test_file : test_header `function_list` diff --git a/lib/codegen/src/result.rs b/lib/codegen/src/result.rs index 883ccebda2..0956b4f4d2 100644 --- a/lib/codegen/src/result.rs +++ b/lib/codegen/src/result.rs @@ -19,7 +19,7 @@ pub enum CodegenError { /// Cranelift can compile very large and complicated functions, but the [implementation has /// limits][limits] that cause compilation to fail when they are exceeded. /// - /// [limits]: https://cranelift.readthedocs.io/en/latest/langref.html#implementation-limits + /// [limits]: https://cranelift.readthedocs.io/en/latest/ir.html#implementation-limits #[fail(display = "Implementation limit exceeded")] ImplLimitExceeded, diff --git a/lib/wasm/src/environ/spec.rs b/lib/wasm/src/environ/spec.rs index 3c52ba32fe..4852790834 100644 --- a/lib/wasm/src/environ/spec.rs +++ b/lib/wasm/src/environ/spec.rs @@ -54,7 +54,7 @@ pub enum WasmError { /// Cranelift can compile very large and complicated functions, but the [implementation has /// limits][limits] that cause compilation to fail when they are exceeded. /// - /// [limits]: https://cranelift.readthedocs.io/en/latest/langref.html#implementation-limits + /// [limits]: https://cranelift.readthedocs.io/en/latest/ir.html#implementation-limits #[fail(display = "Implementation limit exceeded")] ImplLimitExceeded, }