Bensuperpc/dockcross
1
0
Fork 0
mirror of https://github.com/bensuperpc/dockcross.git synced 2024-11-13 22:51:31 +01:00
Code Issues Packages Projects Releases Wiki Activity

doc: README formatting

Browse Source
This commit is contained in:
Matt McCormick 2016-07-03 22:20:01 -04:00
parent 45631a48c0
commit 6f987f4013
1 changed files with 27 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
README.rst
View File

@ -6,12 +6,12 @@ Dockerfiles for cross compiling in a Docker container.
Features Features
======== ========
* different toolchains for cross compiling * Different toolchains for cross compiling.
* commands in the container are run as the calling user, so that any created files have the expected ownership (ie. not root) * Commands in the container are run as the calling user, so that any created files have the expected ownership, (i.e. not root).
* make variables (`CC`, `LD` etc) are set to point to the appropriate tools in the container * Make variables (`CC`, `LD` etc) are set to point to the appropriate tools in the container.
* cmake and ninja are precompiled available with a toolchain file for cmake * Recent cmake and ninja are precompiled. Toolchain files available for cmake.
* current directory is mounted as the container's workdir, `/build` * Current directory is mounted as the container's workdir, ``/build``.
* works with boot2docker on OSX and Docker for Mac beta (1.11.1-beta12) * Works with boot2docker on OSX and Docker for Mac beta (1.11.1-beta12).
Installation Installation
============ ============
@ -31,41 +31,44 @@ For the impatient, here's a one-liner to compile a hello world for armv7::
docker run thewtex/cross-compiler-linux-armv7 > dockcross && chmod +x dockcross && ./dockcross gcc test/C/hello.c -o hello_arm docker run thewtex/cross-compiler-linux-armv7 > dockcross && chmod +x dockcross && ./dockcross gcc test/C/hello.c -o hello_arm
Note how invoking any toolchain command (make, gcc, etc...) is just a matter of prepending **dockcross** in the commandline: Note how invoking any toolchain command (make, gcc, etc...) is just a matter of prepending **dockcross** in the commandline::
`dockcross [command] [args...]` dockcross [command] [args...]
Dockcross will thus execute the given command-line inside the container, along with all arguments passed after the command. The dockcross script will execute the given command-line inside the container, along with all arguments passed after the command.
Alternatively, if the command matches one of the dockcross built-in commands (see below), that will be executed locally. Alternatively, if the command matches one of the dockcross built-in commands (see below), they will be executed locally.
Built-in commands Built-in commands
================= =================
- `dockcross -- [command] [args...]`: Forces a command to run inside the container (in case of a name clash with a built-in command), use `--` before the command. - ``dockcross -- [command] [args...]``: Forces a command to run inside the container (in case of a name clash with a built-in command), use ``--`` before the command.
- `dockcross update-image`: Fetch the latest version of the docker image. - ``dockcross update-image``: Fetch the latest version of the docker image.
- `dockcross update-script`: Update the installed dockcross script with the one bundled in the image. - ``dockcross update-script``: Update the installed dockcross script with the one bundled in the image.
- `dockcross update`: Update both the docker image, and the dockcross script. - ``dockcross update``: Update both the docker image, and the dockcross script.
Configuration Configuration
============= =============
The following command-line options and environment variables are used. In all cases, the command-line option overrides the environment variable. The following command-line options and environment variables are used. In all cases, the command-line option overrides the environment variable.
### DOCKCROSS_CONFIG / --config <path-to-config-file> DOCKCROSS_CONFIG / --config <path-to-config-file>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This file is sourced if it exists. This file is sourced if it exists.
Default: `~/.dockcross` Default: ``~/.dockcross``
### DOCKCROSS_IMAGE / --image <docker-image-name> DOCKCROSS_IMAGE / --image <docker-image-name>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The docker image to run. The docker image to run.
Default: thewtex/cross-compiler-linux-armv7 Default: thewtex/cross-compiler-linux-armv7
### DOCKCROSS_ARGS / --args <docker-run-args> DOCKCROSS_ARGS / --args <docker-run-args>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Extra arguments to pass to the `docker run` command. Extra arguments to pass to the `docker run` command.
@ -77,11 +80,11 @@ Examples
3. **dockcross ninja -Cbuild**: Run ninja in the generated build directory. 3. **dockcross ninja -Cbuild**: Run ninja in the generated build directory.
4. **dockcross bash -c 'find . -name \*.o | sort > objects.txt'** 4. **dockcross bash -c 'find . -name \*.o | sort > objects.txt'**
Note that commands are executed verbatim. If you require any shell processing for environment variable expansion or redirection, please use `bash -c 'command args...'`. Note that commands are executed verbatim. If you require any shell processing for environment variable expansion or redirection, please use ``bash -c 'command args...'``.
--- ---
Credits go to `sdt/docker-raspberry-pi-cross-compiler <https://github.com/sdt/docker-raspberry-pi-cross-compiler>`_, who invented the base of this **dockcross** script. Credits go to `sdt/docker-raspberry-pi-cross-compiler <https://github.com/sdt/docker-raspberry-pi-cross-compiler>`_, who invented the base of the **dockcross** script.
CI status CI status