archive-gh-me/jerryscript
1
0
Fork 0
mirror of https://github.com/jerryscript-project/jerryscript.git synced 2025-12-15 16:29:21 +00:00
Code Issues Projects Releases Wiki Activity

Complete the getting-started documentation after the build-system update.

Browse Source 
JerryScript-DCO-1.0-Signed-off-by: Robert Sipka rsipka.uszeged@partner.samsung.com
This commit is contained in:
Robert Sipka 2016-08-01 09:47:35 +02:00
parent e70c89e39e
commit b14ca4e248
1 changed files with 92 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

107
docs/01.GETTING-STARTED.md
View File

@ -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:
The cmake dir already contains some usable toolchain files.
##### Set an ECMAScript profile mode (full|compact|minimal):
```bash
python tools/build.py --toolchain TOOLCHAIN
python tools/build.py --feature=full|compact|minimal
```
Use (jerry|compiler-default|external libc) libc:
##### 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 --libc LIBC
python tools/build.py --jerry-libc=off --compiler-default-libc=on
```
The possible arguments are `jerry` , `compiler` , `<path of external lib>`
To get more available buildoptions for Linux:
- 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
```
For example the cross-compile to RaspberryPi 2 is something like this:
```bash
python tools/build.py --toolchain=cmake/toolchain_linux_armv7l-hf.cmake
```
##### 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
```