Miscellaneous Information
Resources
The following resources are recommended for background reading on peer code reviews:
- Book, Peer Reviews in Software: A Practical Guide by Karl Weigers.
- Software Engineering Institute web page: Software Inspections
- NASA Software Assurance Technology Center we page: Software Formal Inspections
Current Limitations
All artifacts to be reviewed must be checked in to a source code management system supported by FishEye.
Troubleshooting
Most setup issues are likely to be related to the FishEye component of Crucible. There are several resources that can help you:
- FishEye Documentation
- FishEye Technical Forums or Crucible Forums
- FishEye Support fisheye-support@cenqua.com
The most common cause of FishEye issues is an incorrect symbolic setup (trunk/branch/tag) for Subversion repositories. If you are using Subversion and your initial index is taking forever, double check that your symbolic setup matches your repository.
FishEye runs with the default Java heap of 64 megabytes. This is sometimes problematic for FishEye especially for Subversion repositories during the initial scan. You can give FishEye's JVM more memory by setting the FISHEYE_OPTS environment variable.
Starting Crucible with the command line options --debug --debug-perf will print a lot of information to Crucible's logs. This can give you an insight into what is happening and possibly where you are stuck. Send these logs along with your config.xml to FishEye support to expedite your support.
Backups and Review Data
Currently all review data is stored in an embedded relational database found at CRUCIBLE_HOME/var/data/. It can be safely copied whilst Crucible is running. In addition to backing up crudb before upgrading, you should make it part of your backup regime. For more details view the FishEye Backup guide.
Review data will be automatically upgraded on startup of a newer version. Therefore it is imperative that you backup your data before upgrading. The review database can be upgraded, but not downgraded. In the unlikely event that a serious bug is introduced, you will need a backup to roll back to the previous version.