Bug 307820 - Add readme entry about APT option to disable processing in the editor
Summary: Add readme entry about APT option to disable processing in the editor
Status: VERIFIED FIXED
Alias: None
Product: JDT
Classification: Eclipse Project
Component: APT (show other bugs)
Version: 3.6   Edit
Hardware: All All
: P3 normal (vote)
Target Milestone: 3.6 M7   Edit
Assignee: Walter Harley CLA
QA Contact:
URL:
Whiteboard:
Keywords: readme
Depends on:
Blocks:
 
Reported: 2010-04-01 03:10 EDT by Dani Megert CLA
Modified: 2010-04-28 13:02 EDT (History)
1 user (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Dani Megert CLA 2010-04-01 03:10:07 EDT
I20100326-0800.

While investigating a big performance issue for a customer we found out that the main issue was the APT reconciling done while working in the Java editor.

Disabling
    Java Compiler > Annotation Processing > [ ] Enable processing in editor
fixed their issues.

I think we want to keep that option enabled by default but we should add a readme entry that explains this setting, including the impact if it is disabled (copy blurb from F1 Help).
Comment 1 Dani Megert CLA 2010-04-01 03:18:26 EDT
>I20100326-0800.
Wrong build id. Should be I20100330-0800.
Comment 2 Walter Harley CLA 2010-04-06 01:38:23 EDT
I can do this if we want.  I'm always a little leery of "if you have bad performance try this" sort of comments, though, because I think they create superstitions.  Do we know anything about what annotation processors, if any, they were using?
Comment 3 Dani Megert CLA 2010-04-06 03:27:18 EDT
>I'm always a little leery of "if you have bad
>performance try this" sort of comments, though, because I think they create
>superstitions. 
Well, that already took place at the time we added the preference ;-)

The point is that changing that setting made the IDE usable again but they had no clue that this preference existed. Another place to add this hint could be the Tips and Tricks, but there it seemed to prominent to me.
Comment 4 Walter Harley CLA 2010-04-06 11:24:24 EDT
The 3.5.x readme contains the following entry, under JDT:

"Java 6 Annotation Processing
Java 6 annotation processors are supported in the batch compiler and in the IDE, with some limitations. Java 6 processors are only executed during a build, not while editing (bug 188558). Some methods in the processing API are unimplemented when compiling within the IDE, and will throw UnsupportedOperationException."

I propose we modify this to:

"Java Annotation Processing
Java 6 annotation processors are supported in the batch compiler and in the IDE. By design, Java 6 processors are only executed during a build, not while editing (bug 188558).

Java 5 annotation processors are supported in the IDE only.  Java 5 processors can be executed while editing, as well as during a build.  Slow annotation processors can cause a slowdown of the editing experience; if this occurs, you may wish to turn off the 'Enable processing in editor' option on the Annotation Processing preference dialog."

It would also be nice to add a dialog like that used for cleanup actions, that senses slow processors and asks the user whether to disable the option.  I'll enter a separate bug for that.
Comment 5 Dani Megert CLA 2010-04-07 09:28:29 EDT
The proposed change looks good.
Fixed in HEAD, R3_5_maintenance and in 3.5, 3.5.1 and 3.5.2 readme.

>It would also be nice to add a dialog like that used for cleanup actions, that
>senses slow processors and asks the user whether to disable the option.  I'll
>enter a separate bug for that.
See bug 308226.
Comment 6 Olivier Thomann CLA 2010-04-28 13:02:44 EDT
Verified for 3.6M7.