moved crates in lib/ to src/, renamed crates, modified some files' text (#660)
moved crates in lib/ to src/, renamed crates, modified some files' text (#660)
This commit is contained in:
@@ -14,7 +14,7 @@ help:
|
||||
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
||||
|
||||
autohtml: html
|
||||
$(SPHINXABUILD) -z ../lib/codegen/meta-python --ignore '.*' -b html -E $(ALLSPHINXOPTS) $(BUILDDIR)/html
|
||||
$(SPHINXABUILD) -z ../cranelift-codegen/meta-python --ignore '.*' -b html -E $(ALLSPHINXOPTS) $(BUILDDIR)/html
|
||||
|
||||
.PHONY: help Makefile
|
||||
|
||||
|
||||
@@ -23,7 +23,7 @@ sys.path.insert(0, os.path.abspath('.'))
|
||||
|
||||
# Also add the meta-python directory to sys.path so autodoc can find the Cranelift meta
|
||||
# language definitions.
|
||||
sys.path.insert(0, os.path.abspath('../lib/codegen/meta-python'))
|
||||
sys.path.insert(0, os.path.abspath('../cranelift-codegen/meta-python'))
|
||||
|
||||
# -- General configuration ------------------------------------------------
|
||||
|
||||
|
||||
@@ -11,7 +11,7 @@ domain specific language embedded in Python. This document describes the Python
|
||||
modules that form the embedded DSL.
|
||||
|
||||
The meta language descriptions are Python modules under the
|
||||
:file:`lib/codegen/meta-python` directory. The descriptions are processed in two
|
||||
:file:`cranelift-codegen/meta-python` directory. The descriptions are processed in two
|
||||
steps:
|
||||
|
||||
1. The Python modules are imported. This has the effect of building static data
|
||||
@@ -23,8 +23,8 @@ steps:
|
||||
constant tables.
|
||||
|
||||
The main driver for this source code generation process is the
|
||||
:file:`lib/codegen/meta-python/build.py` script which is invoked as part of the build
|
||||
process if anything in the :file:`lib/codegen/meta-python` directory has changed
|
||||
:file:`cranelift-codegen/meta-python/build.py` script which is invoked as part of the build
|
||||
process if anything in the :file:`cranelift-codegen/meta-python` directory has changed
|
||||
since the last build.
|
||||
|
||||
|
||||
@@ -38,7 +38,7 @@ of code generation. Each setting is defined in the meta language so a compact
|
||||
and consistent Rust representation can be generated. Shared settings are defined
|
||||
in the :mod:`base.settings` module. Some settings are specific to a target ISA,
|
||||
and defined in a :file:`settings.py` module under the appropriate
|
||||
:file:`lib/codegen/meta-python/isa/*` directory.
|
||||
:file:`cranelift-codegen/meta-python/isa/*` directory.
|
||||
|
||||
Settings can take boolean on/off values, small numbers, or explicitly enumerated
|
||||
symbolic values. Each type is represented by a sub-class of :class:`Setting`:
|
||||
@@ -433,7 +433,7 @@ architectures. Each ISA is represented by a :py:class:`cdsl.isa.TargetISA` insta
|
||||
.. autoclass:: TargetISA
|
||||
|
||||
The definitions for each supported target live in a package under
|
||||
:file:`lib/codegen/meta-python/isa`.
|
||||
:file:`cranelift-codegen/meta-python/isa`.
|
||||
|
||||
.. automodule:: isa
|
||||
:members:
|
||||
|
||||
@@ -73,10 +73,10 @@ test.
|
||||
|
||||
These tests are usually found in the :file:`tests` top-level directory where
|
||||
they have access to all the crates in the Cranelift repository. The
|
||||
:file:`lib/codegen` and :file:`lib/reader` crates have no external
|
||||
:file:`cranelift-codegen` and :file:`cranelift-reader` crates have no external
|
||||
dependencies, which can make testing tedious. Integration tests that don't need
|
||||
to depend on other crates can be placed in :file:`lib/codegen/tests` and
|
||||
:file:`lib/reader/tests`.
|
||||
to depend on other crates can be placed in :file:`cranelift-codegen/tests` and
|
||||
:file:`cranelift-reader/tests`.
|
||||
|
||||
File tests
|
||||
==========
|
||||
@@ -109,7 +109,7 @@ header:
|
||||
isa_spec : "isa" isa_name { `option` } "\n"
|
||||
|
||||
The options given on the ``isa`` line modify the ISA-specific settings defined in
|
||||
:file:`lib/codegen/meta-python/isa/*/settings.py`.
|
||||
:file:`cranelift-codegen/meta-python/isa/*/settings.py`.
|
||||
|
||||
All types of tests allow shared Cranelift settings to be modified:
|
||||
|
||||
@@ -119,7 +119,7 @@ All types of tests allow shared Cranelift settings to be modified:
|
||||
option : flag | setting "=" value
|
||||
|
||||
The shared settings available for all target ISAs are defined in
|
||||
:file:`lib/codegen/meta-python/base/settings.py`.
|
||||
:file:`cranelift-codegen/meta-python/base/settings.py`.
|
||||
|
||||
The ``set`` lines apply settings cumulatively::
|
||||
|
||||
|
||||
Reference in New Issue
Block a user