diff --git a/docs/01.GETTING-STARTED.md b/docs/01.GETTING-STARTED.md index 39074ea21c..c114df45dc 100644 --- a/docs/01.GETTING-STARTED.md +++ b/docs/01.GETTING-STARTED.md @@ -21,51 +21,128 @@ To make our scripts run correctly, several shell utilities should be available o - `find` - `awk` -- `wget` -### Building Debug Version +### Building Jerryscript -To build debug version for Linux: +##### To build debug version for Linux: ```bash python tools/build.py --debug ``` -To build debug version for Linux without LTO (Link Time Optimization): +##### To build debug version for Linux without LTO (Link Time Optimization): ```bash python tools/build.py --debug --lto=off ``` -Add custom arguments to CMake: +##### Add custom arguments to CMake: ```bash -python tools/build.py --cmake-param CMAKE_PARAM +python tools/build.py --cmake-param=CMAKE_PARAM ``` -Add toolchain file: +##### Set an ECMAScript profile mode (full|compact|minimal): -The cmake dir already contains some usable toolchain files. +```bash +python tools/build.py --feature=full|compact|minimal +``` + +##### Use (jerry|compiler-default|external libc) libc: + +The default libc is jerry-libc, but you can use compiler-default libc or an external libc: +- compiler-default libc: + +```bash +python tools/build.py --jerry-libc=off --compiler-default-libc=on +``` + +- external libc: + +```bash +python tools/build.py --jerry-libc=off --compiler-default-libc=off --compile-flag="-I/path/to/libc/include" +``` + +##### Add toolchain file: + +The ```cmake``` dir already contains some usable toolchain files, which you can use in the following format: ```bash -python tools/build.py --toolchain TOOLCHAIN +python tools/build.py --toolchain=TOOLCHAIN ``` -Use (jerry|compiler-default|external libc) libc: +For example the cross-compile to RaspberryPi 2 is something like this: ```bash -python tools/build.py --libc LIBC +python tools/build.py --toolchain=cmake/toolchain_linux_armv7l-hf.cmake ``` -The possible arguments are `jerry` , `compiler` , `` -To get more available buildoptions for Linux: +##### To get a list of all the available buildoptions for Linux: ```bash python tools/build.py --help ``` -### Checking Patch +### Checking patch ```bash python tools/run-tests.py --precommit ``` + + +#### Running only one type of test: + +##### To run build option tests: + +```bash +python tools/run-tests.py --buildoption-test +``` + +##### To run unittests: + +```bash +python tools/run-tests.py --unittests +``` + +##### To run jerry-tests: + +```bash +python tools/run-tests.py --jerry-tests +``` + +##### To run jerry-test-suite: + +```bash +python tools/run-tests.py --jerry-test-suite +``` + +##### To run signed-off check: + +```bash +python tools/run-tests.py --check-signed-off +``` + +##### To run cppcheck: + +```bash +python tools/run-tests.py --check-cppcheck +``` + +##### To run vera check: + +```bash +python tools/run-tests.py --check-vera +``` + +##### Use toolchain file: + +The cmake dir already contains some usable toolchain files, which you can use in the following format: + +python tools/run-tests.py --toolchain=TOOLCHAIN + +##### To get a list of all the available test options: + +```bash +python tools/run-tests.py --help +``` +