YourWishes/jerryscript
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Remove abandoned es5.1 profile from API reference (#4972)

Browse Source 
JerryScript-DCO-1.0-Signed-off-by: Yonggang Luo luoyonggang@gmail.com
This commit is contained in:
Yonggang Luo
2022-02-03 18:35:42 +08:00
committed by GitHub
parent 4924f9fd31
commit c5bc3786cf
4 changed files with 18 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/00.GETTING-STARTED.md
+2 -2
View File
@@ -51,10 +51,10 @@ tools/build.py --debug --logging=on --error-messages=on --line-info=on
python tools/build.py --cmake-param=CMAKE_PARAM
```
**Set a profile mode (ES.next, ES5.1, minimal)**
**Set a profile mode (es.next, minimal)**
```bash
python tools/build.py --profile=es.next|es5.1|minimal
python tools/build.py --profile=es.next|minimal
```
See also the related [README.md](https://github.com/jerryscript-project/jerryscript/blob/master/jerry-core/profiles/README.md).
docs/01.CONFIGURATION.md
+1 -1
View File
@@ -44,7 +44,7 @@ that can be used by the debugger to identify the currently executed source conte
### Profiles
This option can be used to enable/disable available JavaScript language features by providing profile files. Profile files contain a list of C definitions that configure each individual feature.
The `path` value for CMake and Python arguments should be a file path to the profile file, or one of `es.next`, `es5.1`, or `minimal`, which are the pre-defined profiles.
The `path` value for CMake and Python arguments should be a file path to the profile file, or one of `es.next` or `minimal`, which are the pre-defined profiles.
To see how a profile file should be created, or what configuration options are available in C, see the profile [README](https://github.com/jerryscript-project/jerryscript/blob/master/jerry-core/profiles/README.md).
| Options | |
docs/02.API-REFERENCE.md
+14 -8
View File
@@ -5702,7 +5702,7 @@ main (void)
# Functions for promise objects
These APIs all depend on the es.next profile (or on some build options).
These APIs are always enabled.
## jerry_promise_result
@@ -6124,7 +6124,7 @@ jerry_promise_reject (jerry_value_t promise, jerry_value_t argument);
# Functions for symbols
These APIs all depend on the es.next profile (or on build options).
These APIs are always enabled.
## jerry_symbol
@@ -6988,7 +6988,9 @@ jerry_error_sz (jerry_error_t error_type, const char *message_p);
Create new JavaScript DataView object.
*Note*:
- This API depends on the es.next profile.
- This API depends on a build option (`JERRY_BUILTIN_DATAVIEW`) and can be checked
in runtime with the `JERRY_FEATURE_DATAVIEW` feature enum value,
see: [jerry_feature_enabled](#jerry_feature_enabled).
- Returned value must be freed with [jerry_value_free](#jerry_value_free)
when it is no longer needed.
@@ -7307,7 +7309,6 @@ Create an empty promise object which can be resolved or rejected later
by calling jerry_promise_resolve or jerry_promise_reject.
*Note*:
- This API depends on the es.next profile.
- Returned value must be freed with [jerry_value_free](#jerry_value_free)
when it is no longer needed.
@@ -7348,7 +7349,9 @@ jerry_promise (void)
Create a new Proxy object with the given target and handler.
*Note*:
- This API depends on the es.next profile.
- This API depends on a build option (`JERRY_BUILTIN_PROXY`) and can be checked
in runtime with the `JERRY_FEATURE_PROXY` feature enum value,
see: [jerry_feature_enabled](#jerry_feature_enabled).
- Returned value must be freed with [jerry_value_free](#jerry_value_free)
when it is no longer needed.
@@ -7408,7 +7411,9 @@ Create a new Proxy object with the given target and handler.
The behaviour of the Proxy can be specialized with an options argument.
*Note*:
- This API depends on the es.next profile.
- This API depends on a build option (`JERRY_BUILTIN_PROXY`) and can be checked
in runtime with the `JERRY_FEATURE_PROXY` feature enum value,
see: [jerry_feature_enabled](#jerry_feature_enabled).
- Returned value must be freed with [jerry_value_free](#jerry_value_free)
when it is no longer needed.
@@ -7654,7 +7659,6 @@ Create symbol from an API value.
*Note*:
- The given argument is converted to string. This operation can throw an exception.
- This API depends on the es.next profile.
- Returned value must be freed with [jerry_value_free](#jerry_value_free)
when it is no longer needed.
@@ -11895,7 +11899,9 @@ jerry_realm_set_this (jerry_value_t realm_value, jerry_value_t this_value)
# ArrayBuffer and TypedArray functions
These APIs all depend on the es.next profile.
These APIs all depend on a build option (`JERRY_BUILTIN_TYPEDARRAY`) and can be checked
in runtime with the `JERRY_FEATURE_TYPEDARRAY` feature enum value,
see: [jerry_feature_enabled](#jerry_feature_enabled).
## jerry_arraybuffer_size