Skip to content

Commit c5bc378

Browse files
authored
Remove abandoned es5.1 profile from API reference (jerryscript-project#4972)
JerryScript-DCO-1.0-Signed-off-by: Yonggang Luo [email protected]
1 parent 4924f9f commit c5bc378

File tree

4 files changed

+18
-12
lines changed

4 files changed

+18
-12
lines changed

docs/00.GETTING-STARTED.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -51,10 +51,10 @@ tools/build.py --debug --logging=on --error-messages=on --line-info=on
5151
python tools/build.py --cmake-param=CMAKE_PARAM
5252
```
5353

54-
**Set a profile mode (ES.next, ES5.1, minimal)**
54+
**Set a profile mode (es.next, minimal)**
5555

5656
```bash
57-
python tools/build.py --profile=es.next|es5.1|minimal
57+
python tools/build.py --profile=es.next|minimal
5858
```
5959

6060
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
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ that can be used by the debugger to identify the currently executed source conte
4444
### Profiles
4545

4646
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.
47-
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.
47+
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.
4848
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).
4949

5050
| Options | |

docs/02.API-REFERENCE.md

+14-8
Original file line numberDiff line numberDiff line change
@@ -5702,7 +5702,7 @@ main (void)
57025702

57035703
# Functions for promise objects
57045704

5705-
These APIs all depend on the es.next profile (or on some build options).
5705+
These APIs are always enabled.
57065706

57075707
## jerry_promise_result
57085708

@@ -6124,7 +6124,7 @@ jerry_promise_reject (jerry_value_t promise, jerry_value_t argument);
61246124

61256125
# Functions for symbols
61266126

6127-
These APIs all depend on the es.next profile (or on build options).
6127+
These APIs are always enabled.
61286128

61296129
## jerry_symbol
61306130

@@ -6988,7 +6988,9 @@ jerry_error_sz (jerry_error_t error_type, const char *message_p);
69886988
Create new JavaScript DataView object.
69896989

69906990
*Note*:
6991-
- This API depends on the es.next profile.
6991+
- This API depends on a build option (`JERRY_BUILTIN_DATAVIEW`) and can be checked
6992+
in runtime with the `JERRY_FEATURE_DATAVIEW` feature enum value,
6993+
see: [jerry_feature_enabled](#jerry_feature_enabled).
69926994
- Returned value must be freed with [jerry_value_free](#jerry_value_free)
69936995
when it is no longer needed.
69946996

@@ -7307,7 +7309,6 @@ Create an empty promise object which can be resolved or rejected later
73077309
by calling jerry_promise_resolve or jerry_promise_reject.
73087310

73097311
*Note*:
7310-
- This API depends on the es.next profile.
73117312
- Returned value must be freed with [jerry_value_free](#jerry_value_free)
73127313
when it is no longer needed.
73137314

@@ -7348,7 +7349,9 @@ jerry_promise (void)
73487349
Create a new Proxy object with the given target and handler.
73497350

73507351
*Note*:
7351-
- This API depends on the es.next profile.
7352+
- This API depends on a build option (`JERRY_BUILTIN_PROXY`) and can be checked
7353+
in runtime with the `JERRY_FEATURE_PROXY` feature enum value,
7354+
see: [jerry_feature_enabled](#jerry_feature_enabled).
73527355
- Returned value must be freed with [jerry_value_free](#jerry_value_free)
73537356
when it is no longer needed.
73547357

@@ -7408,7 +7411,9 @@ Create a new Proxy object with the given target and handler.
74087411
The behaviour of the Proxy can be specialized with an options argument.
74097412

74107413
*Note*:
7411-
- This API depends on the es.next profile.
7414+
- This API depends on a build option (`JERRY_BUILTIN_PROXY`) and can be checked
7415+
in runtime with the `JERRY_FEATURE_PROXY` feature enum value,
7416+
see: [jerry_feature_enabled](#jerry_feature_enabled).
74127417
- Returned value must be freed with [jerry_value_free](#jerry_value_free)
74137418
when it is no longer needed.
74147419

@@ -7654,7 +7659,6 @@ Create symbol from an API value.
76547659

76557660
*Note*:
76567661
- The given argument is converted to string. This operation can throw an exception.
7657-
- This API depends on the es.next profile.
76587662
- Returned value must be freed with [jerry_value_free](#jerry_value_free)
76597663
when it is no longer needed.
76607664

@@ -11895,7 +11899,9 @@ jerry_realm_set_this (jerry_value_t realm_value, jerry_value_t this_value)
1189511899

1189611900
# ArrayBuffer and TypedArray functions
1189711901

11898-
These APIs all depend on the es.next profile.
11902+
These APIs all depend on a build option (`JERRY_BUILTIN_TYPEDARRAY`) and can be checked
11903+
in runtime with the `JERRY_FEATURE_TYPEDARRAY` feature enum value,
11904+
see: [jerry_feature_enabled](#jerry_feature_enabled).
1189911905

1190011906
## jerry_arraybuffer_size
1190111907

jerry-core/ecma/base/ecma-literal-storage.c

+1-1
Original file line numberDiff line numberDiff line change
@@ -700,7 +700,7 @@ ecma_snapshot_get_literal (const uint8_t *literal_base_p, /**< literal start */
700700
* Compute the start of the serializable ecma-values of the bytecode
701701
* Related values:
702702
* - function argument names, if CBC_CODE_FLAGS_MAPPED_ARGUMENTS_NEEDED is present
703-
* - function name, if CBC_CODE_FLAGS_CLASS_CONSTRUCTOR is not present and ES.next profile is enabled
703+
* - function name, if CBC_CODE_FLAGS_CLASS_CONSTRUCTOR is not present and es.next profile is enabled
704704
*
705705
* @return pointer to the beginning of the serializable ecma-values
706706
*/

0 commit comments

Comments
 (0)