Eclipse Checkstyle Plug-in

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 log file. The file <workspace root>/.metadata/.log may contain additional diagnostic messages that can help determine the source of the problem.
2. Verify that the .checkstyle file in the project's root directory is writeable when editing the project's File Sets. Some version control systems don't know to make this file writeable and the plug-in may fail trying to write your updated settings to it.
3. Verify that the Check Configuration referred to in your File Set 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 (http://sourceforge.net/projects/eclipse-cs/). Please submit as much of the following information that will help in finding and correcting the bug as possible:

- Steps for recreating the problem
- The .checkstyle from the project experiencing the problem
- The <workspace root>/.metadata/.log file
- The <workspace root>/.metadata/.plugins/com.atlassw.tools.eclipse.checkstyle/checkstyle-config.xml file
- Specific Java source files experiencing the problem, if possible

Copyright © 2002-2004 David Schneider. All Rights Reserved.