diff --git a/_data/compiler-options.yml b/_data/compiler-options.yml index 429f31b0c7..7f97ccede2 100644 --- a/_data/compiler-options.yml +++ b/_data/compiler-options.yml @@ -79,11 +79,11 @@ arg: "level" default: "vars" choices: - - choice: "none" - - choice: "source" - - choice: "line" - - choice: "vars" - - choice: "notailcalls" + - choice: "none" + - choice: "source" + - choice: "line" + - choice: "vars" + - choice: "notailcalls" description: "Set level of generated debugging info. Choices: (none,source,line,vars,notailcalls), default: vars." - option: "-help" schema: @@ -107,20 +107,20 @@ arg: "feature" multiple: "true" choices: - - choice: "dynamics" - description: "Allow direct or indirect subclasses of scala.Dynamic" - - choice: "postfixOps" - description: "Allow postfix operator notation, such as `1 to 10 toList`" - - choice: "reflectiveCalls" - description: "Allow reflective access to members of structural types" - - choice: "implicitConversions" - description: "Allow definition of implicit functions called views" - - choice: "higherKinds" - description: "Allow higher-kinded types" - - choice: "existentials" - description: "Existential types (besides wildcard types) can be written and inferred" - - choice: "experimental.macros" - description: "Allow macro definition (besides implementation and application)" + - choice: "dynamics" + description: "Allow direct or indirect subclasses of scala.Dynamic" + - choice: "postfixOps" + description: "Allow postfix operator notation, such as `1 to 10 toList`" + - choice: "reflectiveCalls" + description: "Allow reflective access to members of structural types" + - choice: "implicitConversions" + description: "Allow definition of implicit functions called views" + - choice: "higherKinds" + description: "Allow higher-kinded types" + - choice: "existentials" + description: "Existential types (besides wildcard types) can be written and inferred" + - choice: "experimental.macros" + description: "Allow macro definition (besides implementation and application)" description: "Enable or disable language features: `_` for all, `-language:help` to list choices." - option: "-no-specialization" schema: @@ -140,36 +140,36 @@ arg: "optimization" multiple: "true" choices: - - choice: "unreachable-code" - description: "Eliminate unreachable code, exception handlers guarding no instructions, redundant metadata (debug information, line numbers)." - - choice: "simplify-jumps" - description: "Simplify branching instructions, eliminate unnecessary ones." - - choice: "compact-locals" - description: "Eliminate empty slots in the sequence of local variables." - - choice: "copy-propagation" - description: "Eliminate redundant local variables and unused values (including closures). Enables unreachable-code." - - choice: "redundant-casts" - description: "Eliminate redundant casts using a type propagation analysis." - - choice: "box-unbox" - description: "Eliminate box-unbox pairs within the same method (also tuples, xRefs, value class instances). Enables unreachable-code." - - choice: "nullness-tracking" - description: "Track nullness / non-nullness of local variables and apply optimizations." - - choice: "closure-invocations" - description: "Rewrite closure invocations to the implementation method." - - choice: "inline" - description: "Inline method invocations according to -Yopt-inline-heuristics and -opt-inline-from." - - choice: "l:none" - description: "Disable optimizations. Takes precedence: `-opt:l:none,+box-unbox` / `-opt:l:none -opt:box-unbox` don`t enable box-unbox." - - choice: "l:default" - description: "Enable default optimizations: unreachable-code." - - choice: "l:method" - description: "Enable intra-method optimizations: unreachable-code,simplify-jumps,compact-locals,copy-propagation,redundant-casts,box-unbox,nullness-tracking,closure-invocations." - - choice: "l:inline" - description: "Enable cross-method optimizations (note: inlining requires -opt-inline-from): l:method,inline." - - choice: "l:project" - description: "[deprecated, use -opt:l:inline, -opt-inline-from] Enable cross-method optimizations within the current project." - - choice: "l:classpath" - description: "[deprecated, use -opt:l:inline, -opt-inline-from] Enable cross-method optimizations across the entire classpath." + - choice: "unreachable-code" + description: "Eliminate unreachable code, exception handlers guarding no instructions, redundant metadata (debug information, line numbers)." + - choice: "simplify-jumps" + description: "Simplify branching instructions, eliminate unnecessary ones." + - choice: "compact-locals" + description: "Eliminate empty slots in the sequence of local variables." + - choice: "copy-propagation" + description: "Eliminate redundant local variables and unused values (including closures). Enables unreachable-code." + - choice: "redundant-casts" + description: "Eliminate redundant casts using a type propagation analysis." + - choice: "box-unbox" + description: "Eliminate box-unbox pairs within the same method (also tuples, xRefs, value class instances). Enables unreachable-code." + - choice: "nullness-tracking" + description: "Track nullness / non-nullness of local variables and apply optimizations." + - choice: "closure-invocations" + description: "Rewrite closure invocations to the implementation method." + - choice: "inline" + description: "Inline method invocations according to -Yopt-inline-heuristics and -opt-inline-from." + - choice: "l:none" + description: "Disable optimizations. Takes precedence: `-opt:l:none,+box-unbox` / `-opt:l:none -opt:box-unbox` don`t enable box-unbox." + - choice: "l:default" + description: "Enable default optimizations: unreachable-code." + - choice: "l:method" + description: "Enable intra-method optimizations: unreachable-code,simplify-jumps,compact-locals,copy-propagation,redundant-casts,box-unbox,nullness-tracking,closure-invocations." + - choice: "l:inline" + description: "Enable cross-method optimizations (note: inlining requires -opt-inline-from): l:method,inline." + - choice: "l:project" + description: "[deprecated, use -opt:l:inline, -opt-inline-from] Enable cross-method optimizations within the current project." + - choice: "l:classpath" + description: "[deprecated, use -opt:l:inline, -opt-inline-from] Enable cross-method optimizations across the entire classpath." description: "Enable optimizations: `_` for all, `-opt:help` to list choices." - option: "-opt-inline-from" schema: @@ -183,20 +183,20 @@ arg: "warning" multiple: "true" choices: - - choice: "none" - description: "No optimizer warnings." - - choice: "at-inline-failed-summary" - description: "One-line summary if there were @inline method calls that could not be inlined." - - choice: "at-inline-failed" - description: "A detailed warning for each @inline method call that could not be inlined." - - choice: "any-inline-failed" - description: "A detailed warning for every callsite that was chosen for inlining by the heuristics, but could not be inlined." - - choice: "no-inline-mixed" - description: "In mixed compilation, warn at callsites methods defined in java sources (the inlining decision cannot be made without bytecode)." - - choice: "no-inline-missing-bytecode" - description: "Warn if an inlining decision cannot be made because a the bytecode of a class or member cannot be found on the compilation classpath." - - choice: "no-inline-missing-attribute" - description: "Warn if an inlining decision cannot be made because a Scala classfile does not have a ScalaInlineInfo attribute." + - choice: "none" + description: "No optimizer warnings." + - choice: "at-inline-failed-summary" + description: "One-line summary if there were @inline method calls that could not be inlined." + - choice: "at-inline-failed" + description: "A detailed warning for each @inline method call that could not be inlined." + - choice: "any-inline-failed" + description: "A detailed warning for every callsite that was chosen for inlining by the heuristics, but could not be inlined." + - choice: "no-inline-mixed" + description: "In mixed compilation, warn at callsites methods defined in java sources (the inlining decision cannot be made without bytecode)." + - choice: "no-inline-missing-bytecode" + description: "Warn if an inlining decision cannot be made because a the bytecode of a class or member cannot be found on the compilation classpath." + - choice: "no-inline-missing-attribute" + description: "Warn if an inlining decision cannot be made because a Scala classfile does not have a ScalaInlineInfo attribute." description: "Enable optimizer warnings: `_` for all, `-opt-warnings:help` to list choices." - option: "-optimise" schema: @@ -226,10 +226,10 @@ arg: "target" default: "jvm-1.8" choices: - - choice: "jvm-1.5" - - choice: "jvm-1.6" - - choice: "jvm-1.7" - - choice: "jvm-1.8" + - choice: "jvm-1.5" + - choice: "jvm-1.6" + - choice: "jvm-1.7" + - choice: "jvm-1.8" description: "Target platform for object files. All JVM 1.5 - 1.7 targets are deprecated. Choices: (jvm-1.5,jvm-1.6,jvm-1.7,jvm-1.8), default: jvm-1.8." - option: "-toolcp" schema: @@ -313,42 +313,42 @@ arg: "warning" multiple: "true" choices: - - choice: "adapted-args" - description: "Warn if an argument list is modified to match the receiver." - - choice: "nullary-unit" - description: "Warn when nullary methods return Unit." - - choice: "inaccessible" - description: "Warn about inaccessible types in method signatures." - - choice: "nullary-override" - description: "Warn when non-nullary `def f()` overrides nullary `def f`." - - choice: "infer-any" - description: "Warn when a type argument is inferred to be `Any`." - - choice: "missing-interpolator" - description: "A string literal appears to be missing an interpolator id." - - choice: "doc-detached" - description: "A Scaladoc comment appears to be detached from its element." - - choice: "private-shadow" - description: "A private field (or class parameter) shadows a superclass field." - - choice: "type-parameter-shadow" - description: "A local type parameter shadows a type already in scope." - - choice: "poly-implicit-overload" - description: "Parameterized overloaded implicit methods are not visible as view bounds." - - choice: "option-implicit" - description: "Option.apply used implicit view." - - choice: "delayedinit-select" - description: "Selecting member of DelayedInit." - - choice: "by-name-right-associative" - description: "By-name parameter of right associative operator." - - choice: "package-object-classes" - description: "Class or object defined in package object." - - choice: "unsound-match" - description: "Pattern match may not be typesafe." - - choice: "stars-align" - description: "Pattern sequence wildcard must align with sequence component." - - choice: "constant" - description: "Evaluation of a constant arithmetic expression results in an error." - - choice: "unused" - description: "Enable -Ywarn-unused:imports,privates,locals,implicits." + - choice: "adapted-args" + description: "Warn if an argument list is modified to match the receiver." + - choice: "nullary-unit" + description: "Warn when nullary methods return Unit." + - choice: "inaccessible" + description: "Warn about inaccessible types in method signatures." + - choice: "nullary-override" + description: "Warn when non-nullary `def f()` overrides nullary `def f`." + - choice: "infer-any" + description: "Warn when a type argument is inferred to be `Any`." + - choice: "missing-interpolator" + description: "A string literal appears to be missing an interpolator id." + - choice: "doc-detached" + description: "A Scaladoc comment appears to be detached from its element." + - choice: "private-shadow" + description: "A private field (or class parameter) shadows a superclass field." + - choice: "type-parameter-shadow" + description: "A local type parameter shadows a type already in scope." + - choice: "poly-implicit-overload" + description: "Parameterized overloaded implicit methods are not visible as view bounds." + - choice: "option-implicit" + description: "Option.apply used implicit view." + - choice: "delayedinit-select" + description: "Selecting member of DelayedInit." + - choice: "by-name-right-associative" + description: "By-name parameter of right associative operator." + - choice: "package-object-classes" + description: "Class or object defined in package object." + - choice: "unsound-match" + description: "Pattern match may not be typesafe." + - choice: "stars-align" + description: "Pattern sequence wildcard must align with sequence component." + - choice: "constant" + description: "Evaluation of a constant arithmetic expression results in an error." + - choice: "unused" + description: "Enable -Ywarn-unused:imports,privates,locals,implicits." description: "Enable or disable specific warnings: `_` for all, `-Xlint:help` to list choices." - option: "-Xlog-free-terms" schema: @@ -411,12 +411,12 @@ arg: "mode" default: "true" choices: - - choice: "true" - description: "Always generate mixin forwarders." - - choice: "junit" - description: "Generate mixin forwarders for JUnit-annotated methods (JUnit 4 does not support default methods)." - - choice: "false" - description: "Only generate mixin forwarders required for program correctness." + - choice: "true" + description: "Always generate mixin forwarders." + - choice: "junit" + description: "Generate mixin forwarders for JUnit-annotated methods (JUnit 4 does not support default methods)." + - choice: "false" + description: "Only generate mixin forwarders required for program correctness." description: "Generate forwarder methods in classes inhering concrete methods from traits. Default: `true`, `help` to list choices." - option: "-Xno-forwarders" schema: @@ -429,7 +429,7 @@ - option: "-Xno-uescape" schema: type: "Boolean" - description: "Disable handling of \u unicode escapes." + description: "Disable handling of \\u unicode escapes." - option: "-Xnojline" schema: type: "Boolean" @@ -541,8 +541,8 @@ arg: "property" multiple: "true" choices: - - choice: "coalescing" - description: "Convert PCData to Text and coalesce sibling nodes" + - choice: "coalescing" + description: "Convert PCData to Text and coalesce sibling nodes" description: "Configure XML parsing.: `_` for all, `-Xxml:help` to list choices." - category: "Verbose Settings" description: @@ -579,10 +579,10 @@ arg: "policy" default: "none" choices: - - choice: "none" - description: "Don't cache class loader" - - choice: "last-modified" - description: "Cache class loader, using file last-modified time to invalidate" + - choice: "none" + description: "Don't cache class loader" + - choice: "last-modified" + description: "Cache class loader, using file last-modified time to invalidate" description: "Policy for caching class loaders for macros that are dynamically loaded. Default: `none`, `help` to list choices." - option: "-Ycache-plugin-class-loader" schema: @@ -590,10 +590,10 @@ arg: "policy" default: "none" choices: - - choice: "none" - description: "Don't cache class loader" - - choice: "last-modified" - description: "Cache class loader, using file last-modified time to invalidate" + - choice: "none" + description: "Don't cache class loader" + - choice: "last-modified" + description: "Cache class loader, using file last-modified time to invalidate" description: "Policy for caching class loaders for compiler plugins that are dynamically loaded. Default: `none`, `help` to list choices." - option: "-Ycheck" schema: @@ -614,8 +614,8 @@ arg: "strategy" default: "method" choices: - - choice: "inline" - - choice: "method" + - choice: "inline" + - choice: "method" description: "Strategy used for translating lambdas into JVM code. Choices: (inline,method), default: method." - option: "-YdisableFlatCpCaching" schema: @@ -683,9 +683,9 @@ arg: "policy" default: "normal" choices: - - choice: "normal" - - choice: "none" - - choice: "discard" + - choice: "normal" + - choice: "none" + - choice: "discard" description: "Control expansion of macros, useful for scaladoc and presentation compiler. Choices: (normal,none,discard), default: normal." - option: "-Ymacro-no-expand" schema: @@ -717,9 +717,9 @@ arg: "strategy" default: "default" choices: - - choice: "at-inline-annotated" - - choice: "everything" - - choice: "default" + - choice: "at-inline-annotated" + - choice: "everything" + - choice: "default" description: "Set the heuristics for inlining decisions. Choices: (at-inline-annotated,everything,default), default: default." - option: "-Yopt-log-inline" schema: @@ -812,7 +812,7 @@ type: "String" arg: "path" default: - description: "Write repl-generated classfiles to given output directory (use "" to generate a temporary dir)" + description: "Write repl-generated classfiles to given output directory (use \"\" to generate a temporary dir)" - option: "-Yrepl-sync" schema: type: "Boolean" @@ -823,9 +823,9 @@ arg: "strategy" default: "error" choices: - - choice: "package" - - choice: "object" - - choice: "error" + - choice: "package" + - choice: "object" + - choice: "error" description: "Resolve term conflicts. Choices: (package,object,error), default: error." - option: "-Yshow" schema: @@ -923,14 +923,14 @@ arg: "mode" default: "before" choices: - - choice: "none" - description: "Do not inspect expansions or their original trees when generating unused symbol warnings." - - choice: "before" - description: "Only inspect unexpanded user-written code for unused symbols." - - choice: "after" - description: "Only inspect expanded trees when generating unused symbol warnings." - - choice: "both" - description: "Inspect both user-written code and expanded trees when generating unused symbol warnings." + - choice: "none" + description: "Do not inspect expansions or their original trees when generating unused symbol warnings." + - choice: "before" + description: "Only inspect unexpanded user-written code for unused symbols." + - choice: "after" + description: "Only inspect expanded trees when generating unused symbol warnings." + - choice: "both" + description: "Inspect both user-written code and expanded trees when generating unused symbol warnings." description: "Enable lint warnings on macro expansions. Default: `before`, `help` to list choices." - option: "-Ywarn-nullary-override" schema: @@ -954,22 +954,22 @@ arg: "warning" multiple: "true" choices: - - choice: "imports" - description: "Warn if an import selector is not referenced." - - choice: "patvars" - description: "Warn if a variable bound in a pattern is unused." - - choice: "privates" - description: "Warn if a private member is unused." - - choice: "locals" - description: "Warn if a local definition is unused." - - choice: "explicits" - description: "Warn if an explicit parameter is unused." - - choice: "implicits" - description: "Warn if an implicit parameter is unused." - - choice: "params" - description: "Enable -Ywarn-unused:explicits,implicits." - - choice: "linted" - description: "-Xlint:unused." + - choice: "imports" + description: "Warn if an import selector is not referenced." + - choice: "patvars" + description: "Warn if a variable bound in a pattern is unused." + - choice: "privates" + description: "Warn if a private member is unused." + - choice: "locals" + description: "Warn if a local definition is unused." + - choice: "explicits" + description: "Warn if an explicit parameter is unused." + - choice: "implicits" + description: "Warn if an implicit parameter is unused." + - choice: "params" + description: "Enable -Ywarn-unused:explicits,implicits." + - choice: "linted" + description: "-Xlint:unused." description: "Enable or disable specific `unused` warnings: `_` for all, `-Ywarn-unused:help` to list choices." - option: "-Ywarn-unused-import" schema: @@ -988,42 +988,42 @@ arg: "warning" multiple: "true" choices: - - choice: "adapted-args" - description: "Warn if an argument list is modified to match the receiver." - - choice: "nullary-unit" - description: "Warn when nullary methods return Unit." - - choice: "inaccessible" - description: "Warn about inaccessible types in method signatures." - - choice: "nullary-override" - description: "Warn when non-nullary `def f()` overrides nullary `def f`." - - choice: "infer-any" - description: "Warn when a type argument is inferred to be `Any`." - - choice: "missing-interpolator" - description: "A string literal appears to be missing an interpolator id." - - choice: "doc-detached" - description: "A Scaladoc comment appears to be detached from its element." - - choice: "private-shadow" - description: "A private field (or class parameter) shadows a superclass field." - - choice: "type-parameter-shadow" - description: "A local type parameter shadows a type already in scope." - - choice: "poly-implicit-overload" - description: "Parameterized overloaded implicit methods are not visible as view bounds." - - choice: "option-implicit" - description: "Option.apply used implicit view." - - choice: "delayedinit-select" - description: "Selecting member of DelayedInit." - - choice: "by-name-right-associative" - description: "By-name parameter of right associative operator." - - choice: "package-object-classes" - description: "Class or object defined in package object." - - choice: "unsound-match" - description: "Pattern match may not be typesafe." - - choice: "stars-align" - description: "Pattern sequence wildcard must align with sequence component." - - choice: "constant" - description: "Evaluation of a constant arithmetic expression results in an error." - - choice: "unused" - description: "Enable -Ywarn-unused:imports,privates,locals,implicits." + - choice: "adapted-args" + description: "Warn if an argument list is modified to match the receiver." + - choice: "nullary-unit" + description: "Warn when nullary methods return Unit." + - choice: "inaccessible" + description: "Warn about inaccessible types in method signatures." + - choice: "nullary-override" + description: "Warn when non-nullary `def f()` overrides nullary `def f`." + - choice: "infer-any" + description: "Warn when a type argument is inferred to be `Any`." + - choice: "missing-interpolator" + description: "A string literal appears to be missing an interpolator id." + - choice: "doc-detached" + description: "A Scaladoc comment appears to be detached from its element." + - choice: "private-shadow" + description: "A private field (or class parameter) shadows a superclass field." + - choice: "type-parameter-shadow" + description: "A local type parameter shadows a type already in scope." + - choice: "poly-implicit-overload" + description: "Parameterized overloaded implicit methods are not visible as view bounds." + - choice: "option-implicit" + description: "Option.apply used implicit view." + - choice: "delayedinit-select" + description: "Selecting member of DelayedInit." + - choice: "by-name-right-associative" + description: "By-name parameter of right associative operator." + - choice: "package-object-classes" + description: "Class or object defined in package object." + - choice: "unsound-match" + description: "Pattern match may not be typesafe." + - choice: "stars-align" + description: "Pattern sequence wildcard must align with sequence component." + - choice: "constant" + description: "Evaluation of a constant arithmetic expression results in an error." + - choice: "unused" + description: "Enable -Ywarn-unused:imports,privates,locals,implicits." description: "Enable or disable specific warnings: `_` for all, `-Xlint:help` to list choices." - category: "IDE-specific Settings" description: