diff --git a/src/jdk.compiler/share/classes/module-info.java b/src/jdk.compiler/share/classes/module-info.java index b1b5b467e00..46104743182 100644 --- a/src/jdk.compiler/share/classes/module-info.java +++ b/src/jdk.compiler/share/classes/module-info.java @@ -23,6 +23,9 @@ * questions. */ +import javax.tools.JavaCompiler; +import javax.tools.StandardLocation; + /** * Defines the implementation of the * {@linkplain javax.tools.ToolProvider#getSystemJavaCompiler system Java compiler} @@ -59,6 +62,78 @@ * {@code jdk.zipfs} module, must be available if the compiler is to be able * to read JAR files. * + *
The {@code -J} option is not supported. + * Any necessary VM options must be set in the VM used to invoke the API. + * {@code IllegalArgumentException} will be thrown if the option + * is used when invoking the tool through the {@code JavaCompiler} API; + * an error will be reported if the option is used when invoking + * javac through the {@link java.util.spi.ToolProvider ToolProvider} + * or legacy {@link com.sun.tools.javac.Main Main} API. + * + *
The "classpath wildcard" feature is not supported. + * The feature is only supported by the native launcher. + * When invoking the tool through its API, all necessary jar + * files should be included directly in the {@code --class-path} + * option, or the {@code CLASSPATH} environment variable. + * When invoking the tool through its API, all components of the + * class path will be taken literally, and will be ignored if there + * is no matching directory or file. The {@code -Xlint:paths} + * option can be used to generate warnings about missing components. + * + *
Argument files (so-called @-files) are not supported. + * The content of any such files should be included directly + * in the list of options provided when invoking the tool + * though this API. + * {@code IllegalArgumentException} will be thrown if + * the option is used when invoking the tool through this API. + * + *
The environment variable {@code JDK_JAVAC_OPTIONS} is not supported. + * Any options defined in the environment variable should be included + * directly in the list of options provided when invoking the + * API; any values in the environment variable will be ignored. + * + *
Options that are just used to obtain information (such as + * {@code --help}, {@code --help-extended}, {@code --version} and + * {@code --full-version}) are not supported. + * {@link IllegalArgumentException} will be thrown if any of + * these options are used when invoking the tool through this API. + * + *