azalea/kotlin-fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[CLI] Update CLI argument descriptions after review

Browse Source
This commit is contained in:
Kirill Rakhman
2023-10-31 13:17:55 +01:00
committed by Space Team
parent bc8841c6fe
commit 4964ee12a9
25 changed files with 825 additions and 823 deletions
Download Patch File Download Diff File Expand all files Collapse all files
libraries/tools/kotlin-gradle-plugin-api/src/common/kotlin/org/jetbrains/kotlin/gradle/dsl/KotlinCommonCompilerOptions.kt
+5 -5
View File
@@ -8,7 +8,7 @@ package org.jetbrains.kotlin.gradle.dsl
interface KotlinCommonCompilerOptions : org.jetbrains.kotlin.gradle.dsl.KotlinCommonCompilerToolOptions {
/**
* Allow using declarations only from the specified version of bundled libraries
* Allow using declarations from only the specified version of bundled libraries.
* Possible values: "1.4 (deprecated)", "1.5 (deprecated)", "1.6 (deprecated)", "1.7", "1.8", "1.9", "2.0", "2.1 (experimental)"
* Default value: null
*/
@@ -17,7 +17,7 @@ interface KotlinCommonCompilerOptions : org.jetbrains.kotlin.gradle.dsl.KotlinCo
val apiVersion: org.gradle.api.provider.Property<org.jetbrains.kotlin.gradle.dsl.KotlinVersion>
/**
* Provide source compatibility with the specified version of Kotlin
* Provide source compatibility with the specified version of Kotlin.
* Possible values: "1.4 (deprecated)", "1.5 (deprecated)", "1.6 (deprecated)", "1.7", "1.8", "1.9", "2.0", "2.1 (experimental)"
* Default value: null
*/
@@ -26,21 +26,21 @@ interface KotlinCommonCompilerOptions : org.jetbrains.kotlin.gradle.dsl.KotlinCo
val languageVersion: org.gradle.api.provider.Property<org.jetbrains.kotlin.gradle.dsl.KotlinVersion>
/**
* Enable usages of API that requires opt-in with an opt-in requirement marker with the given fully qualified name
* Enable API usages that require opt-in with an opt-in requirement marker with the given fully qualified name.
* Default value: emptyList<String>()
*/
@get:org.gradle.api.tasks.Input
val optIn: org.gradle.api.provider.ListProperty<kotlin.String>
/**
* Enable progressive compiler mode. In this mode, deprecations and bug fixes for unstable code take effect immediately, instead of going through a graceful migration cycle. Code written in the progressive mode is backward compatible; however, code written in non-progressive mode may cause compilation errors in the progressive mode.
* Enable progressive compiler mode. In this mode, deprecations and bug fixes for unstable code take effect immediately instead of going through a graceful migration cycle. Code written in progressive mode is backward compatible; however, code written without progressive mode enabled may cause compilation errors in progressive mode.
* Default value: false
*/
@get:org.gradle.api.tasks.Input
val progressiveMode: org.gradle.api.provider.Property<kotlin.Boolean>
/**
* Compile using experimental K2. K2 is a new compiler pipeline, no compatibility guarantees are yet provided
* Compile using the experimental K2 compiler pipeline. No compatibility guarantees are provided yet.
* Default value: false
*/
@Deprecated(message = "Compiler flag -Xuse-k2 is deprecated; please use language version 2.0 instead", level = DeprecationLevel.WARNING)
libraries/tools/kotlin-gradle-plugin-api/src/common/kotlin/org/jetbrains/kotlin/gradle/dsl/KotlinCommonCompilerToolOptions.kt
+3 -3
View File
@@ -8,21 +8,21 @@ package org.jetbrains.kotlin.gradle.dsl
interface KotlinCommonCompilerToolOptions {
/**
* Report an error if there are any warnings
* Report an error if there are any warnings.
* Default value: false
*/
@get:org.gradle.api.tasks.Input
val allWarningsAsErrors: org.gradle.api.provider.Property<kotlin.Boolean>
/**
* Generate no warnings
* Don't generate any warnings.
* Default value: false
*/
@get:org.gradle.api.tasks.Internal
val suppressWarnings: org.gradle.api.provider.Property<kotlin.Boolean>
/**
* Enable verbose logging output
* Enable verbose logging output.
* Default value: false
*/
@get:org.gradle.api.tasks.Internal
libraries/tools/kotlin-gradle-plugin-api/src/common/kotlin/org/jetbrains/kotlin/gradle/dsl/KotlinCommonOptions.kt
+3 -3
View File
@@ -13,7 +13,7 @@ interface KotlinCommonOptions : org.jetbrains.kotlin.gradle.dsl.KotlinCommonTool
private val org.jetbrains.kotlin.gradle.dsl.KotlinVersion?.apiVersionKotlinOption get() = this?.version
/**
* Allow using declarations only from the specified version of bundled libraries
* Allow using declarations from only the specified version of bundled libraries.
* Possible values: "1.4 (deprecated)", "1.5 (deprecated)", "1.6 (deprecated)", "1.7", "1.8", "1.9", "2.0", "2.1 (experimental)"
* Default value: null
*/
@@ -26,7 +26,7 @@ interface KotlinCommonOptions : org.jetbrains.kotlin.gradle.dsl.KotlinCommonTool
private val org.jetbrains.kotlin.gradle.dsl.KotlinVersion?.languageVersionKotlinOption get() = this?.version
/**
* Provide source compatibility with the specified version of Kotlin
* Provide source compatibility with the specified version of Kotlin.
* Possible values: "1.4 (deprecated)", "1.5 (deprecated)", "1.6 (deprecated)", "1.7", "1.8", "1.9", "2.0", "2.1 (experimental)"
* Default value: null
*/
@@ -35,7 +35,7 @@ interface KotlinCommonOptions : org.jetbrains.kotlin.gradle.dsl.KotlinCommonTool
set(value) = options.languageVersion.set(value.languageVersionCompilerOption)
/**
* Compile using experimental K2. K2 is a new compiler pipeline, no compatibility guarantees are yet provided
* Compile using the experimental K2 compiler pipeline. No compatibility guarantees are provided yet.
* Default value: false
*/
@Deprecated(message = "Compiler flag -Xuse-k2 is deprecated; please use language version 2.0 instead", level = DeprecationLevel.WARNING)
libraries/tools/kotlin-gradle-plugin-api/src/common/kotlin/org/jetbrains/kotlin/gradle/dsl/KotlinCommonToolOptions.kt
+3 -3
View File
@@ -9,7 +9,7 @@ interface KotlinCommonToolOptions {
val options: org.jetbrains.kotlin.gradle.dsl.KotlinCommonCompilerToolOptions
/**
* Report an error if there are any warnings
* Report an error if there are any warnings.
* Default value: false
*/
var allWarningsAsErrors: kotlin.Boolean
@@ -17,7 +17,7 @@ interface KotlinCommonToolOptions {
set(value) = options.allWarningsAsErrors.set(value)
/**
* Generate no warnings
* Don't generate any warnings.
* Default value: false
*/
var suppressWarnings: kotlin.Boolean
@@ -25,7 +25,7 @@ interface KotlinCommonToolOptions {
set(value) = options.suppressWarnings.set(value)
/**
* Enable verbose logging output
* Enable verbose logging output.
* Default value: false
*/
var verbose: kotlin.Boolean
libraries/tools/kotlin-gradle-plugin-api/src/common/kotlin/org/jetbrains/kotlin/gradle/dsl/KotlinJsCompilerOptions.kt
+14 -14
View File
@@ -8,14 +8,14 @@ package org.jetbrains.kotlin.gradle.dsl
interface KotlinJsCompilerOptions : org.jetbrains.kotlin.gradle.dsl.KotlinCommonCompilerOptions {
/**
* Disable internal declaration export
* Disable internal declaration export.
* Default value: false
*/
@get:org.gradle.api.tasks.Input
val friendModulesDisabled: org.gradle.api.provider.Property<kotlin.Boolean>
/**
* Define whether the `main` function should be called upon execution
* Specify whether the 'main' function should be called upon execution.
* Possible values: "call", "noCall"
* Default value: JsMainFunctionExecutionMode.CALL
*/
@@ -23,14 +23,14 @@ interface KotlinJsCompilerOptions : org.jetbrains.kotlin.gradle.dsl.KotlinCommon
val main: org.gradle.api.provider.Property<org.jetbrains.kotlin.gradle.dsl.JsMainFunctionExecutionMode>
/**
* Generate .meta.js and .kjsm files with metadata. Use to create a library
* Generate .meta.js and .kjsm files with metadata. Use this to create a library.
* Default value: true
*/
@get:org.gradle.api.tasks.Input
val metaInfo: org.gradle.api.provider.Property<kotlin.Boolean>
/**
* Kind of the JS module generated by the compiler
* The kind of JS module generated by the compiler.
* Possible values: "plain", "amd", "commonjs", "umd"
* Default value: JsModuleKind.MODULE_PLAIN
*/
@@ -38,7 +38,7 @@ interface KotlinJsCompilerOptions : org.jetbrains.kotlin.gradle.dsl.KotlinCommon
val moduleKind: org.gradle.api.provider.Property<org.jetbrains.kotlin.gradle.dsl.JsModuleKind>
/**
* Base name of generated files
* Base name of generated files.
* Default value: null
*/
@get:org.gradle.api.tasks.Optional
@@ -46,14 +46,14 @@ interface KotlinJsCompilerOptions : org.jetbrains.kotlin.gradle.dsl.KotlinCommon
val moduleName: org.gradle.api.provider.Property<kotlin.String>
/**
* Don't automatically include the default Kotlin/JS stdlib into compilation dependencies
* Don't automatically include the default Kotlin/JS stdlib in compilation dependencies.
* Default value: true
*/
@get:org.gradle.api.tasks.Input
val noStdlib: org.gradle.api.provider.Property<kotlin.Boolean>
/**
* Destination *.js file for the compilation result
* Destination *.js file for the compilation result.
* Default value: null
*/
@Deprecated(message = "Only for legacy backend. For IR backend please use task.destinationDirectory and moduleName", level = DeprecationLevel.WARNING)
@@ -61,14 +61,14 @@ interface KotlinJsCompilerOptions : org.jetbrains.kotlin.gradle.dsl.KotlinCommon
val outputFile: org.gradle.api.provider.Property<kotlin.String>
/**
* Generate source map
* Generate a source map.
* Default value: false
*/
@get:org.gradle.api.tasks.Input
val sourceMap: org.gradle.api.provider.Property<kotlin.Boolean>
/**
* Embed source files into source map
* Embed source files into the source map.
* Possible values: "never", "always", "inlining"
* Default value: null
*/
@@ -77,7 +77,7 @@ interface KotlinJsCompilerOptions : org.jetbrains.kotlin.gradle.dsl.KotlinCommon
val sourceMapEmbedSources: org.gradle.api.provider.Property<org.jetbrains.kotlin.gradle.dsl.JsSourceMapEmbedMode>
/**
* How to map generated names to original names (IR backend only)
* Mode for mapping generated names to original names (IR backend only).
* Possible values: "no", "simple-names", "fully-qualified-names"
* Default value: null
*/
@@ -86,7 +86,7 @@ interface KotlinJsCompilerOptions : org.jetbrains.kotlin.gradle.dsl.KotlinCommon
val sourceMapNamesPolicy: org.gradle.api.provider.Property<org.jetbrains.kotlin.gradle.dsl.JsSourceMapNamesPolicy>
/**
* Add the specified prefix to paths in the source map
* Add the specified prefix to the paths in the source map.
* Default value: null
*/
@get:org.gradle.api.tasks.Optional
@@ -94,7 +94,7 @@ interface KotlinJsCompilerOptions : org.jetbrains.kotlin.gradle.dsl.KotlinCommon
val sourceMapPrefix: org.gradle.api.provider.Property<kotlin.String>
/**
* Generate JS files for specific ECMA version
* Generate JS files for the specified ECMA version.
* Possible values: "v5"
* Default value: "v5"
*/
@@ -102,14 +102,14 @@ interface KotlinJsCompilerOptions : org.jetbrains.kotlin.gradle.dsl.KotlinCommon
val target: org.gradle.api.provider.Property<kotlin.String>
/**
* Translate primitive arrays to JS typed arrays
* Translate primitive arrays into JS typed arrays.
* Default value: true
*/
@get:org.gradle.api.tasks.Input
val typedArrays: org.gradle.api.provider.Property<kotlin.Boolean>
/**
* Generated JavaScript will use ES2015 classes.
* Let generated JavaScript code use ES2015 classes.
* Default value: false
*/
@get:org.gradle.api.tasks.Input
libraries/tools/kotlin-gradle-plugin-api/src/common/kotlin/org/jetbrains/kotlin/gradle/dsl/KotlinJsDceCompilerToolOptions.kt
+2 -2
View File
@@ -8,14 +8,14 @@ package org.jetbrains.kotlin.gradle.dsl
interface KotlinJsDceCompilerToolOptions : org.jetbrains.kotlin.gradle.dsl.KotlinCommonCompilerToolOptions {
/**
* Development mode: don't strip out any code, just copy dependencies
* Development mode: don't strip out any code, just copy dependencies.
* Default value: false
*/
@get:org.gradle.api.tasks.Input
val devMode: org.gradle.api.provider.Property<kotlin.Boolean>
/**
* Output directory
* Output directory.
* Default value: null
*/
@Deprecated(message = "Use task 'destinationDirectory' to configure output directory", level = DeprecationLevel.WARNING)
libraries/tools/kotlin-gradle-plugin-api/src/common/kotlin/org/jetbrains/kotlin/gradle/dsl/KotlinJsDceOptions.kt
+2 -2
View File
@@ -9,7 +9,7 @@ interface KotlinJsDceOptions : org.jetbrains.kotlin.gradle.dsl.KotlinCommonToolO
override val options: org.jetbrains.kotlin.gradle.dsl.KotlinJsDceCompilerToolOptions
/**
* Development mode: don't strip out any code, just copy dependencies
* Development mode: don't strip out any code, just copy dependencies.
* Default value: false
*/
var devMode: kotlin.Boolean
@@ -17,7 +17,7 @@ interface KotlinJsDceOptions : org.jetbrains.kotlin.gradle.dsl.KotlinCommonToolO
set(value) = options.devMode.set(value)
/**
* Output directory
* Output directory.
* Default value: null
*/
@Deprecated(message = "Use task 'destinationDirectory' to configure output directory", level = DeprecationLevel.WARNING)
libraries/tools/kotlin-gradle-plugin-api/src/common/kotlin/org/jetbrains/kotlin/gradle/dsl/KotlinJsOptions.kt
+14 -14
View File
@@ -9,7 +9,7 @@ interface KotlinJsOptions : org.jetbrains.kotlin.gradle.dsl.KotlinCommonOptions
override val options: org.jetbrains.kotlin.gradle.dsl.KotlinJsCompilerOptions
/**
* Disable internal declaration export
* Disable internal declaration export.
* Default value: false
*/
var friendModulesDisabled: kotlin.Boolean
@@ -21,7 +21,7 @@ interface KotlinJsOptions : org.jetbrains.kotlin.gradle.dsl.KotlinCommonOptions
private val org.jetbrains.kotlin.gradle.dsl.JsMainFunctionExecutionMode.mainKotlinOption get() = this.mode
/**
* Define whether the `main` function should be called upon execution
* Specify whether the 'main' function should be called upon execution.
* Possible values: "call", "noCall"
* Default value: JsMainFunctionExecutionMode.CALL
*/
@@ -30,7 +30,7 @@ interface KotlinJsOptions : org.jetbrains.kotlin.gradle.dsl.KotlinCommonOptions
set(value) = options.main.set(value.mainCompilerOption)
/**
* Generate .meta.js and .kjsm files with metadata. Use to create a library
* Generate .meta.js and .kjsm files with metadata. Use this to create a library.
* Default value: true
*/
var metaInfo: kotlin.Boolean
@@ -42,7 +42,7 @@ interface KotlinJsOptions : org.jetbrains.kotlin.gradle.dsl.KotlinCommonOptions
private val org.jetbrains.kotlin.gradle.dsl.JsModuleKind.moduleKindKotlinOption get() = this.kind
/**
* Kind of the JS module generated by the compiler
* The kind of JS module generated by the compiler.
* Possible values: "plain", "amd", "commonjs", "umd"
* Default value: JsModuleKind.MODULE_PLAIN
*/
@@ -51,7 +51,7 @@ interface KotlinJsOptions : org.jetbrains.kotlin.gradle.dsl.KotlinCommonOptions
set(value) = options.moduleKind.set(value.moduleKindCompilerOption)
/**
* Base name of generated files
* Base name of generated files.
* Default value: null
*/
var moduleName: kotlin.String?
@@ -59,7 +59,7 @@ interface KotlinJsOptions : org.jetbrains.kotlin.gradle.dsl.KotlinCommonOptions
set(value) = options.moduleName.set(value)
/**
* Don't automatically include the default Kotlin/JS stdlib into compilation dependencies
* Don't automatically include the default Kotlin/JS stdlib in compilation dependencies.
* Default value: true
*/
var noStdlib: kotlin.Boolean
@@ -67,7 +67,7 @@ interface KotlinJsOptions : org.jetbrains.kotlin.gradle.dsl.KotlinCommonOptions
set(value) = options.noStdlib.set(value)
/**
* Destination *.js file for the compilation result
* Destination *.js file for the compilation result.
* Default value: null
*/
@Deprecated(message = "Only for legacy backend. For IR backend please use task.destinationDirectory and moduleName", level = DeprecationLevel.WARNING)
@@ -76,7 +76,7 @@ interface KotlinJsOptions : org.jetbrains.kotlin.gradle.dsl.KotlinCommonOptions
set(value) = options.outputFile.set(value)
/**
* Generate source map
* Generate a source map.
* Default value: false
*/
var sourceMap: kotlin.Boolean
@@ -88,7 +88,7 @@ interface KotlinJsOptions : org.jetbrains.kotlin.gradle.dsl.KotlinCommonOptions
private val org.jetbrains.kotlin.gradle.dsl.JsSourceMapEmbedMode?.sourceMapEmbedSourcesKotlinOption get() = this?.mode
/**
* Embed source files into source map
* Embed source files into the source map.
* Possible values: "never", "always", "inlining"
* Default value: null
*/
@@ -101,7 +101,7 @@ interface KotlinJsOptions : org.jetbrains.kotlin.gradle.dsl.KotlinCommonOptions
private val org.jetbrains.kotlin.gradle.dsl.JsSourceMapNamesPolicy?.sourceMapNamesPolicyKotlinOption get() = this?.policy
/**
* How to map generated names to original names (IR backend only)
* Mode for mapping generated names to original names (IR backend only).
* Possible values: "no", "simple-names", "fully-qualified-names"
* Default value: null
*/
@@ -110,7 +110,7 @@ interface KotlinJsOptions : org.jetbrains.kotlin.gradle.dsl.KotlinCommonOptions
set(value) = options.sourceMapNamesPolicy.set(value.sourceMapNamesPolicyCompilerOption)
/**
* Add the specified prefix to paths in the source map
* Add the specified prefix to the paths in the source map.
* Default value: null
*/
var sourceMapPrefix: kotlin.String?
@@ -118,7 +118,7 @@ interface KotlinJsOptions : org.jetbrains.kotlin.gradle.dsl.KotlinCommonOptions
set(value) = options.sourceMapPrefix.set(value)
/**
* Generate JS files for specific ECMA version
* Generate JS files for the specified ECMA version.
* Possible values: "v5"
* Default value: "v5"
*/
@@ -127,7 +127,7 @@ interface KotlinJsOptions : org.jetbrains.kotlin.gradle.dsl.KotlinCommonOptions
set(value) = options.target.set(value)
/**
* Translate primitive arrays to JS typed arrays
* Translate primitive arrays into JS typed arrays.
* Default value: true
*/
var typedArrays: kotlin.Boolean
@@ -135,7 +135,7 @@ interface KotlinJsOptions : org.jetbrains.kotlin.gradle.dsl.KotlinCommonOptions
set(value) = options.typedArrays.set(value)
/**
* Generated JavaScript will use ES2015 classes.
* Let generated JavaScript code use ES2015 classes.
* Default value: false
*/
var useEsClasses: kotlin.Boolean
libraries/tools/kotlin-gradle-plugin-api/src/common/kotlin/org/jetbrains/kotlin/gradle/dsl/KotlinJvmCompilerOptions.kt
+4 -4
View File
@@ -8,14 +8,14 @@ package org.jetbrains.kotlin.gradle.dsl
interface KotlinJvmCompilerOptions : org.jetbrains.kotlin.gradle.dsl.KotlinCommonCompilerOptions {
/**
* Generate metadata for Java 1.8 reflection on method parameters
* Generate metadata for Java 1.8 reflection on method parameters.
* Default value: false
*/
@get:org.gradle.api.tasks.Input
val javaParameters: org.gradle.api.provider.Property<kotlin.Boolean>
/**
* Target version of the generated JVM bytecode (1.8, 9, 10, ..., 21), default is 1.8
* The target version of the generated JVM bytecode (1.8, 9, 10, ..., 21), with 1.8 as the default.
* Possible values: "1.8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21"
* Default value: JvmTarget.DEFAULT
*/
@@ -23,7 +23,7 @@ interface KotlinJvmCompilerOptions : org.jetbrains.kotlin.gradle.dsl.KotlinCommo
val jvmTarget: org.gradle.api.provider.Property<org.jetbrains.kotlin.gradle.dsl.JvmTarget>
/**
* Name of the generated .kotlin_module file
* Name of the generated '.kotlin_module' file.
* Default value: null
*/
@get:org.gradle.api.tasks.Optional
@@ -31,7 +31,7 @@ interface KotlinJvmCompilerOptions : org.jetbrains.kotlin.gradle.dsl.KotlinCommo
val moduleName: org.gradle.api.provider.Property<kotlin.String>
/**
* Don't automatically include the Java runtime into the classpath
* Don't automatically include the Java runtime in the classpath.
* Default value: false
*/
@get:org.gradle.api.tasks.Input
libraries/tools/kotlin-gradle-plugin-api/src/common/kotlin/org/jetbrains/kotlin/gradle/dsl/KotlinJvmOptions.kt
+4 -4
View File
@@ -9,7 +9,7 @@ interface KotlinJvmOptions : org.jetbrains.kotlin.gradle.dsl.KotlinCommonOptions
override val options: org.jetbrains.kotlin.gradle.dsl.KotlinJvmCompilerOptions
/**
* Generate metadata for Java 1.8 reflection on method parameters
* Generate metadata for Java 1.8 reflection on method parameters.
* Default value: false
*/
var javaParameters: kotlin.Boolean
@@ -21,7 +21,7 @@ interface KotlinJvmOptions : org.jetbrains.kotlin.gradle.dsl.KotlinCommonOptions
private val org.jetbrains.kotlin.gradle.dsl.JvmTarget.jvmTargetKotlinOption get() = this.target
/**
* Target version of the generated JVM bytecode (1.8, 9, 10, ..., 21), default is 1.8
* The target version of the generated JVM bytecode (1.8, 9, 10, ..., 21), with 1.8 as the default.
* Possible values: "1.8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21"
* Default value: JvmTarget.DEFAULT
*/
@@ -30,7 +30,7 @@ interface KotlinJvmOptions : org.jetbrains.kotlin.gradle.dsl.KotlinCommonOptions
set(value) = options.jvmTarget.set(value.jvmTargetCompilerOption)
/**
* Name of the generated .kotlin_module file
* Name of the generated '.kotlin_module' file.
* Default value: null
*/
var moduleName: kotlin.String?
@@ -38,7 +38,7 @@ interface KotlinJvmOptions : org.jetbrains.kotlin.gradle.dsl.KotlinCommonOptions
set(value) = options.moduleName.set(value)
/**
* Don't automatically include the Java runtime into the classpath
* Don't automatically include the Java runtime in the classpath.
* Default value: false
*/
var noJdk: kotlin.Boolean
libraries/tools/kotlin-gradle-plugin-api/src/common/kotlin/org/jetbrains/kotlin/gradle/dsl/KotlinNativeCompilerOptions.kt
+1 -1
View File
@@ -8,7 +8,7 @@ package org.jetbrains.kotlin.gradle.dsl
interface KotlinNativeCompilerOptions : org.jetbrains.kotlin.gradle.dsl.KotlinCommonCompilerOptions {
/**
* Specify a name for the compilation module
* Specify a name for the compilation module.
* Default value: null
*/
@get:org.gradle.api.tasks.Optional