Commit 41c1b98f authored by Matthew Brett's avatar Matthew Brett
Browse files

More edits to the README

[skip ci]
parent 319c34a2
......@@ -64,7 +64,7 @@ in the ``.travis.yml`` or bash shell scripts listed above are available for
your build and test.
The manylinux1 build / test is more complicated, because the build has to run
inside a manylinux docker container, and the test has to run in another Ubuntu
inside a manylinux1 docker container, and the test has to run in another Ubuntu
container. See ``multibuild/travis_linux_steps.sh`` for the default
invocation of docker for the build and test phases, and the environment
variables available inside the containers.
......@@ -73,19 +73,23 @@ variables available inside the containers.
Standard build and test functions
*********************************
The standard build commmand is ``build_wheel``. This is a bash function. By
The standard build command is ``build_wheel``. This is a bash function. By
default it is defined in ``multibuild/common_utils.sh``, but you can override
it in the project ``config.sh`` file (see below).
it in the project ``config.sh`` file (see below). Typically, you do not
override this function, but you define a ``pre_build`` function in
``config.sh``, to build any libraries you need. The default ``build_wheel``
function will call ``pre_build``, if defined, before building the wheel.
The standard test command is the bash function ``install_run``. This is also
defined ``multibuild/common_utils.sh``. Typically, you do not override this
function, but you define a ``pre_build`` function in ``config.sh``, to build
any libraries you need, and a ``run_tests`` function, to run your tests,
returning a non-zero error code for failure. The default ``install_run``
implementation will call ``pre_build``, if defined, and then calls the
``run_tests`` function, which you must define, probably in ``config.sh``. See
the examples below for examples of less and more complicateb builds, where the
complicated builds override more of the default implementations.
defined in ``multibuild/common_utils.sh``. Typically, you do not override
this function, but you define a ``run_tests`` function in ``config.sh``, to
run your tests. ``install_run`` calls ``run_tests`` from a new temporary
directory created in the root directory of your wheel-building repo, and
returning a non-zero exit code for failure.
See the example projects listed below for examples of less and more
complicated build / test setups, where the complicated setups override more of
the default implementations.
********************
To use these scripts
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment