From f248e4a2eee2585e555259a5adeafd3b6409b491 Mon Sep 17 00:00:00 2001 From: Alexander Udalov Date: Fri, 25 Oct 2019 13:49:39 +0200 Subject: [PATCH] Update CLI test data and Gradle option descriptions --- compiler/testData/cli/js/jsHelp.out | 28 +++++++++---------- compiler/testData/cli/jvm/help.out | 20 ++++++------- .../kotlin/gradle/dsl/KotlinCommonOptions.kt | 4 +-- .../kotlin/gradle/dsl/KotlinJsOptions.kt | 10 +++---- .../kotlin/gradle/dsl/KotlinJvmOptions.kt | 10 +++---- 5 files changed, 36 insertions(+), 36 deletions(-) diff --git a/compiler/testData/cli/js/jsHelp.out b/compiler/testData/cli/js/jsHelp.out index 91226cda95d..6d771b7b39a 100644 --- a/compiler/testData/cli/js/jsHelp.out +++ b/compiler/testData/cli/js/jsHelp.out @@ -1,26 +1,26 @@ Usage: kotlinc-js where possible options include: -libraries Paths to Kotlin libraries with .meta.js and .kjsm files, separated by system path separator - -main {call,noCall} Whether a main function should be called + -main {call|noCall} Define whether the `main` function should be called upon execution -meta-info Generate .meta.js and .kjsm files with metadata. Use to create a library - -module-kind { plain, amd, commonjs, umd } - Kind of a module generated by compiler - -no-stdlib Don't use bundled Kotlin stdlib - -output Output file path - -output-postfix Path to file which will be added to the end of output file - -output-prefix Path to file which will be added to the beginning of output file + -module-kind {plain|amd|commonjs|umd} + Kind of the JS module generated by the compiler + -no-stdlib Don't automatically include the default Kotlin/JS stdlib into compilation dependencies + -output Destination *.js file for the compilation result + -output-postfix Add the content of the specified file to the end of output file + -output-prefix Add the content of the specified file to the beginning of output file -source-map Generate source map - -source-map-base-dirs Base directories which are used to calculate relative paths to source files in source map - -source-map-embed-sources { always, never, inlining } + -source-map-base-dirs Base directories for calculating relative paths to source files in source map + -source-map-embed-sources {always|never|inlining} Embed source files into source map - -source-map-prefix Prefix for paths in a source map + -source-map-prefix Add the specified prefix to paths in the source map -target { v5 } Generate JS files for specific ECMA version -Werror Report an error if there are any warnings - -api-version Allow to use declarations only from the specified version of bundled libraries + -api-version Allow using declarations only from the specified version of bundled libraries -X Print a synopsis of advanced options -help (-h) Print a synopsis of standard options - -kotlin-home Path to Kotlin compiler home directory, used for runtime libraries discovery - -language-version Provide source compatibility with specified language version + -kotlin-home Path to the home directory of Kotlin compiler used for discovery of runtime libraries + -language-version Provide source compatibility with the specified version of Kotlin -P plugin::= Pass an option to a plugin -progressive Enable progressive compiler mode. @@ -28,7 +28,7 @@ where possible options include: 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. - -script Evaluate the script file + -script Evaluate the given Kotlin script (*.kts) file -nowarn Generate no warnings -verbose Enable verbose logging output -version Display compiler version diff --git a/compiler/testData/cli/jvm/help.out b/compiler/testData/cli/jvm/help.out index 91618862347..60eec99d92a 100644 --- a/compiler/testData/cli/jvm/help.out +++ b/compiler/testData/cli/jvm/help.out @@ -1,23 +1,23 @@ Usage: kotlinc-jvm where possible options include: - -classpath (-cp) Paths where to find user class files + -classpath (-cp) List of directories and JAR/ZIP archives to search for user class files -d Destination for generated class files - -include-runtime Include Kotlin runtime into the resulting .jar + -include-runtime Include Kotlin runtime into the resulting JAR -java-parameters Generate metadata for Java 1.8 reflection on method parameters - -jdk-home Path to JDK home directory to include into classpath, if differs from default JAVA_HOME + -jdk-home Include a custom JDK from the specified location into the classpath instead of the default JAVA_HOME -jvm-target Target version of the generated JVM bytecode (1.6, 1.8, 9, 10, 11 or 12), default is 1.6 -module-name Name of the generated .kotlin_module file - -no-jdk Don't include Java runtime into classpath - -no-reflect Don't include kotlin-reflect.jar into classpath - -no-stdlib Don't include kotlin-stdlib.jar or kotlin-reflect.jar into classpath + -no-jdk Don't automatically include the Java runtime into the classpath + -no-reflect Don't automatically include Kotlin reflection into the classpath + -no-stdlib Don't automatically include the Kotlin/JVM stdlib and Kotlin reflection into the classpath -script-templates Script definition template classes -Werror Report an error if there are any warnings - -api-version Allow to use declarations only from the specified version of bundled libraries + -api-version Allow using declarations only from the specified version of bundled libraries -X Print a synopsis of advanced options -help (-h) Print a synopsis of standard options - -kotlin-home Path to Kotlin compiler home directory, used for runtime libraries discovery - -language-version Provide source compatibility with specified language version + -kotlin-home Path to the home directory of Kotlin compiler used for discovery of runtime libraries + -language-version Provide source compatibility with the specified version of Kotlin -P plugin::= Pass an option to a plugin -progressive Enable progressive compiler mode. @@ -25,7 +25,7 @@ where possible options include: 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. - -script Evaluate the script file + -script Evaluate the given Kotlin script (*.kts) file -nowarn Generate no warnings -verbose Enable verbose logging output -version Display compiler version diff --git a/libraries/tools/kotlin-gradle-plugin-api/src/main/kotlin/org/jetbrains/kotlin/gradle/dsl/KotlinCommonOptions.kt b/libraries/tools/kotlin-gradle-plugin-api/src/main/kotlin/org/jetbrains/kotlin/gradle/dsl/KotlinCommonOptions.kt index a50efa6e3ed..b3e3c02a4c6 100644 --- a/libraries/tools/kotlin-gradle-plugin-api/src/main/kotlin/org/jetbrains/kotlin/gradle/dsl/KotlinCommonOptions.kt +++ b/libraries/tools/kotlin-gradle-plugin-api/src/main/kotlin/org/jetbrains/kotlin/gradle/dsl/KotlinCommonOptions.kt @@ -5,14 +5,14 @@ package org.jetbrains.kotlin.gradle.dsl interface KotlinCommonOptions : org.jetbrains.kotlin.gradle.dsl.KotlinCommonToolOptions { /** - * Allow to use declarations only from the specified version of bundled libraries + * Allow using declarations only from the specified version of bundled libraries * Possible values: "1.0", "1.1", "1.2", "1.3", "1.4 (EXPERIMENTAL)" * Default value: null */ var apiVersion: kotlin.String? /** - * Provide source compatibility with specified language version + * Provide source compatibility with the specified version of Kotlin * Possible values: "1.0", "1.1", "1.2", "1.3", "1.4 (EXPERIMENTAL)" * Default value: null */ diff --git a/libraries/tools/kotlin-gradle-plugin/src/main/kotlin/org/jetbrains/kotlin/gradle/dsl/KotlinJsOptions.kt b/libraries/tools/kotlin-gradle-plugin/src/main/kotlin/org/jetbrains/kotlin/gradle/dsl/KotlinJsOptions.kt index 7a937606991..6d5238012d5 100644 --- a/libraries/tools/kotlin-gradle-plugin/src/main/kotlin/org/jetbrains/kotlin/gradle/dsl/KotlinJsOptions.kt +++ b/libraries/tools/kotlin-gradle-plugin/src/main/kotlin/org/jetbrains/kotlin/gradle/dsl/KotlinJsOptions.kt @@ -11,7 +11,7 @@ interface KotlinJsOptions : org.jetbrains.kotlin.gradle.dsl.KotlinCommonOptions var friendModulesDisabled: kotlin.Boolean /** - * Whether a main function should be called + * Define whether the `main` function should be called upon execution * Possible values: "call", "noCall" * Default value: "call" */ @@ -24,20 +24,20 @@ interface KotlinJsOptions : org.jetbrains.kotlin.gradle.dsl.KotlinCommonOptions var metaInfo: kotlin.Boolean /** - * Kind of a module generated by compiler + * Kind of the JS module generated by the compiler * Possible values: "plain", "amd", "commonjs", "umd" * Default value: "plain" */ var moduleKind: kotlin.String /** - * Don't use bundled Kotlin stdlib + * Don't automatically include the default Kotlin/JS stdlib into compilation dependencies * Default value: true */ var noStdlib: kotlin.Boolean /** - * Output file path + * Destination *.js file for the compilation result * Default value: null */ var outputFile: kotlin.String? @@ -56,7 +56,7 @@ interface KotlinJsOptions : org.jetbrains.kotlin.gradle.dsl.KotlinCommonOptions var sourceMapEmbedSources: kotlin.String? /** - * Prefix for paths in a source map + * Add the specified prefix to paths in the source map * Default value: null */ var sourceMapPrefix: kotlin.String? diff --git a/libraries/tools/kotlin-gradle-plugin/src/main/kotlin/org/jetbrains/kotlin/gradle/dsl/KotlinJvmOptions.kt b/libraries/tools/kotlin-gradle-plugin/src/main/kotlin/org/jetbrains/kotlin/gradle/dsl/KotlinJvmOptions.kt index 47fb4d1c07d..997b05b7fe2 100644 --- a/libraries/tools/kotlin-gradle-plugin/src/main/kotlin/org/jetbrains/kotlin/gradle/dsl/KotlinJvmOptions.kt +++ b/libraries/tools/kotlin-gradle-plugin/src/main/kotlin/org/jetbrains/kotlin/gradle/dsl/KotlinJvmOptions.kt @@ -5,7 +5,7 @@ package org.jetbrains.kotlin.gradle.dsl interface KotlinJvmOptions : org.jetbrains.kotlin.gradle.dsl.KotlinCommonOptions { /** - * Include Kotlin runtime into the resulting .jar + * Include Kotlin runtime into the resulting JAR * Default value: false */ var includeRuntime: kotlin.Boolean @@ -17,7 +17,7 @@ interface KotlinJvmOptions : org.jetbrains.kotlin.gradle.dsl.KotlinCommonOption var javaParameters: kotlin.Boolean /** - * Path to JDK home directory to include into classpath, if differs from default JAVA_HOME + * Include a custom JDK from the specified location into the classpath instead of the default JAVA_HOME * Default value: null */ var jdkHome: kotlin.String? @@ -30,19 +30,19 @@ interface KotlinJvmOptions : org.jetbrains.kotlin.gradle.dsl.KotlinCommonOption var jvmTarget: kotlin.String /** - * Don't include Java runtime into classpath + * Don't automatically include the Java runtime into the classpath * Default value: false */ var noJdk: kotlin.Boolean /** - * Don't include kotlin-reflect.jar into classpath + * Don't automatically include Kotlin reflection into the classpath * Default value: true */ var noReflect: kotlin.Boolean /** - * Don't include kotlin-stdlib.jar or kotlin-reflect.jar into classpath + * Don't automatically include the Kotlin/JVM stdlib and Kotlin reflection into the classpath * Default value: true */ var noStdlib: kotlin.Boolean