Documentation update (#1573)

JerryScript-DCO-1.0-Signed-off-by: László Langó llango.u-szeged@partner.samsung.com
This commit is contained in:
László Langó
2017-02-10 11:05:26 +01:00
committed by GitHub
parent bfc5bee394
commit 32674ff379
2 changed files with 50 additions and 7 deletions
+33 -2
View File
@@ -45,10 +45,10 @@ python tools/build.py --debug --lto=off
python tools/build.py --cmake-param=CMAKE_PARAM python tools/build.py --cmake-param=CMAKE_PARAM
``` ```
**Set a profile mode (full, minimal)** **Set a profile mode (ES5.1, subset of ES2015, minimal)**
```bash ```bash
python tools/build.py --feature=full|minimal python tools/build.py --profile=es5.1|es2015-subset|minimal
``` ```
**Use (jerry, compiler-default, external) libc** **Use (jerry, compiler-default, external) libc**
@@ -81,6 +81,37 @@ For example the cross-compile to RaspberryPi 2 is something like this:
python tools/build.py --toolchain=cmake/toolchain_linux_armv7l.cmake python tools/build.py --toolchain=cmake/toolchain_linux_armv7l.cmake
``` ```
**Use system memory allocator**
```bash
python tools/build.py --system-allocator=on --jerry-libc=off
```
*Note*: System allocator is only supported on 32 bit systems.
**Enable 32bit compressed pointers**
```bash
python tools/build.py --cpointer-32bit=on
```
*Note*: There is no compression/decompression on 32 bit systems, if enabled.
**Change default heap size (512K)**
```bash
python tools/build.py --mem-heap=256
```
If you would like to use more than 512K, then you must enable the 32 bit compressed pointers.
```bash
python tools/build.py --cpointer-32bit=on --mem-heap=1024
```
*Note*: The heap size will be allocated statically at compile time, when JerryScript memory
allocator is used.
**To get a list of all the available buildoptions for Linux** **To get a list of all the available buildoptions for Linux**
```bash ```bash
+17 -5
View File
@@ -1316,10 +1316,13 @@ jerry_get_utf8_string_length (const jerry_value_t value);
**Summary** **Summary**
Copy the characters of a string into a specified buffer. The Copy the characters of a string into a specified cesu-8 buffer.
'\0' character could occur in character buffer. Returns 0, The '\0' character could occur in the character buffer. Returns 0,
if the value parameter is not a string or the buffer is if the value parameter is not a string or the buffer is not large
not large enough for the whole string. enough for the whole string.
*Note*: Does not put '\0' to the end of string, the return value identifies
the number of valid bytes in the output buffer.
**Prototype** **Prototype**
@@ -1362,9 +1365,12 @@ jerry_string_to_char_buffer (const jerry_value_t value,
Copy the characters of a string into a specified utf-8 buffer. Copy the characters of a string into a specified utf-8 buffer.
The '\0' character could occur in character buffer. Returns 0, The '\0' character could occur in character buffer. Returns 0,
if the value parameter is not a string or the buffer isn't if the value parameter is not a string or the buffer is not
large enough for the whole string. large enough for the whole string.
*Note*: Does not put '\0' to the end of string, the return value identifies
the number of valid bytes in the output buffer.
**Prototype** **Prototype**
```c ```c
@@ -1410,6 +1416,9 @@ parameter is not a string. It will extract the substring between the
specified start position and the end position (or the end of the string, specified start position and the end position (or the end of the string,
whichever comes first). whichever comes first).
*Note*: Does not put '\0' to the end of string, the return value identifies
the number of valid bytes in the output buffer.
**Prototype** **Prototype**
```c ```c
@@ -1462,6 +1471,9 @@ parameter is not a string. It will extract the substring between the specified
start position and the end position (or the end of the string, whichever start position and the end position (or the end of the string, whichever
comes first). comes first).
*Note*: Does not put '\0' to the end of string, the return value identifies
the number of valid bytes in the output buffer.
**Prototype** **Prototype**
```c ```c