Improve documentation of the -O flag

sigmundch · commit-bot@chromium.org · commit e402732eff11 · 2018-08-02T18:48:21.000Z
TBR=sra@google.com,vsm@google.com Change-Id: Ib42647ab59313bdfa49df73c25282d0d734d6462 Reviewed-on: https://dart-review.googlesource.com/68140 Reviewed-by: Sigmund Cherem <sigmund@google.com> Commit-Queue: Sigmund Cherem <sigmund@google.com>
diff --git a/pkg/compiler/lib/src/dart2js.dart b/pkg/compiler/lib/src/dart2js.dart
@@ -706,7 +706,9 @@ Supported options:
 
     -O3
        Enables optimizations that respect the language semantics only on
-       programs that don't ever throw any subtype of `Error`. To use this
+       programs that don't ever throw any subtype of `Error`.  These
+       optimizations improve the generated code, but they may cause programs to
+       behave unexpectedly if this assumption is not met.  To use this
        option, we recommend that you properly test your application first
        without it, and ensure that no subtype of `Error` (such as `TypeError`)
        is ever thrown.
@@ -725,10 +727,12 @@ Supported options:
          -O3
          --trust-primitives
 
-    In the future, new safe optimizations may be added on any level, and
-    optimizations that only work on some programs may move up from one level to
-    the next (for instance, we may move `omit-implicit-checks` to the O3 level
-    in the future).
+    While some of the individual optimizations and flags may change with time,
+    we intend to keep the -O* flags stable. New safe optimizations may be added
+    on any level, and optimizations that only work on some programs may move up
+    from one level to the next (for instance, once alternative safe
+    optimizations are implemented, `omit-implicit-checks` may be removed of may
+    move to the O4 level).
 
 The following individual options are included in some of the -O optimization
 levels above. They help reduce the size of the generated code, but they may
