Skip to content

Commit b14ca4e

Browse files
committed
Complete the getting-started documentation after the build-system update.
JerryScript-DCO-1.0-Signed-off-by: Robert Sipka rsipka.uszeged@partner.samsung.com
1 parent e70c89e commit b14ca4e

File tree

1 file changed

+91
-14
lines changed

1 file changed

+91
-14
lines changed

docs/01.GETTING-STARTED.md

Lines changed: 91 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -21,51 +21,128 @@ To make our scripts run correctly, several shell utilities should be available o
2121

2222
- `find`
2323
- `awk`
24-
- `wget`
2524

26-
### Building Debug Version
25+
### Building Jerryscript
2726

28-
To build debug version for Linux:
27+
##### To build debug version for Linux:
2928

3029
```bash
3130
python tools/build.py --debug
3231
```
3332

34-
To build debug version for Linux without LTO (Link Time Optimization):
33+
##### To build debug version for Linux without LTO (Link Time Optimization):
3534

3635
```bash
3736
python tools/build.py --debug --lto=off
3837
```
3938

40-
Add custom arguments to CMake:
39+
##### Add custom arguments to CMake:
4140

4241
```bash
43-
python tools/build.py --cmake-param CMAKE_PARAM
42+
python tools/build.py --cmake-param=CMAKE_PARAM
4443
```
4544

46-
Add toolchain file:
45+
##### Set an ECMAScript profile mode (full|compact|minimal):
4746

48-
The cmake dir already contains some usable toolchain files.
47+
```bash
48+
python tools/build.py --feature=full|compact|minimal
49+
```
50+
51+
##### Use (jerry|compiler-default|external libc) libc:
52+
53+
The default libc is jerry-libc, but you can use compiler-default libc or an external libc:
54+
- compiler-default libc:
55+
56+
```bash
57+
python tools/build.py --jerry-libc=off --compiler-default-libc=on
58+
```
59+
60+
- external libc:
61+
62+
```bash
63+
python tools/build.py --jerry-libc=off --compiler-default-libc=off --compile-flag="-I/path/to/libc/include"
64+
```
65+
66+
##### Add toolchain file:
67+
68+
The ```cmake``` dir already contains some usable toolchain files, which you can use in the following format:
4969

5070
```bash
51-
python tools/build.py --toolchain TOOLCHAIN
71+
python tools/build.py --toolchain=TOOLCHAIN
5272
```
5373

54-
Use (jerry|compiler-default|external libc) libc:
74+
For example the cross-compile to RaspberryPi 2 is something like this:
5575

5676
```bash
57-
python tools/build.py --libc LIBC
77+
python tools/build.py --toolchain=cmake/toolchain_linux_armv7l-hf.cmake
5878
```
59-
The possible arguments are `jerry` , `compiler` , `<path of external lib>`
6079

61-
To get more available buildoptions for Linux:
80+
##### To get a list of all the available buildoptions for Linux:
6281

6382
```bash
6483
python tools/build.py --help
6584
```
6685

67-
### Checking Patch
86+
### Checking patch
6887

6988
```bash
7089
python tools/run-tests.py --precommit
7190
```
91+
92+
93+
#### Running only one type of test:
94+
95+
##### To run build option tests:
96+
97+
```bash
98+
python tools/run-tests.py --buildoption-test
99+
```
100+
101+
##### To run unittests:
102+
103+
```bash
104+
python tools/run-tests.py --unittests
105+
```
106+
107+
##### To run jerry-tests:
108+
109+
```bash
110+
python tools/run-tests.py --jerry-tests
111+
```
112+
113+
##### To run jerry-test-suite:
114+
115+
```bash
116+
python tools/run-tests.py --jerry-test-suite
117+
```
118+
119+
##### To run signed-off check:
120+
121+
```bash
122+
python tools/run-tests.py --check-signed-off
123+
```
124+
125+
##### To run cppcheck:
126+
127+
```bash
128+
python tools/run-tests.py --check-cppcheck
129+
```
130+
131+
##### To run vera check:
132+
133+
```bash
134+
python tools/run-tests.py --check-vera
135+
```
136+
137+
##### Use toolchain file:
138+
139+
The cmake dir already contains some usable toolchain files, which you can use in the following format:
140+
141+
python tools/run-tests.py --toolchain=TOOLCHAIN
142+
143+
##### To get a list of all the available test options:
144+
145+
```bash
146+
python tools/run-tests.py --help
147+
```
148+

0 commit comments

Comments
 (0)