[Commented] (MCOMPILER-428) Documentation regarding useIncrementalCompilation not very useful

Previous Topic Next Topic
classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view

[Commented] (MCOMPILER-428) Documentation regarding useIncrementalCompilation not very useful

Jack Leech (Jira)

    [ https://issues.apache.org/jira/browse/MCOMPILER-428?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17196126#comment-17196126 ]

Michael Boyles commented on MCOMPILER-428:

I suspect your description may be inaccurate. As per the comments on that ticket by Robert:
"if 1 file has been changed or removed, all files are deleted and recompiled"

As per your description: "any source file was **added**, removed or changed".

I don't know whether this optimization actually exists, but it seems plausible: If the only change is purely adding a class or classes, and no other existing classes changed, we can infer that the whole module does not need recompiling.

Suppose we add a new Spring @Component. It would be sufficient to just compile this new class, and Spring's DI will pick it up at runtime. Recompiling everything else when we know they haven't changed would be a waste of time.

> Documentation regarding useIncrementalCompilation not very useful
> -----------------------------------------------------------------
>                 Key: MCOMPILER-428
>                 URL: https://issues.apache.org/jira/browse/MCOMPILER-428
>             Project: Maven Compiler Plugin
>          Issue Type: Improvement
>            Reporter: Thomas Bracher
>            Priority: Minor
>              Labels: documentation
> As of today, maven-compiler-plugin documentation for useIncrementalCompilation says: "to enable/disable incrementation compilation feature". Since there is no documentation of said feature, users will have to either:
> 1) take a guess at how the feature behaves
> 2) painfully read the plugin code to understand what it does
> This is less than optimal and lead to misunderstanding, like this comment https://issues.apache.org/jira/browse/MCOMPILER-205?focusedCommentId=14428972&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-14428972 
> So far the most explicit documentation I have found is in answer of a stackoverflow issue: https://stackoverflow.com/a/49700942
> I think it would benefit a lot of users to understand the implication of both options of this flag. I am trying to submit a PR providing an example of text.

This message was sent by Atlassian Jira