Skip to content

Commit 061a754

Browse files
authored
Deprecate the debug flag (apache#953)
1 parent 90f58dc commit 061a754

File tree

1 file changed

+15
-8
lines changed

1 file changed

+15
-8
lines changed

src/main/java/org/apache/maven/plugin/compiler/AbstractCompilerMojo.java

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -432,21 +432,28 @@ final Charset charset() {
432432
*
433433
* @see #debuglevel
434434
* @see <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-g">javac -g</a>
435+
*
436+
* @deprecated Setting this flag to {@code false} is replaced by {@code <debuglevel>none</debuglevel>}.
435437
*/
438+
@Deprecated(since = "4.0.0")
436439
@Parameter(property = "maven.compiler.debug", defaultValue = "true")
437440
protected boolean debug = true;
438441

439442
/**
440-
* Keyword list to be appended to the {@code -g} command-line switch.
441-
* Legal values are a comma-separated list of the following keywords:
442-
* {@code lines}, {@code vars}, {@code source} and {@code all}.
443-
* If debug level is not specified, then the {@code -g} option will <em>not</em> by added,
443+
* Kinds of debugging information to include in the compiled class files.
444+
* Legal values are {@code lines}, {@code vars}, {@code source}, {@code all} and {@code none}.
445+
* Values other than {@code all} and {@code none} can be combined in a comma-separated list.
446+
*
447+
* <p>If debug level is not specified, then the {@code -g} option will <em>not</em> be added,
444448
* which means that the default debugging information will be generated
445-
* (typically {@code lines} and {@code source} but not {@code vars}).
446-
* If {@link #debug} is turned off, this attribute will be ignored.
449+
* (typically {@code lines} and {@code source} but not {@code vars}).</p>
450+
*
451+
* <p>If debug level is {@code all}, then only the {@code -g} option is added,
452+
* which means that all debugging information will be generated.
453+
* If debug level is anything else, then the comma-separated list of keywords
454+
* is appended to the {@code -g} command-line switch.</p>
447455
*
448-
* @see #debug
449-
* @see <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-g-custom">javac -G:[lines,vars,source]</a>
456+
* @see <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-g-custom">javac -g:[lines,vars,source]</a>
450457
* @since 2.1
451458
*/
452459
@Parameter(property = "maven.compiler.debuglevel")

0 commit comments

Comments
 (0)