Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
fengzch-das
multibuild
Commits
41c1b98f
Commit
41c1b98f
authored
Jul 04, 2016
by
Matthew Brett
Browse files
More edits to the README
[skip ci]
parent
319c34a2
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
15 additions
and
11 deletions
+15
-11
README.rst
README.rst
+15
-11
No files found.
README.rst
View file @
41c1b98f
...
@@ -64,7 +64,7 @@ in the ``.travis.yml`` or bash shell scripts listed above are available for
...
@@ -64,7 +64,7 @@ in the ``.travis.yml`` or bash shell scripts listed above are available for
your build and test.
your build and test.
The manylinux1 build / test is more complicated, because the build has to run
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 manylinux
1
docker container, and the test has to run in another Ubuntu
container. See ``multibuild/travis_linux_steps.sh`` for the default
container. See ``multibuild/travis_linux_steps.sh`` for the default
invocation of docker for the build and test phases, and the environment
invocation of docker for the build and test phases, and the environment
variables available inside the containers.
variables available inside the containers.
...
@@ -73,19 +73,23 @@ variables available inside the containers.
...
@@ -73,19 +73,23 @@ variables available inside the containers.
Standard build and test functions
Standard build and test functions
*********************************
*********************************
The standard build comm
m
and 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
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
The standard test command is the bash function ``install_run``. This is also
defined ``multibuild/common_utils.sh``. Typically, you do not override this
defined in ``multibuild/common_utils.sh``. Typically, you do not override
function, but you define a ``pre_build`` function in ``config.sh``, to build
this function, but you define a ``run_tests`` function in ``config.sh``, to
any libraries you need, and a ``run_tests`` function, to run your tests,
run your tests. ``install_run`` calls ``run_tests`` from a new temporary
returning a non-zero error code for failure. The default ``install_run``
directory created in the root directory of your wheel-building repo, and
implementation will call ``pre_build``, if defined, and then calls the
returning a non-zero exit code for failure.
``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
See the example projects listed below for examples of less and more
complicated builds override more of the default implementations.
complicated build / test setups, where the complicated setups override more of
the default implementations.
********************
********************
To use these scripts
To use these scripts
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment