eclipse-cs Banner SourceForge.net Logo Support This Project

-- Troubleshooting --

A lot of effort has gone into testing the Checkstyle plug-in, but like all software things can and do go wrong. The following are some tips that may help in troubleshooting when things go wrong and some guidelines on reporting bugs to help get them fixed.

  1. Check the Eclipse Error Log view. All exceptions happening in Eclipse should be logged there. Identify the log entry which you mean belongs to your problem with the Checkstyle plug-in. The exception message and the stack trace might give you an additional clue what went wrong.

  2. Verify that the .checkstyle file in the project's root directory is writable when editing the project's settings. Some version control systems don't know to make this file writable and the plug-in may fail trying to write your updated settings to it.

  3. Verify that the Check Configuration referred to in your project configuration exists in your workspace. Because the .checkstyle file is often shared through a team repository its possible for the file to be updated by one team member and propagated to another team member when he synchronizes with the repository. The Check Configuration name in the File Set must match one of the Check Configurations defined in your workspace.

-- Reporting Bugs --

Bugs do happen. If you think you have found a bug with the Checkstyle plug-in please report it on the SourceForge Eclipse Checkstyle Plug-in project site. Please submit as much of the following information that will help in finding and correcting the bug as possible:

  • The plug-in version number, Eclipse version, JDK/JRE version you are running eclipse with, which operation system
  • Steps for recreating the problem
  • The .checkstyle from the project experiencing the problem
  • The Checkstyle configuration file in question
  • The stack trace from the corresponding error in the Eclipse error log view
  • Specific Java source files experiencing the problem, if possible