[MCOMPILER-563] Clarify that incremental compilation is not an IDE-style incremental compiler - #1123
Open
elharo wants to merge 2 commits into
Open
[MCOMPILER-563] Clarify that incremental compilation is not an IDE-style incremental compiler#1123elharo wants to merge 2 commits into
elharo wants to merge 2 commits into
Conversation
…yle incremental compiler Improve the Javadoc of the incrementalCompilation and the deprecated useIncrementalCompilation parameters. Despite the name, the plugin does not compile a single changed class together with its dependents like an IDE incremental compiler. It runs a change-detection algorithm that decides whether to recompile the whole module or only the modified source files.
Contributor
|
Before to change the documentation, it may be worth retesting if the issue described in #777 is still true. If I remember correctly, this parameter was intended to be incremental compilation in the IDE-style, but was not because of a bug (comparing relative paths against absolute paths). In version 4.x of the compiler plugin, this parameter does IDE-style incremental compilation, which was apparently the original intend. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Improves the documentation for the
incrementalCompilationparameter and the deprecateduseIncrementalCompilationparameter (issue #777, [MCOMPILER-563]).The name "incremental compilation" gives the misleading impression that the plugin compiles a single changed class together with its dependents, like an IDE incremental compiler. In reality the plugin only runs a change-detection algorithm that decides whether to recompile the whole module or only the modified source files.
This is a documentation-only change (Javadoc). No Java code behavior is modified. The updated Javadoc is what gets rendered into the plugin's published parameter documentation (plugin-info
.html).Closes #777