Update the webpage

JerryScript-DCO-1.0-Signed-off-by: Zsolt Borbély zsborbely.u-szeged@partner.samsung.com
This commit is contained in:
Zsolt Borbély
2016-08-26 16:38:24 +02:00
parent 0deac9f81c
commit 622f42e0a8
5 changed files with 336 additions and 165 deletions
+103 -27
View File
@@ -7,70 +7,146 @@ permalink: /getting-started/
* toc
{:toc}
### Setting Up Prerequisites
## Setting up prerequisites
Currently, only Ubuntu 14.04+ is officially supported as primary development environment.
There are several dependencies, that should be installed manually. The following list is required for building:
- `gcc` higher than `4.8.2`
- `gcc` or any C99-compliant compiler
- native
- arm-none-eabi
- `cmake` higher than `2.8.12.2`
- `make` higher than `3.81`
- `bash` higher than `4.3.11`
- `cppcheck` higher than 1.61
- `vera++` higher than 1.2.1
- `cmake` >= `2.8.12.2`
- `bash` >= `4.3.11`
- `cppcheck` >= `1.61`
- `vera++` >= `1.2.1`
- `python` >= `2.7.6`
```bash
sudo apt-get install gcc g++ gcc-arm-none-eabi cmake cppcheck vera++
sudo apt-get install gcc g++ gcc-arm-none-eabi cmake cppcheck vera++ python
```
To make our scripts run correctly, several shell utilities should be available on the system:
- `find`
- `bc`
- `awk`
- `bc`
- `find`
- `sed`
- `sha256sum`
- `wget`
Upon first build, `make` would try to setup prerequisites, required for further development and pre-commit testing:
## Building JerryScript
- STM32F3 and STM32F4 libraries
**To build debug version for Linux**
```bash
make prerequisites -j
python tools/build.py --debug
```
It may take time, so go grab some coffee:
**To build debug version for Linux without LTO (Link Time Optimization)**
```bash
Setting up prerequisites... (log file: ./build/prerequisites/prerequisites.log)
python tools/build.py --debug --lto=off
```
### Building Debug Version
To build debug version for Linux:
**Add custom arguments to CMake**
```bash
make debug.linux -j
python tools/build.py --cmake-param=CMAKE_PARAM
```
To build debug version for Linux without LTO (Link Time Optimization):
**Set a profile mode (full, minimal)**
```bash
LTO=OFF make debug.linux -j
python tools/build.py --feature=full|minimal
```
### Checking Patch
**Use (jerry, compiler-default, external) libc**
The default libc is jerry-libc, but you can use compiler-default libc or an external libc:
- compiler-default libc:
```bash
make precommit -j
python tools/build.py --jerry-libc=off --compiler-default-libc=on
```
If some style guidelines, build or test runs fail during precommit, then this is indicated with a message like this:
- external libc:
```bash
python tools/build.py --jerry-libc=off --compiler-default-libc=off --compile-flag="-I/path/to/libc/include"
```
Build failed. See ./build/bin/unittests/make.log for details.
**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.cmake
```
**To get a list of all the available buildoptions for Linux**
```bash
python tools/build.py --help
```
## 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
```
**To get a list of all the available test options**
```bash
python tools/run-tests.py --help
```