Bug 1543455 - Don't document JS::CompileUtf8FileDontInflate as invoking functionality with known bugs now that the last known bug's been fixed -- just suggest it's experimental. r=arai

Differential Revision: https://phabricator.services.mozilla.com/D26953

--HG--
extra : rebase_source : b7f3ef5598bd18955e95b0b3bd4c8cfdb82b1606
This commit is contained in:
Jeff Walden 2019-04-09 18:29:43 -07:00
parent 23ca9b8e0d
commit 3a9a35b609

View File

@ -193,9 +193,9 @@ extern JS_PUBLIC_API JSScript* CompileUtf8File(
* if the file contains invalid UTF-8. Return the script on success, or return
* null on failure (usually with an error reported).
*
* NOTE: This function DOES NOT INFLATE the UTF-8 bytes to UTF-16 before
* compiling them. UTF-8 compilation is currently experimental and has
* known bugs. Use only if you're willing to tolerate unspecified bugs!
* NOTE: UTF-8 compilation is currently experimental, and it's possible it has
* as-yet-undiscovered bugs not present in |JS::CompileUtf8File| that
* first inflates to UTF-16. Use only if you're willing to take a risk!
*/
extern JS_PUBLIC_API JSScript* CompileUtf8FileDontInflate(
JSContext* cx, const ReadOnlyCompileOptions& options, FILE* file);