PERFORCE DEFECT TRACKING INTEGRATION README FOR RELEASE 1.5.3

Richard Brooksby, Ravenbrook Limited

$Date: 2002/12/13 $


CONTENTS

  1. Introduction
  2. Installation
    2.1. Upgrading from an old release of the P4DTI
    2.2. Installing the TeamTrack integration
    2.3. Installing the Bugzilla integration on Linux
    2.4. Installing the Bugzilla integration on Solaris
    2.5. Installing the Bugzilla integration on Windows 2000
    2.6. Installing the Integration Kit
  A. References
  B. Document history
  C. Copyright and licence

1. INTRODUCTION

This is release 1.5.3 of the Perforce Defect Tracking Integration
(P4DTI).

The P4DTI connects your defect tracking system to Perforce, so that you
don't have to switch between them and enter duplicate information about
your work.  It also links changes made in Perforce with defect tracker
issues, making it easy to find out why a change was made, find the work
that was done to resolve an issue, or generate reports relating issues
to files or codelines.

For supported configurations, contact information, and what's new in
this release, see the release notes (release-notes.txt).

If you are planning to modify, adapt, or extend the P4DTI, please
download and unpack the P4DTI Integration Kit.  See section 2.5.

The readership of this document is anyone who wants to download and use
the Perforce Defect Tracking Integration.

This document is not confidential.


2. INSTALLATION


2.1. Upgrading from an old release of the P4DTI

If you're running an old release of the P4DTI, then you must follow
these steps when upgrading to this release:

  1. Stop the replicator.

  2. Make a copy of your configuration file config.py in a safe place.

  3. (Bugzilla only.)  Remove the old Bugzilla patch.  Go to the Bugzilla
installation directory and run the command:

     patch -R < /opt/p4dti/bugzilla-VERSION-patch

where VERSION is the version of Bugzilla (2.10, 2.12, 2.14, 2.14.1,
2.14.4, or 2.16.1).  (If you didn't install the Bugzilla integration
as an RPM, then the patch file will be wherever you installed it, not
necessarily in /opt/p4dti.)

  4. If your old release was installed as an RPM, run the following
command as root to uninstall it:

     rpm -e p4dti

  5. Install the P4DTI as normal (see sections 2.2 to 2.4 below).

  6. Copy your old configuration file as config.py in the new P4DTI
installation directory.


2.2. Installing the TeamTrack integration

On the TeamTrack server machine, run the "p4dti-teamtrack-1.5.3.exe"
installer program that came with this document.  This will unpack the
integration.  We recommend installing the integration in "C:\Program
Files\P4DTI-1.5.3\" but you can ask the installer to put it somewhere
else.

Then consult the Administrator's Guide (installed by default in
"C:\Program Files\P4DTI-1.5.3\ag\index.html") for further instructions.


2.3. Installing the Bugzilla integration on Linux

The integration is distributed as an RPM called
"p4dti-1.5.3-1.i386.rpm".  Transfer this to the Bugzilla server machine,
then run the following command as root:

  rpm -i p4dti-1.5.3-1.i386.rpm

This will install the P4DTI files into /opt/p4dti and a startup script
in the /etc/rc.d/init.d directory.

Then consult the Administrator's Guide (installed as
"/usr/doc/p4dti-1.5.3/ag/index.html") for further instructions.

If you prefer not to use RPMs, you can follow the procedure in section
2.4.


2.4. Installing the Bugzilla integration on Solaris

The integration is distributed as a gzipped tar file called
"p4dti-bugzilla-1.5.3.tar.gz".  Unpack this tarball on the Bugzilla
server machine, using the command

  gunzip -c p4dti-bugzilla-1.5.3.tar.gz | tar xvf -

Then consult the Administrator's Guide (installed as
"p4dti-bugzilla-1.5.3/ag/index.html") for further instructions.


2.5. Installing the Bugzilla integration on Windows 2000 or Windows NT

On the Bugzilla Windows machine, run the "p4dti-bugzilla-1.5.3.exe"
installer program that came with this document.  This will unpack the
integration.  We recommend installing the integration in "C:\Program
Files\P4DTI-1.5.3\" but you can ask the installer to put it somewhere
else.

Then consult the Administrator's Guide (installed by default in
"C:\Program Files\P4DTI-1.5.3\ag\index.html") for further instructions.


2.6. Installing the integration kit

The P4DTI integration kit is a complete set of P4DTI sources and
documentation to enable third parties to develop new integrations.
You should only install it if you are planning to modify, adapt, or
extend the P4DTI.

For Windows, the integration kit is distributed as the ZIP archive
"p4dti-kit-1.5.3.zip".  Unpack it using WinZip.

For Unix, the integration kit is distributed as the tarball
"p4dti-kit-1.5.3.tar.gz".  Unpack it using the command "gunzip -c
p4dti-kit-1.5.3.tar.gz | tar xvf -".

Then consult the Integration Kit readme file
(p4dti-kit-1.5.3/kit-readme.txt) for further instructions.


A. REFERENCES

None.


B. DOCUMENT HISTORY

2002-02-04 GDR Updated for release 1.4.0.

2002-04-09 NB Updated for release 1.4.1.

2002-04-19 NB Updated for release 1.4.2.

2002-06-04 GT Updated for Bugzilla on Windows 2000 port for release 1.4.2.

2002-06-26 RB Merging Bugzilla on Windows 2000 port into Ravenbrook sources.

2002-10-04 NB Add recent releases of Bugzilla.

2002-10-31 NB Updated for release 1.5.0.

2002-11-20 NB Updated for release 1.5.1.

2002-12-11 NB Fix name of P4DTI Bugzilla-on-Windows self-extracting archive.

2002-12-11 NB Updated for release 1.5.2.

2002-12-13 NB Updated for release 1.5.3.

C. COPYRIGHT AND LICENCE

This document is copyright (C) 2001 Perforce Software, Inc.  All rights
reserved.

Redistribution and use of this document in any form, with or without
modification, is permitted provided that redistributions of this
document retain the above copyright notice, this condition and the
following disclaimer.

THIS DOCUMENT IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
HOLDERS AND CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
DOCUMENT, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

$Id: //info.ravenbrook.com/project/p4dti/release/1.5.3/readme.txt#1 $