Installation

Requirements

• Eclipse 3.7.1 Classic
• Eclipse 3.7.2 Classic If you use a different version of Eclipse Classic, but still want to use Quick Fix Scout, please create an enhancement request.

How to Install

• Make sure that you have downloaded (or using) an Eclipse Classic. To see your version of Eclipse: Help ⇒ About Eclipse SDK. You should see a dialog similar to the below screen shot (version might be different). Make sure that the first line says Eclipse SDK (not Eclipse for Java Developers, etc.).

Automated Installation

• Open Help ⇒ Install New Software...
• Click Add...
  • For Name, enter Quick Fix Scout
  • For Location, enter (for Eclipse 3.7.1 or 3.7.2):

http://files.kivancmuslu.com/QFS/3.7.1_Classic

• Click Ok
• Select Quick Fix Scout from the menu and install it as you would install any other plug-in.

Manual Installation

• Download the appropriate featured zip file for your version of Eclipse from the downloads list and extract it in the Eclipse/dropins/ folder.
• Optionally enable the QF Evaluator feature through the preference pages (Eclipse ⇒ Preferences on Mac and Window ⇒ Preferences on Windows). The other feature, QF Observer, is enabled by default. When you enable or disable a plug-in through preference pages and click 'apply', your preferences are saved in your Workspace and are remembered whenever you use the same Workspace again. If you change your Workspace, you need to activate the plug-ins again. A sample preference page is given below for QFS. If you cannot see the preference pages, then see the troubleshooting wiki page.

• Test the installation
• [Optional, but highly recommended] Configure your views with filters. Whenever you open a project, additional 'shadow' projects will be created automatically in your Workspace (one for each feature you are using). They start with prefix DO_NOT_DELETE. Please don’t close these projects. To avoid ever seeing these shadow projects, perform the following configuration once for each workspace.
  • Configure Open Type Dialog
  • Configure Navigator View
  • Configure Problems View
• [Optional, but highly recommended] Go over tutorial to learn Quick Fix Scout features.
• [Optional, but highly recommended] Go over troubleshooting guidelines to recognize common problems.

How to Test the Installation

QF Observer Feature

• Open Eclipse.
• In a file in the Eclipse editor, introduce a compilation error.
• For that compilation error, Eclipse will offer a quick fix, invoke it by mouse click or keyboard shortcut. Please note that at this moment, hovering mouse over the compilation error (which also invokes quick fix) is not logged.
• Select one of the proposals offered by Eclipse.
• Close Eclipse.
• In your ~home/ directory, there should be a new directory named Quick_Fix_Usage. Inside that directory, there should be at least 2 files, called qf_log_... and qf_usage_...
• If these files are empty, then see the troubleshooting wiki page.

QF Evaluator Feature

• Open Eclipse.
• Make sure that QF Scout feature is enabled ('enable Quick Fix Scout selected' in Quick Fix Scout preference page, see above).
• In a file in the Eclipse editor, introduce a compilation error.
• For that compilation error, Eclipse will offer a quick fix, invoke it by mouse click or keyboard shortcut. Please note that at this moment, hovering mouse over the compilation error (which also invokes quick fix) is not augmented.
• In the quick fix dialog, you should see the compilation-error prediction (a number in parentheses) on the left side of each proposal.
• If you don’t see the speculative information right away, maybe it is still being computed in the background. Please see how to understand whether the speculation is running or not. If the speculation is running, wait a few seconds.
• If you don’t see the augmented information, then see the troubleshooting wiki page.

Checking for Updates

The plug-in checks for a newer version every time you open Eclipse, if you are connected to the Internet. You will be notified if there is a newer version of an enabled feature (observer and/or evaluator).

For Manual Installation

If you have installed the plug-in manually (by unzipping jars into dropins/) follow these steps:

• Open Eclipse.
• Window ⇒ Preferences
• Select Quick Fix Scout or Quick Fix Observer
• Click Check For Updates button.
• You will be notified if there is a newer version of the related plug-in.

For Automated (through Update Site) Installation

If you have installed the plug-in through the update site, follow these steps:

• Open Eclipse.
• Help ⇒ Check for Updates
• You will be notified if there is any update available. If this is the case, just follow the normal installation steps as you would to install the update.