Scmbug manual

RELEASE_0-10-1

The Scmbug Team

This is the documentation of Scmbug, a system that integrates software configuration management with bug-tracking.


Table of Contents
1. About
1.1. Copyright Information
1.2. Disclaimer
1.3. Acknowledgments
1.4. Document Conventions
2. Introduction
2.1. What Is It?
2.2. Why Use an SCM System?
2.3. Why Use a Bug-tracking System?
2.4. Why Integrate SCM with Bug-tracking?
3. Design
3.1. Goals
3.2. System Architecture
3.3. Related Systems
3.3.1. Bugzilla Email Gateway
3.3.2. CVSZilla
3.3.3. Other Integration Systems
4. Features
4.1. Integration Actions
4.2. Verification Checks
4.2.1. Glue Checks
4.2.2. Server Checks
4.3. Integration of SCM Log Messages
4.4. Integration of SCM Labeling Operations
5. SCM Frontends
5.1. CVS
5.2. Subversion
5.3. Other SCM Systems
6. Bug-tracking Backends
6.1. Bugzilla
6.2. Mantis
6.3. Request Tracker
6.4. Other Bug-tracking Systems
7. Integration Tools
7.1. Glue Installer
7.1.1. CVS
7.1.2. Subversion
7.2. Version Description Document Generator
8. Resources
8.1. Availability
8.2. Installation
8.2.1. System
8.2.2. Documentation
8.2.3. Integration Tools
8.2.4. Integration Daemon
8.3. Upgrading
8.3.1. Issues
8.3.2. Steps
A. FAQ
B. GNU Free Documentation License
0. Preamble
1. Applicability and Definition
2. Verbatim Copying
3. Copying in Quantity
4. Modifications
5. Combining Documents
6. Collections of Documents
7. Aggregation with Independent Works
8. Translation
9. Termination
10. Future Revisions of this License
How to use this License for your documents
Glossary
List of Figures
3-1. System architecture.
4-1. Glue enabling variable.
4-2. Paths to the SCM tool's binaries.
4-3. Regular expressions describing the bug id, the split of bug ids and the log message.
4-4. Example log message accepted.
4-5. Minimum log message size policy.
4-6. Label naming convention policy.
4-7. Presence of bug ids policy.
4-8. SCM to bug-tracking username mapping.
4-9. Product name variable.
4-10. Multiple product names.
4-11. Valid bug owner policy.
4-12. Mail on success policy.
5-1. A complex filename accepted by the CVS glue.
6-1. Bug-tracker installation directory.
6-2. Bug-tracker installed locally variable.
6-3. Database vendor variable.
6-4. Bug-tracker installation directory.
7-1. Glue Installation in a Subversion repository under UNIX.
7-2. Glue Installation in a Subversion repository under Windows.
7-3. Defining the Subversion labeling directories.
7-4. Generating a Version Description Document.
8-1. Installation of the system from source.
8-2. Integration daemon start.
8-3. Mail::Sendmail, XML::Simple installation.
8-4. DBI installation.
8-5. DBD::mysql installation.