[MCOMPILER-479] Clarify `compilerArgs` Javadoc

• Type: Improvement
• Status: Closed
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: 3.8.1
• Fix Version/s: 3.10.0
• Assignee: Olivier Lamy
• Reporter: Halil İbrahim Şener
• Created: 04/Jan/22 10:52
• Updated: 07/Feb/22 02:03
• Resolved: 05/Feb/22 23:50

Description

The Javadoc for compilerArgs states

Sets the arguments to be passed to the compiler if fork is set to true.

However, by looking at the code, it seems the arguments are passed unconditionally (whether fork is enabled or not).

Our understanding is that the JVM flags (e.g., -J-Duser.language=en_us) are only applicable when fork is enabled. However, compiler arguments (e.g. -Xlint:all) are always passed through.

As cushon suggests here, maybe we should improve the doc, and/or report a warning/error.

Perhaps that could be at least clarified in the docs, or maven could report an error if -J is set without fork enabled, or something.

See also the discussion in google/error-prone#2786.

Issue Links

• links to: GitHub Pull Request #90