[docs] Update docs to point to the docs.rs website;
This commit is contained in:
@@ -59,7 +59,7 @@ master_doc = 'index'
|
||||
|
||||
# General information about the project.
|
||||
project = u'cranelift'
|
||||
copyright = u'2018, Cranelift Developers'
|
||||
copyright = u'2019, Cranelift Developers'
|
||||
author = u'Cranelift Developers'
|
||||
|
||||
# The version info for the project you're documenting, acts as replacement for
|
||||
|
||||
@@ -15,11 +15,19 @@ Contents:
|
||||
Rust Crate Documentation
|
||||
========================
|
||||
|
||||
`cranelift <https://docs.rs/cranelift/>`_
|
||||
`cranelift <https://docs.rs/cranelift-codegen/>`_
|
||||
This is an umbrella crate that re-exports the codegen and frontend crates,
|
||||
to make them easier to use.
|
||||
|
||||
`cranelift-codegen <https://docs.rs/cranelift-codegen/>`_
|
||||
This is the core code generator crate. It takes Cranelift IR as input
|
||||
and emits encoded machine instructions, along with symbolic relocations,
|
||||
as output.
|
||||
|
||||
`cranelift-codegen-meta <https://docs.rs/cranelift-codegen-meta/>`_
|
||||
This crate contains the meta-language utilities and descriptions used by the
|
||||
code generator.
|
||||
|
||||
`cranelift-wasm <https://docs.rs/cranelift-wasm/>`_
|
||||
This crate translates WebAssembly code into Cranelift IR.
|
||||
|
||||
|
||||
@@ -5,6 +5,13 @@ Cranelift IR Reference
|
||||
.. default-domain:: clif
|
||||
.. highlight:: clif
|
||||
|
||||
.. todo:: Update the IR reference
|
||||
|
||||
This document is likely to be outdated and missing some important
|
||||
information. It is recommended to look at the list of instructions as
|
||||
documented in the `InstBuilder` documentation:
|
||||
https://docs.rs/cranelift-codegen/latest/cranelift_codegen/ir/trait.InstBuilder.html
|
||||
|
||||
The Cranelift intermediate representation (:term:`IR`) has two primary forms:
|
||||
an *in-memory data structure* that the code generator library is using, and a
|
||||
*text format* which is used for test cases and debug output.
|
||||
|
||||
@@ -7,8 +7,15 @@ Cranelift Meta Language Reference
|
||||
.. module:: cdsl
|
||||
|
||||
The Cranelift meta language is used to define instructions for Cranelift. It is a
|
||||
domain specific language embedded in Python. This document describes the Python
|
||||
modules that form the embedded DSL.
|
||||
domain specific language embedded in Rust.
|
||||
|
||||
.. todo:: Point to the Rust documentation of the meta crate here.
|
||||
|
||||
This document is very out-of-date. Instead, you can have a look at the
|
||||
work-in-progress documentation of the `meta` crate there:
|
||||
https://docs.rs/cranelift-codegen-meta/0.34.0/cranelift_codegen_meta/.
|
||||
|
||||
This document describes the Python modules that form the embedded DSL.
|
||||
|
||||
The meta language descriptions are Python modules under the
|
||||
:file:`cranelift-codegen/meta-python` directory. The descriptions are processed in two
|
||||
|
||||
Reference in New Issue
Block a user