Perforce Defect Tracking Integration Project

# Perforce Defect Tracking Integration User's Guide

## Contents

- 1. Introduction
- 2. Overview of the software
  - 2.1. A typical workflow using the P4DTI
  - 2.2. How the P4DTI enforces the defect tracker's rules
  - 2.3. Other restrictions on using the P4DTI
- 3. Creating an issue
- 4. Finding issues assigned to you
  - 4.1. In the Perforce Windows GUI
  - 4.2. From the Perforce command line
  - 4.3. In the Perforce Web GUI (P4Web)
- 5. Editing an issue
  - 5.1. In the Perforce Windows GUI
  - 5.2. From the Perforce command line
  - 5.3. In the Perforce Web GUI (P4Web)
- 6. Starting work and linking it to issues
  - 6.1. Setting your user jobview
  - 6.2. Using the Perforce Windows GUI to start work and link it to issues
  - 6.3. Using the Perforce command line to start work and link it to issues
  - 6.4. Using the Perforce Web GUI (P4Web) to start work and link it to issues
- 7. Submitting partial work while keeping issues
- 8. Submitting completed work and resolving issues
  - 8.1. In the Perforce Windows GUI
  - 8.2. From the Perforce command line
  - 8.3. Using the Perforce development environment plug-ins
  - 8.4. In the Perforce Web GUI (P4Web)
- 9. Linking already-completed work to an issue
  - 9.1. In the Perforce Windows GUI
  - 9.2. From the Perforce command line
- 10. Finding the changes linked to an issue
  - 10.1. In the Perforce Windows GUI
  - 10.2. From the Perforce command line
  - 10.3. In the Perforce Web GUI (P4Web)
  - 10.4. Using the defect tracker
- 11. Finding the issues linked with a change
  - 11.1. In the Perforce Windows GUI
  - 11.2. From the Perforce command line
  - 11.3. In the Perforce Web GUI (P4Web)
- 12. Finding the files affected by an issue
  - 12.1. In the Perforce Windows GUI
  - 12.2. From the Perforce command line
  - 12.3. In the Perforce Web GUI (P4Web)
- 13. Finding the issues linked to files
  - 13.1. In the Perforce Windows GUI
  - 13.2. From the Perforce command line
  - 13.3. In the Perforce Web GUI (P4Web)
- 14. Finding the issues you're working on
  - 14.1. In the Perforce Windows GUI
  - 14.2. From the Perforce command line
  - 14.3. In the Perforce Web GUI (P4Web)
- 15. Finding out where an issue is being worked on and by whom
  - 15.1. In the Perforce Windows GUI
  - 15.2. From the Perforce command line
- 16. Finding out which issues have been fixed in a release
- A. References
- B. Document history
- Glossary

## 1. Introduction

This manual is the Perforce Defect Tracking Integration User's Guide. It teaches the use of the Perforce Defect Tracking Integration; detailed instructions on using Perforce and your defect tracker aren't given here. If you need more information on using Perforce, please see the Perforce User's Guide, the Perforce Command Reference, or the Perforce on-line help system. If you need more information on using your defect tracking system, please see the manuals for the system or consult your defect tracking administrator.

If you're administering the Perforce Defect Tracking Integration (P4DTI), you'll need our Perforce Defect Tracking Integration Administrator's Guide. If you're installing the P4DTI, the Administrator's Guide is the place to start.

## 2. Overview of the software

The P4DTI makes the defect tracker's records appear as jobs in Perforce. You can work with jobs more or less just as described in the Perforce manuals, and your changes are reflected in the defect tracker. This saves you having to switch between Perforce and the defect tracker to do your work. For information on how to work with jobs in Perforce, see the Perforce User's Guide.

Perforce has a mechanism for linking changelists to jobs. The P4DTI links the changelists to defect tracker issues as well, so you don't need to switch to the defect tracker and copy out information about your changes. Linking also allows you to:

1. Record work done for a particular reason.
2. Find out which work has been integrated into a codeline.
3. Determine which issues have been addressed by a particular version of the source code.
4. Find out what changed in order to resolve an issue.
5. Find out which defect tracker issues have influenced a file, so that you can understand the reasons for its design.

The P4DTI makes the links to changelists appear in the defect tracker, making it easy to see what was done or is currently being done to resolve a defect.

See the Perforce Defect Tracking Integration Administrator's Guide for an overview of how the P4DTI works.

### 2.1. A typical workflow using the P4DTI

A typical organization might use the P4DTI in the following way:

1. The development manager assigns a defect tracking issue to a developer. This assignment is replicated into the corresponding Perforce job.
2. The developer notices the issue in her list of jobs.
3. The developer analyzes the issue and updates the job. Her analysis is replicated back to the defect tracker and appears there too.
4. The developer checks out some files to work on to fix the problem, and links her pending work to the job. The link is replicated back to the defect tracker, and her colleagues can tell that the issue is being worked on, by whom, and where.
5. The developer finishes fixing the defect and submits her changelist. The job status changes, and this change causes a corresponding change in the defect tracker, so that the issue is marked as "resolved" and moved on to the test group for verifying.
6. The test group checks that the issue is resolved, and also runs tests on the areas of the system that were changed to make sure they weren't damaged.

For information about your organization's workflow policy, or how you should use the P4DTI, consult your manager or the P4DTI administrator.

### 2.2. How the P4DTI enforces the defect tracker's rules

If you do something in Perforce that the defect tracker doesn't allow--for example, if your action causes an error, or if it's forbidden by the defect tracker's rules--then the replicator undoes the change in Perforce when it next wakes up, and sends you an e-mail message explaining what happened. The e-mail message contains your changes, so you won't have lost them.

An example of such an e-mail message is shown in figure 1.

Figure 1. Example e-mail sent when a user changes an issue in Perforce in a way that's forbidden in the defect tracker

    Date: Tue, 31 Jul 2001 08:12:20 +0100 (BST)
    From: p4dti-replicator0@company.domain
    To: Job owner <rb@company.domain>, Job changer <gdr@company.domain>,
            P4DTI administrator <admin@company.domain>
    Subject: (P4DTI-8603)  Job 'bug7' overwritten by issue 'bug7'.

    (P4DTI-8658)  This is an automatically generated e-mail from the Perforce Defect
    Tracking Integration replicator 'replicator0'.

    (P4DTI-8512)  The replicator failed to replicate Perforce job 'bug7' to
    defect tracker issue 'bug7', because of the following problem:
1 |
    (P4DTI-6142)  No transition from state 'assigned' to state 'verified'.
    (P4DTI-8614)  The replicator has therefore overwritten Perforce job 'bug7'
    with defect tracker issue 'bug7'.  See section 2.2 of the P4DTI User Guide
    for more information.
2 |
    (P4DTI-8625)  The job looked like this before being overwritten:

    Date: 2001/07/31 08:05:45
    Description:
    	It says 'foot' where it should say 'metre'.
    Job: bug7
    Owner: rb
    P4DTI-filespecs:
    P4DTI-issue-id: 7
    P4DTI-rid: replicator0
    P4DTI-user: gdr
    Priority: Low
    Severity: Medium
    State: verified
    Title: It uses imperial measurements
3 |
    (P4DTI-8523)  Here's a full Python traceback:
    ...
    (P4DTI-8534)  If you are having continued problems, please contact your P4DTI
    administrator <admin@company.domain>.

Notes on figure 1:

1. This paragraph gives the reason why the change to the job couldn't be replicated to the defect tracker. The code at the start of the paragraph is a unique message identifier that can be used to look up that message in section 11.2 of the Perforce Defect Tracking Integration Administrator's Guide.

   In this case the problem is that <gdr@company.domain> changed the status of the job from "assigned" to "verified", but this was forbidden in the defect tracker. The remedy is to follow the defect tracker's workflow.

2. This section shows the Perforce job as it was after the forbidden change had been made, but before it was undone.

   The P4DTI reverses all changes, even if some of them would have been allowed. For example, if <gdr@company.domain> has changed Priority from "High" to "Low" as well as Status from "assigned" to "verified" then both of these fields will be set back even though the change to Priority may have been allowed on its own.

3. This section gives a complete traceback at the point in the code where the problem was discovered. This traceback allows Perforce support to track down defects in the code that prevent replication. Under normal use you can ignore this.

The P4DTI undoes the change to the job, but it doesn't undo any fixes, even if it was a fix that caused the forbidden change to the job. That's because there needs to be a way to add retrospective fixes in Perforce (see section 9, "Linking already-completed work to an issue") even if the retrospective fix would violate the defect tracker's workflow.

### 2.3. Other restrictions on using the P4DTI

Your organization might have a policy about which changelists to link with issues. For example, some organizations might want only the final check-in of a fix linked, and some might want all the intermediate stages linked. Your organization's policy may not allow some of the procedures in this manual; for information about your organization's policy, consult your manager or the P4DTI administrator.

## 3. Creating an issue

Create issues in the defect tracker as normal. Each organization has its own policies for how to create issues, so if you need instructions, consult your defect tracker administrator.

You can't create issues by creating jobs in Perforce.

## 4. Finding issues assigned to you

You can use the defect tracker to see a list of issues assigned to you in the normal way. In addition, your defect tracker might be configured to send you e-mail messages when issues are assigned to you.

You can also use Perforce to see the issues assigned to you, by setting a jobview that matches the jobs representing these issues. For detailed instructions on specifying a jobview, see the Perforce User's Guide.

The correct choice of jobview depends on which defect tracker you're using, how the P4DTI has been configured, and what workflow you use. Ask your P4DTI administrator if you have trouble specifying the jobview you want. If you're using standard fields and workflows in your defect tracker, then the jobviews in table 1 should be suitable.

Table 1. Jobviews for standard workflows and configurations

Defect Tracker | Issues you want to see
--- | ---
Assigned to user `spqr` for fixing. | Assigned to user `spqr` for testing.
Bugzilla | `assigned_to=spqr status=assigned` | `assigned_to=spqr status=closed`

Section 4.1 explains how to use a jobview to view jobs assigned to you in the Perforce Windows GUI. Section 4.2 explains how to use a jobview to view jobs assigned to you from the Perforce command line. Section 4.3 explains how to do this using the Perforce Web GUI (P4Web). Perforce 2004.2 does not provide a way of viewing the list of jobs assigned to you from any of the development environment plug-ins.

### 4.1. In the Perforce Windows GUI

To find issues assigned to you, follow these steps:

1. Choose Job > View Jobs. This selects the Perforce Jobs pane.
2. Choose Job > Filter and enter a jobview. This procedure restricts the jobs you see to those matching the jobview, as shown in figure 2.

Figure 2. Viewing jobs assigned to you from the Perforce Windows GUI

### 4.2. From the Perforce command line

To find issues assigned to you, enter the command `p4 jobs -e "jobview"` with an appropriate jobview (see table 1).

For example, if you're using Bugzilla, then the following command displays a list of jobs that have been assigned for development to the user whose Perforce userid is "spqr":

>     p4 jobs -e "assigned_to=spqr status=assigned"

### 4.3. In the Perforce Web GUI (P4Web)

To find issues assigned to you, follow these steps:

1. Select the Jobs tab. This will show the Perforce Jobs page.
2. Enter a jobview in the Jobview field, and press the Filter button (see figure 3). You'll probably find that you only use one or two different jobview filters. Once you have entered a particular jobview you can bookmark the resulting page to avoid having to enter the joview again.

Figure 3. Viewing jobs assigned to you from the Perforce Web GUI

## 5. Editing an issue

You can edit an issue by editing the contents of the job in Perforce. Your changes are replicated back to the defect tracker. This procedure is useful when you want to:

- add more description to the job record.
- write notes about how the job was fixed, what else needs to be done, and so on.
- correct something in the job record.
- change the job status.
- add a note to the issue and change its status. For example, there might be a work-around that you need to tell people about, rather than fixing anything in the code.
- send the issue back to your manager because you can't do it for some reason.

If you change the issue in a way that the defect tracker doesn't allow--for example, if your action causes an error, or if it's forbidden by the defect tracker workflow--then the replicator undoes the change in Perforce when it next wakes up, and sends you an e-mail message explaining what happened. The e-mail message contains your changes, so you won't have lost them.

To change an issue, edit the job in Perforce as described in the following subsections. Depending on your organization's policies, you might need to add some text explaining why you've edited the job. (If you have made changes and have already submitted them, you need to link them to the job using the method described in Section 9, "Linking already-completed work to an issue".)

Perforce 2004.2 does not provide a way of editing an issue from any of the development environment plug-ins.

### 5.1. In the Perforce Windows GUI

To edit an issue, follow these steps:

1. Select the job you need to edit.
2. Choose Job > Edit Spec jobname.
3. Edit the job appropriately. (For an example of editing a job, see figure 4).

Figure 4. Editing a job using the Perforce Windows GUI

### 5.2. From the Perforce command line

To edit an issue from the Perforce command line, enter a `p4 job` command and edit the job appropriately. For example, the following command opens a form in your editor that allows you to edit the job bug94:

>     p4 job bug94

For more information, see the Perforce User's Guide.

### 5.3. In the Perforce Web GUI (P4Web)

To edit an issue, follow these steps:

1. Select the Jobs tab. This will show the Perforce Jobs page.
2. Select the job you need to edit.
3. Select Edit job... from the dropdown menu just below the tab bar (see figure 5). You may also need to press the Go button.
4. Make your edits.
5. Press the Save button when you have finished making your edits.

Figure 5. Editing a job using the Perforce Web GUI

## 6. Starting work and linking it to issues

The P4DTI allows you to link your work in progress to an issue. This link records your intentions and so has several advantages:

- you can find out later why you have files checked out. For instructions, see Section 14, "Finding the issues you're working on".
- you can find out later where you're working on an issue. For instructions, see Section 15, "Finding out where an issue is being worked on and by whom".
- other people can find out who's working on an issue and where. For instructions, see Section 15, "Finding out where an issue is being worked on and by whom".

To gain these advantages, you first need to set up a user jobview as described in Section 6.1, and then create a pending changelist containing your edits and link it to a Perforce job, as described in Section 6.2 (for the Perforce Windows GUI), Section 6.3 (for the Perforce command line), or Section 6.4 (for the Perforce Web GUI). The link will show up in the defect tracker. For more information, see the Perforce User's Guide.

Note that you can only ever link a changelist with an issue once. If you link it with the same issue again using a different keyword, the effect is just to change the keyword.

Perforce 2004.2 has no way of handling numbered pending changelists from any of the development environment plug-ins, so this method is not available from those interfaces.

### 6.1. Setting your user jobview

To set your user jobview in the Perforce Windows GUI, follow these steps:

1. Choose User > Edit spqr (where "spqr" is your Perforce userid).
2. Type a jobview into the JobView field (see section 4 for advice on choosing a jobview).

To set your user jobview from the Perforce command line, follow these steps:

1. Edit your user spec by typing `p4 user`.
2. Add a JobView field to your user spec if you don't yet have one.
3. Enter a jobview into the JobView field (see section 4 for advice on choosing a jobview)

To set your user jobview in the Perforce Web GUI, follow these steps:

1. Select the User: spqr link in the status bar at the top of the page. Alternatively, select the Users tab, select your userid, and press the edit button.
2. Type a jobview into the JobView field (see section 4 for advice on choosing a jobview).
3. Press the Save button.

### 6.2. Using the Perforce Windows GUI to start work and link it to issues

To start work and link it to an issue, follow these steps:

1. Choose Changelist > View Pending Changelists. This selects the Pending Perforce Changelists pane.
2. Choose Changelist > New. This brings up the dialog shown in figure 6.
3. Enter a description of the changes you're making in the Description field.
4. Uncheck any edits that you don't want to include in the Filespecs list. (The Filespecs list is the list of edits from the default changelist.)
5. Check the boxes next to the names of the jobs with which you want to link your edits. (If the list of jobs doesn't show up, then cancel the dialog, press F5, and try again.)
6. Choose the status to which you want to change those jobs from the JobStatus menu. The statuses are changed when the changelist is submitted.
7. Click Update to create the changelist.

You can also add more links to jobs by selecting the changelist, choosing Changelist > Edit Spec, and repeating the steps above.

To add more links and set the status of the jobs to "closed", follow these steps:

1. Select the changelist that you want to link.
2. Choose Changelist > Add Job Fix.
3. Select the set of jobs you want to link the changelist with in the dialog. (See figure 15 for an example.)
4. Click OK.

Note that the list of jobs in this dialog is not related to your user jobview. It's the same list as in the Perforce Jobs pane. (See figure 2 for an example of the Perforce Jobs pane).

To add more edits to the changelist later, drag the edits from other changelists.

To check out files for edit, drag them from the depot view.

To delete links to jobs, select the link inside the changelist and choose Changelist > Remove Job Fix.

Figure 6. Creating a new changelist and linking it to jobs

### 6.3. Using the Perforce command line to start work and link it to issues

To start work and link it to an issue, follow these steps:

1. Create a new pending changelist with your changes by using the following command:

   >     p4 change -s

   This command opens a change specification in your editor. With the "-s" option, jobs that match your jobview appear in the text form with an "ignore" keyword (see figure 7).
2. Enter a description of your changes under the "Description" heading, as usual.
3. Delete any edits that you don't want to include from the Filespecs list. (The Filespecs list is the list of edits from the default changelist.)

4. Edit the keyword next to the names of the jobs you want linked with the change. When the change is submitted, the change is linked with the jobs, and the job statuses change to match this keyword. Jobs that have the keyword "ignore" won't be changed or linked.

   For example, your jobview might match three jobs which show up as shown in figure 7. (If it doesn't look like this, then either you don't have a jobview set or else you forgot the `-s` option).

   Figure 7. Jobs section of a new change form.

       Jobs:
       	bug1 ignore	# The division operator gets its
       	bug2 ignore	# There's no delete command
       	bug3 ignore	# When -O3 is specified, some loo

   Suppose that your change fixes bug1, partially fixes bug2 (so leaving it open), and is unrelated to bug3. Then you'd edit the form to look as shown in figure 8.

   Figure 8. Jobs section of a change form, showing intended effect of submitting the changelist.

       Jobs:
       	bug1 closed	# The division operator gets its
       	bug2 open	# There's no delete command
       	bug3 ignore	# When -O3 is specified, some loo

5. Add similar lines to the Jobs section of the form for other jobs you want to link. Delete lines for jobs you don't want linked.
6. Close your editor to create a pending changelist with the jobs linked.

When you submit a pending changelist later, the status of the linked jobs changes as specified. (To submit a pending changelist, use a command like `p4 submit -c changelist`).

You can also add more links to jobs by using the following command:

>     p4 change -s changelist

where changelist is the number of the changelist you created above.

To link pending changelists with jobs, use a command like the following:

>     p4 fix -s resolved -c 3004 bug34 bug94

(where "resolved" is the status you want the jobs to change to, "3004" is the pending changelist number, and "bug34" and "bug94" are the jobs you want to link the changelist with).

To add more edits to the changelist later, use the `-c` option to many Perforce commands, or move the edits from other changelists using the `p4 reopen -c` command. For more information, see the Perforce User's Guide.

To remove links, use a command like the following:

>     p4 fix -d -c 3004 bug34 bug94

(where "resolved" is the status you want the jobs to change to, "3004" is the pending changelist number, and "bug34" and "bug94" are the jobs you want to remove the link from).

Figure 9. Selecting jobs to link when submitting or creating a change from the command line with a jobview set

    # A Perforce Change Specification....

    Change:	new

    Client:	newton-skylark

    User:	newton

    Status:	new

    Description:
    	<enter description here>

    Jobs:
    	bug3 ignore	# When -O3 is specified, some loo
    	bug1 ignore	# The division operator gets its
    	bug2 ignore	# There's no delete command

    Files:
    	//depot/project/editor/src/buffer.c	# edit
    	//depot/project/editor/src/buffer.h	# edit

### 6.4. Using the Perforce Web GUI (P4Web) to start work and link it to issues

To start work and link it to an issue, follow these steps:

1. Selecting the Pending tab. This will show the Pending Changelists page.
2. Select the changelist called default. You will edit this and create a new pending changelist. See figure 10.
3. Enter a description of the changes you're making in the Description field.
4. Uncheck any files that you don't want to include in the Files list.
5. Edit the list of jobs so that only jobs to which you want to link your change are displayed in the Jobs field.
6. Choose the status to which you want to change those jobs from the JobStatus menu. The statuses are changed when the changelist is submitted.
7. Press Create Changelist to create the new numbered pending changelist.

You can also add more links to jobs by selecting the changelist (from the Pending Changelists page) and repeating the steps above.

Figure 10. Creating a new changelist and linking it to jobs

## 7. Submitting partial work while keeping issues

You can submit a change and link it to an issue without changing the issue status. This procedure allows an organization to track partially completed work that's related to an issue, as well as the final submission that resolves it.

Note: Your organization's policy regarding links between changes and issues might not allow you to use this feature. For more information, consult your manager or P4DTI administrator.

If you're linking intermediate stages of changelists with issues, you probably don't want to change the status of the issue. The way to do this is to link the changelist with the issue as usual, but with the same status as the issue currently has. For example, in Perforce you can use the `p4 fix` command with the "-s" argument set to the current status of that issue. When linking the final check-in, the "-s" argument is something like "fixed" or "resolved" or perhaps "closed".

To submit partial work while keeping issues, follow the procedures described in Section 8, except that, when fixing the job, set the status to the job's current status, rather than to the resolved status.

## 8. Submitting completed work and resolving issues

Once you have completed work on a job, you can use Perforce to submit the associated changelist, link the changelist to the job, and change the job status, all at the same time.

Make sure your jobview is set before you follow the procedures in this section. See Section 6.1, "Setting your user jobview".

### 8.1. In the Perforce Windows GUI

To submit completed work and resolve issues, follow these steps:

1. Choose Changelist > View Pending Changelists. This selects the Pending Perforce Changelists pane.
2. Select the changelist you want to submit.
3. Choose Changelist > Submit. This command opens the dialog shown in figure 11.
4. Enter a description of the changes you're making in the Description field.
5. Check the boxes next to the names of the jobs with which you want to link your edits. (If the list of jobs doesn't show up, then cancel the dialog, press F5, and try again.)
6. Select the status to which you want to change those jobs from the JobStatus menu.
7. Click Submit to submit the changelist, link to the jobs, and change the job statuses.

Figure 11. Selecting jobs to link when submitting from the Perforce Windows GUI with a jobview set

### 8.2. From the Perforce command line

If the edits you want to link are on your default changelist, follow these steps to submit completed work and resolve issues:

1. Enter the command

   >     p4 submit -s

   This command opens a change specification in your editor. With the "-s" option, a list of jobs that match your jobview appears in the text form with an "ignore" keyword. (See figure 7 for an example.)
2. Enter a description of your changes under the "Description" heading, as usual.
3. Edit the keyword next to the names of the jobs you want linked with the change. The change is linked with the jobs, and the job statuses are changed to match this keyword. Jobs that have the keyword "ignore" won't be changed or linked.
4. Add similar lines for other jobs you want to link. Delete lines for jobs you don't want linked.
5. Close your editor to submit the change, link the jobs, and change their statuses.

If the edits you want to link are on a pending changelist, follow these steps:

1. Edit the changelist as described in Section 6.3, "Using the Perforce command line to start work and link it to issues".

2. Submit the changelist by entering the command

   >     p4 submit -c changelist

### 8.3. Using the Perforce development environment plug-ins

To submit completed work and resolve issues, follow these steps:

1. Begin your usual check-in procedure. When the check-in dialog opens, leave the check-in comment blank and click OK. This procedure opens a second, more detailed, dialog that includes a list of jobs to choose from. (See figure 12 for an example.)
2. Enter a description of your changes, as usual.
3. Delete the jobs you don't want to link with your changelist from the list. You may also add similar lines for other jobs you want to link.
4. Enter the new status for the jobs in the JobStatus field.
5. Click OK to submit the changes.

When you submit your changelist, the status of the jobs you left in the form is updated to match the JobStatus field and the changelist is linked with them with that status.

Figure 12. Selecting jobs to link when submitting from Visual Studio

### 8.4. In the Perforce Web GUI (P4Web)

To submit completed work and resolve issues, follow these steps:

1. Selecting the Pending tab. This will show the Pending Changelists page.
2. Select the changelist you want to submit. This opens a page to edit the changelist, similar to the one in figure 13.
3. Enter a description of the changes you're making in the Description field.
4. Uncheck any files that you don't want to include in the Files list.
5. Edit the list of jobs so that only jobs to which you want to link your change are displayed in the Jobs field.
6. Choose the status to which you want to change those jobs from the JobStatus menu. The statuses are changed when the changelist is submitted.
7. Press Submit to submit the changelist, link to the jobs, and change the job statuses.

Figure 13. Selecting jobs to link when submitting from the Perforce Web GUI with a jobview set

## 9. Linking already-completed work to an issue

You can use Perforce to link a change that you've already made with a issue you've been assigned. For example, suppose you realize that a change you made yesterday also resolves some issues you've been assigned to work on today. You can record this information in the defect tracking system and get rid of those issues.

Note: The defect tracker's workflow might prevent you from linking to an issue that you don't own. If you try, the P4DTI removes your link and sends you e-mail.

Perforce 2004.2 does not provide a way of linking submitted changelists with jobs from the Web GUI (P4Web) or any of the development environment plug-ins.

### 9.1. In the Perforce Windows GUI

To link already-completed work to an issue, follow these steps:

1. Choose Changelist > View Submitted Changelists to view the Submitted Perforce Changelists pane. (See figure 14 for an example.)
2. Select the changelist that you want to link.
3. Choose Changelist > Add Job Fix.
4. Select the set of jobs you want to link with the changelist in the dialog box that opens. (See figure 15 for an example.)
5. If you're using P4Win release 2001.1 or later, select the status to which you want to change those jobs from the Job Status menu. (If you're using an earlier P4Win release, then those jobs will simply be closed: you don't get an opportunity to specify their status.)
6. Click OK.

Figure 14. Viewing the submitted changelists

Figure 15. Adding a job fix

### 9.2. From the Perforce command line

To link already-completed work to an issue from the Perforce command line, enter a `p4 fix` command. For example, the following command links changelist 4096 with issues bug23 and bug1239 and changes their status to "resolved":

>     p4 fix -s resolved -c 4096 bug23 bug1239

If you don't specify a "-s" option, the issue status is changed to "closed".

## 10. Finding the changes linked to an issue

You can use Perforce or the defect tracker to see the changes resulting from an issue, as described in the following subsections. This procedure is useful if you need to:

- find out what was done about a bug
- verify that an issue has been dealt with correctly
- check that all the changes linked with the issue are properly justified
- see what areas of the code have changed so that you can direct testing at those areas

Perforce 2004.2 does not provide a way of finding the changes resulting from an issue from any of the development environment plug-ins.

### 10.1. In the Perforce Windows GUI

To find the changes linked to an issue, follow these steps:

1. Choose Job > View Jobs. This selects the Perforce Jobs pane. (See figure 2 for an example.)
2. Select the job you want to know about.
3. Choose Job > Describe jobname.
4. Click the Show Fixes button. (If there are changelists linked with the job, then this button appears at the bottom of the job description window.)
5. Scroll down to the bottom of the job to see the linked changes under the "Fixes" heading, as shown in figure 16.
6. Right-click on the changelist number and choose Describe Changelist to get a full description of a change.

Figure 16. Finding linked changes from the Perforce Windows GUI

### 10.2. From the Perforce command line

To find the changes linked with an issue, enter a `p4 fixes` command. For example, the following command lists the changes resulting from issue bug34:

>     p4 fixes -j bug34

For details, see the Perforce User's Guide.

### 10.3. In the Perforce Web GUI (P4Web)

To find the changes linked to an issue, follow these steps:

1. Select the Jobs tab. This shows the Perforce Jobs page. (See figure 3 for an example).
2. Select the job you want to know about.
3. Select View fixes for job from the dropdown menu just below the tab bar (see figure 17). You may also need to press the Go button.
4. Select any change from the Fixes list to view its description.

Figure 17. Finding linked changes from the Perforce Web GUI

### 10.4. Using the defect tracker

In Bugzilla, look in the "Perforce replication" section of the bug form to find the changes linked with an issue (see figure 18). If you don't see the Perforce replication section, contact your P4DTI administrator.

Figure 18. The changes linked with a Bugzilla bug

## 11. Finding the issues linked with a change

You can use Perforce to see the issues linked with a changelist.

Perforce 2004.2 does not provide a way of finding the issues linked with a changelist from any of the development environment plug-ins.

### 11.1. In the Perforce Windows GUI

To find the issues linked with a change, follow these steps:

1. Select the changelist you're interested in.
2. Choose Changelist > Describe Changelist number.
3. Look under the Jobs Fixed heading to see the issues linked with this changelist. (See figure 19 for an example.)

Figure 19. Finding linked issues from the Perforce Windows GUI

### 11.2. From the Perforce command line

To find the issues linked with a change, enter a `p4 fixes` command. For example, the following command finds the issues linked with changelist 4339:

>     p4 fixes -c 4339

For details, see the Perforce User's Guide.

### 11.3. In the Perforce Web GUI (P4Web)

To find the issues linked with a change, follow these steps:

1. Select the Submitted tab to find a submitted changelist, or select the Pending tab to find a pending changelist.
2. Select the changelist you're interested in. A submitted changelist displays the jobs fixed in the Fixes list (and links to them). A pending changelist displays the jobs that it will link to when submitted in the Jobs field.

## 12. Finding the files affected by an issue

You can use Perforce to find out which files were changed in order to fix an issue. To do this, you first need to find out the changelists linked with the issue, as described in Section 10, "Finding the changes linked to an issue".

Perforce 2004.2 does not provide a way of finding files that were checked in for an issue from any of the development environment plug-ins.

### 12.1. In the Perforce Windows GUI

To find the files affected by an issue, follow these steps:

1. Find out the changelists linked with the issue, as described in Section 10, "Finding the changes linked to an issue".
2. Right-click on a changelist number (in the Fixes list) and choose Describe Changelist to get a full description of a change. The description of the changelist includes the list of affected files (see figure 19).

### 12.2. From the Perforce command line

To find the files affected by an issue, follow these steps:

1. Find out the changelists linked with the issue, as described in Section 10, "Finding the changes linked to an issue".

2. Enter a `p4 describe` command at the Perforce command line. For example, the following command outputs a list of the files that were checked in to fix the issue and the diffs for those files:

   >     p4 describe 4339

   For more information, see the Perforce User's Guide.

### 12.3. In the Perforce Web GUI (P4Web)

To find the files affected by an issue, follow these steps:

1. Find out the changelists linked with the issue, as described in Section 10, "Finding the changes linked to an issue".
2. Select a changelist from the fixes to view the description of that changelist. The Affected files list displays the files affected by that change.

## 13. Finding the issues linked to files

You can use Perforce to find out which issues are linked with particular files. This is very useful for finding out which issues have affected files in the past.

Perforce 2004.2 does not provide a way of finding which issues are linked with particular files from any of the development environment plug-ins.

### 13.1. In the Perforce Windows GUI

To find the issues linked to a file or set of files, follow these steps:

1. Choose View > Jobs.
2. Select the files in the left-hand (depot) pane.
3. Choose Jobs > Filter by Selected Files to filter the jobs.

### 13.2. From the Perforce command line

To find the issues linked to a file or set of files, enter a `p4 fixes` or a `p4 jobs` command at the Perforce command line. For example, the following command lists the changelists with fixes for the files with a ".c" extension in the "/depot/foo/bar" directory:

>     p4 fixes //depot/foo/bar/*.c

The following command lists all the issues that have been linked to all the files with a ".c" extension in the "/depot/foo/bar" directory:

>     p4 jobs //depot/foo/bar/*.c

For more information, see the Perforce User's Guide.

### 13.3. In the Perforce Web GUI (P4Web)

To find the issues linked to a file or set of files, follow these steps:

1. Select the Files tab. This displays the Perforce Files page.
2. Browse the tree to find the file or files you are interested in. You can browse either the Workspace Tree or the Depot Tree. When browsing using P4Web you will only be able to select either a single file or an entire directory. It is not possible to select just two files from a directory containing hundreds, for example.
3. Select the Jobs tab. This shows the Perforce Jobs page, an example of which is figure 20. Note that the directory containing the files of interest is displayed in the Path field.
4. Check the checkbox labelled if fixed in this path.
5. Press the Filter button. This will restrict the list of jobs displayed to ones that caused a change to a file that is in the path that you selected.

Figure 20. Finding issues that affected certain files from the Perforce Web GUI

## 14. Finding the issues you're working on

If you've been linking your work with issues as described in Section 6, you can find out which issues you're working on. This procedure is useful when, for example, you are resuming work on a project after a few days away and can't quite remember which issues you were last working on.

To find who's working on an issue, or issues you were working on in a different workspace, see Section 15, "Finding out where an issue is being worked on and by whom".)

Perforce 2004.2 does not provide a way of finding issues being worked on in a particular workspace from any of the development environment plug-ins.

### 14.1. In the Perforce Windows GUI

To find the issues you're working on, follow these steps:

1. Choose Changelist > View Pending Changelists. This selects the Pending Perforce Changelists pane.
2. Click on the plus (+) symbol to expand the list of pending changelists for your client.
3. Expand the pending changelists by clicking on their plus symbols. The jobs you were working on show up with an icon of a wrench in the list of edits.

### 14.2. From the Perforce command line

To find out what you were working on, use a combination of the `p4 changes` and `p4 fixes` commands. For example, the following command finds your pending changelists:

>     p4 changes -s pending | grep username

The following command then shows the issues you were working on in that changelist:

>     p4 fixes -c changelist

### 14.3. In the Perforce Web GUI (P4Web)

To find the issues you're working on, follow these steps:

1. Select the Pending tab. This shows the Pending Changelists page.
2. Select a changelist; the issues linked to that changelist appear in the Jobs field.

## 15. Finding out where an issue is being worked on and by whom

If other people at your organization are linking their work with issues as described in Section 6, you can find out who's working on an issue and in which workspace. This procedure is useful when you know that someone is working on an issue but you don't know who or where their work is--they might be on vacation, or have left the company, or perhaps it's you and you've just forgotten all about it.

To find out which issues you were working on in a particular workspace, see Section 14, "Finding the issues you're working on".

Perforce 2004.2 does not provide a way of finding the workspace in which an issue is being worked on from neither the Perforce Web GUI (P4Web) nor any of the development environment plug-ins.

### 15.1. In the Perforce Windows GUI

To find out where an issue is being worked on, follow these steps:

1. Choose Job > View Jobs. This selects the Perforce Jobs pane. (See figure 2 for an example.)
2. Select the job you want to know about.
3. Choose Job > Describe jobname.
4. Click the Show Fixes button. (If there are changelists linked with the job, then this button appears at the bottom of the job description window.)
5. Scroll down to the bottom of the job to see the linked changes under the Fixes heading, as shown in figure 16. You can't tell the difference between pending and submitted changelists in the Fixes list, so you need to compare the linked changes in this job with the changelists in the Pending Perforce Changelists pane.
6. Choose Changelist > View Pending Changelists. This selects the Pending Perforce Changelists pane.
7. Look at the "Pending Changelists (other clients)" list to see if any of the linked changes from the Fixes list appear here. If so, the change tells you the user and client (workspace).

### 15.2. From the Perforce command line

To find out where an issue is being worked on, use a combination of the `p4 fixes` and `p4 changes` commands. For example, the following commands list the changelists that are linked to bug743 and the list of pending changelists:

>     p4 fixes -j bug743
>     p4 changes -s pending

Any changelists that appear in both lists are work in progress, and this tells you the user and client (workspace) where the work is happening.

## 16. Finding out which issues have been fixed in a release

Once you have the P4DTI running successfully and all developers are conscientiously creating fix records in Perforce (see sections 6 to 9), then it is possible to automatically generate lists of fixed and open issues for a release.

To discover which issues have been fixed in a release, issue the command:

>     p4 fixes -i files-contributing-to-the-release

To specify the files contributing to the release:

1. If each release has its own branch, use a filespec like `//depot/project/foo/release/2.7/...`.
2. If releases are identified by a changelevel on a branch, use a filespec like `//depot/project/foo/version/2/...@12345`.
3. If releases are identified by labels, use a filespec like `//depot/project/foo/...@release-2.7`.

This generates a list of fixes in the source contributing to the release. From this list you need to extract the fixes that actually closed the job, because there may be fixes that don't actually close the job; see section 7. Then you need to remove duplicate entries, because there may be several fixes that close a job. On Unix systems you can do this with a command like:

>     p4 fixes -i files-contributing-to-the-release |
>     grep -v '\)$' | cut -f 1 -d ' ' | sort -u

if jobs are closed by fixing them to 'closed', or with a command like

>     p4 fixes -i files-contributing-to-the-release |
>     grep '(closed-state)$' | cut -f 1 -d ' ' | sort -u

if jobs are closed by fixing them to closed-state. (There are two alternatives here because the `p4 fixes` command has one format for fixes to "closed" and another for fixes to any other status.)

This allows you to work out the jobs fixed in a release of a product. Then:

- You can work out the issues newly fixed in a release (to put in release notes, for example) by taking the difference between the issues fixed in that release and the issues fixed in the previous release.
- You can work out which issues are known in a release by taking the difference between the issues fixed in that release and the total list of issues for that project or product.

## A. References

[GDR 2000-05-03] | "Requirements and Use Cases for Perforce/Defect Tracking Integration"; Gareth Rees; Ravenbrook Limited; 2000-05-03.
[Perforce 2004-06a] | "Perforce 2004.2 User's Guide"; Perforce Software; 2004-06; <http://www.perforce.com/perforce/doc.042/manuals/p4guide/>, <http://www.perforce.com/perforce/doc.042/manuals/p4guide/p4guide.pdf>.
[Perforce 2004-06c] | "Perforce 2004.2 Command Reference"; Perforce Software; 2004-06; <http://www.perforce.com/perforce/doc.042/manuals/cmdref/>, <http://www.perforce.com/perforce/doc.042/manuals/cmdref/cmdref.pdf>.

## B. Document History

2000-08-10 | RB | Created placeholder.
2000-10-15 | LMB | Added section titles; copied in some use cases as comments.
2000-11-10 | RB | Added scads of text with rough documentation of many of the use cases so that LMB can work on real documentation.
2000-11-26 | LMB | Fixed Sections 4.5 and 4.6. Started writing Section 4.15. Started writing Section 2.
2000-11-26 | RB | Changed "document" to "file" throughout.
2000-11-30 | RB | Updated references to Perforce 2000.1 to 2000.2, now that the AG says to use 2000.2
2000-12-04 | RB | Added screenshots and text figures at various places suggested by LMB.
2000-12-05 | RB | Added brief instructions for using the new Show Fixes button in the Perforce Windows GUI.
2000-12-06 | RB | Corrected the instructions for "p4 submit" to "p4 submit -s" and removed unnecessary figures for the previously different "p4 change -s".
2000-12-06 | RB | Added overview sections.
2000-12-06 | RB | Complete re-organization of the manual into more logical steps.
2000-12-07 | RB | Added table of contents. Renumbered figures.
2000-12-07 | RB | Removed note about the "ignore" bug in "p4 submit -s" and "p4 change -s" as it's now fixed in the Perforce server level we require.
2001-01-02 | GDR | Section 5.1 suggests jobviews that will work in both the TeamTrack and Bugzilla integrations. Made reference style consistent with AG. Added section 2.5 asking readers to upgrade to 2000.2.
2001-01-05 | LMB | Made lots of copyedits. Removed ellipses, since they don't conform to Perforce style. Added glossary entries.
2001-01-07 | LMB | Finished improving as per my intuition. Incorporated some comments from TC@perforce (most weren't applicable to the UG). Finished the glossary.
2001-01-08 | LMB | Deleted comments, title material, and Sections A and B in preparation for handoff to Perforce.
2001-01-21 | LMB | At GDR's request, replaced title material and Sections A and B.
2001-01-22 | LMB | As per TC@perforce's request: started every numbered step with a concrete verb; commented out Section 2.1 and Figures 3 and 4; renumbered figures; renamed Section 2.3; added necessary verbiage to all procedure lead-ins. Re-read TC@perforce's requests more carefully; put Section 2.1 back, moved Section 3 to Section 2.2, and renumbered all headings. At Richard's request, re-added figure 4 and renumbered figures.
2001-02-01 | RB | Rewrote introduction to section 2 to provide description of the requirements the software meets without sounding like "marketing". Updated references to Perforce manuals to version 2000.2.
2001-03-02 | RB | Transferred copyright to Perforce under their license.
2001-04-11 | RB | Updated version to 1.1.
2001-04-20 | GDR | Added instruction to select status when adding a fix to a submitted changelist in P4Win.
2001-05-22 | GDR | Added section "Finding out which issues have been fixed in a release".
2001-06-08 | GDR | Added reminder about the `-s` option to `p4 change` and `p4 submit`. Gave example showing how to fill out the change form.
2001-07-14 | GDR | Improved glossary. Gave Bugzilla equal billing with TeamTrack by adding a screenshot and specifying appropriate jobviews. References to Perforce 2000.2 now refer to 2001.1 where appropriate, since we now support Perforce 2001.1.
2001-09-14 | GDR | Added section explaining how the P4DTI enforces the defect tracker's rules. Explained why fixes aren't deleted even if they cause an illegal change.
2003-05-21 | NB | de-TeamTracked.
2003-12-17 | NB | Updated Perforce manual references to 2003.1.
2004-07-22 | DRJ | Added instructions for P4Web (2004.2 P4Web can now manipulate jobs).
2004-07-28 | DRJ | Removed section 15.3 pending P4Web improvement.

## Glossary

changelist | An atomic change transaction in Perforce.
fix | A link between a job and a changelist.
issue | A user-defined unit of work tracked by the defect tracker.
job | A unit of work tracked by Perforce.
jobview | A string used to find jobs that match particular criteria.
pending changelist | A changelist that has not been submitted.
P4DTI | Perforce Defect Tracking Integration. The software that integrates Perforce Software's fast configuration management system with defect tracking systems.
replication | The operation of copying data between a defect tracker and a Perforce server in order to keep each one up to date with changes made in the other. Replication allows developers to do their routine defect resolution work entirely from their Perforce client, without needing to use the defect tracker's interface. It also allows developers to relate their changes to defect tracking issues.
replicator | A process that copies (replicates) data between a defect tracker and a Perforce server in order to keep each one up to date with changes made in the other.
workflow | A set of rules that control who can do what to which issues.

This document is copyright © 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.