Correct the documentation

- Fix some style issue, typos, and examples
- Follow the variable naming conventions
- Fix tables both in the project and on 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-24 12:52:02 +02:00
parent 48d5eee920
commit e93e32635f
7 changed files with 180 additions and 153 deletions
+23 -28
View File
@@ -1,4 +1,4 @@
### Setting Up Prerequisites
## Setting up prerequisites
Currently, only Ubuntu 14.04+ is officially supported as primary development environment.
@@ -19,38 +19,41 @@ 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`
- `awk`
- `bc`
- `find`
- `sed`
### Building Jerryscript
## 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
```
##### Set a profile mode (full|minimal):
**Set a profile mode (full, minimal)**
```bash
python tools/build.py --feature=full|minimal
```
##### Use (jerry|compiler-default|external libc) libc:
**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
@@ -63,7 +66,7 @@ python tools/build.py --jerry-libc=off --compiler-default-libc=on
python tools/build.py --jerry-libc=off --compiler-default-libc=off --compile-flag="-I/path/to/libc/include"
```
##### Add toolchain file:
**Add toolchain file**
The ```cmake``` dir already contains some usable toolchain files, which you can use in the following format:
@@ -77,72 +80,64 @@ For example the cross-compile to RaspberryPi 2 is something like this:
python tools/build.py --toolchain=cmake/toolchain_linux_armv7l.cmake
```
##### To get a list of all the 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
#### Running only one type of test:
##### To run build option tests:
**To run build option tests**
```bash
python tools/run-tests.py --buildoption-test
```
##### To run unittests:
**To run unittests**
```bash
python tools/run-tests.py --unittests
```
##### To run jerry-tests:
**To run jerry-tests**
```bash
python tools/run-tests.py --jerry-tests
```
##### To run jerry-test-suite:
**To run jerry-test-suite**
```bash
python tools/run-tests.py --jerry-test-suite
```
##### To run signed-off check:
**To run signed-off check**
```bash
python tools/run-tests.py --check-signed-off
```
##### To run cppcheck:
**To run cppcheck**
```bash
python tools/run-tests.py --check-cppcheck
```
##### To run vera check:
**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:
**To get a list of all the available test options**
```bash
python tools/run-tests.py --help
```