Reporting and Data Mining

Perforce 2000.2 Command Line User's Guide (2000.2.ug.1)


<< Previous Chapter Job Tracking	Table of Contents Index Perforce on the Web	Next Chapter >> Installing Perforce

Chapter 11
Reporting and Data Mining
Perforce's reporting commands supply information on all data stored within the depot. There are many reporting commands; in fact, there are almost as many reporting commands as there are action commands. These commands have been discussed throughout the manual; this chapter presents the same commands and provides additional information for each command. Tables in each section contain answers to questions of the form "How do I find information about...?"

Many of the reporting commands have numerous options; discussion of all options for each command is beyond the scope of this manual. For a full description of any particular command, please consult the Perforce Command Reference, or type p4 help command at the command line.

One previously mentioned note on syntax is worth repeating here: any filespec argument in Perforce commands, as in

filespec

will match any file pattern that is supplied in local syntax, depot syntax, or client syntax, with any Perforce wildcards. Brackets around [filespec] means that the file specification is optional. Additionally, many of the reporting commands can take revision specifiers as part of the filespec; revision specifiers are discussed on "Specifying Older File Revisions" on page 27.

Files

The commands that report on files fall into two categories: those that give information about file contents, (e.g. p4 print, p4 diff), and those that supply information on file metadata, the data that describe a file with no reference to content (e.g. p4 files, p4 filelog). The first set of reporting commands discussed in this section describes file metadata; the second set describes file contents.

File metadata

Basic file information

To view information about single revisions of one or more files, use p4 files. This command provides the locations of the files within the depot, the actions (add, edit, delete, etc.) on those files at the specified revisions, the changelists the specified file revisions were submitted in, and the files' types. The output has this appearance:

//depot/README#5 - edit change 6 (text) p4 files requires one or more filespec arguments. Filespec arguments can, as always, be provided in Perforce or local syntax, but the output will always report the corresponding files within the depot. If you don't provide a revision number, Perforce will use the head revision.

Unlike most other commands, p4 files will describe deleted revisions, instead of suppressing information about deleted files.


To View File Metadata for...	Use This Command:
...all files in the depot, whether or not visible through your client view	`p4 files //depot/...`
..all the files currently in any client workspace	`p4 files @clientname`
...all the files in the depot that are mapped through your current client workspace view	`p4 files //clientname/...`
...a particular set of files in the current working directory	`p4 files filespec`
...a particular file at a particular revision number	`p4 files filespec#revisonNum`
...all files at change `n`, whether or not the file was actually included in change `n`	`p4 files @n`
...a particular file within a particular label	`p4 files filespec@labelname`

File revision history

The revision history of a file is provided by p4 filelog. One or more file arguments must be provided, and since the point of p4 filelog is to list information about each revision of particular files, file arguments to this command may not contain a revision specification.

The output of p4 filelog has this form:


`... #3 change 23 edit on 1997/09/26 by edk@doc <ktext> 'Updated help system' ... #2 change 9 edit on 1997/09/24 by lisag@src <text> 'Made changes to fil' ... #1 change 3 add on 1997/09/24 by edk@doc <text> 'Added the filtering bu'`

For each file that matches the filespec argument, the complete list of file revisions is presented, along with the number of the changelist that the revision was submitted in, the date of submission, the user who submitted the revision, the file's type at that revision, and the first few characters of the changelist description. With the -l flag, the entire description of each changelist is printed:


`#3 change 23 edit on 1997/09/26 by edk@doc Updated help files to reflect changes in filtering system & other subsystems ...<etc.>`

Opened files

To see which files are currently opened within a client workspace, use p4 opened. For each opened file within the client workspace that matches a file pattern argument, p4 opened will print a line like the following:

//depot/elm_proj/README - edit default change (text) Each opened file is described by its depot name and location, the operation that the file is opened for (add, edit, delete, branch, or integrate), which changelist the file is included in, and the file's type.


To See...	Use This Command:
...a listing of all opened files in the current workspace	`p4 opened`
...a list of all opened files in all client workspaces	`p4 opened -a`
...a list of all files in a numbered pending changelist	`p4 opened -c changelist#`
...a list of all files in the default changelist	`p4 opened -c default`
...whether or not a specific file is opened by you	`p4 opened filespec`
...whether or not a specific file is opened by anyone	`p4 opened -a filespec`

Relationships between client and depot files

It is often useful to know how the client and depot are related at a particular moment in time. Perhaps you simply want to know where a particular client file is mapped to within the depot, or you may want to know whether or not the head revision of a particular depot file has been copied to the client. The commands that express the relationship between client and depot files are p4 where, p4 have, and p4 sync -n. The first of these commands, p4 where, shows the mappings between client workspace files, depot files, and local OS syntax. p4 have tells you which revisions of files you've last synced to your client workspace, and p4 sync -n describes which files would be read into your client workspace the next time you perform a p4 sync.

All these commands can be used with or without filespec arguments. p4 sync -n is the only command in this set that allows revision specifications on the filespec arguments.

The output of p4 where filename looks like this:

//depot/elm_proj/doc/Ref.guide //edk/doc/Ref.guide /usr/edk/doc/Ref.guide The first part of the output is the location of the file in depot syntax; the second part is the location of the same file in client syntax, and the third is the location of the file in local OS syntax.

p4 have's output has this form:

//depot/doc/Ref.txt#3 - /usr/edk/elm/doc/Ref.txt and p4 sync -n provides output like:

//depot/doc/Ref.txt#3 - updating /usr/edk/elm/doc/Ref.txt The following table lists other useful commands:


To See...	Use This Command:
...which revisions of which files you have in the client workspace	`p4 have`
...which revision of a particular file is in your client workspace	`p4 have` `filespec`
...where a particular file maps to within the depot, the client workspace, and the local OS	`p4 where` `filespec`
...where a particular file in the depot maps to in the workspace	`p4 where //depot/.../filespec`
...which files would be synced into your client workspace from the depot when you do the next sync	`p4 sync -n`

File contents

Contents of a single revision

The contents of any file revision within the depot can be viewed with p4 print. This command simply prints the contents of the file to standard output, or to the specified output file, along with a one-line banner that describes the file. The banner can be removed by passing the -q flag to p4 print. When printed, the banner has this format:

//depot/elm_proj/README#23 - edit change 50 (text) p4 print takes a mandatory file argument, which can include a revision specification; The file will be printed at the specified revision; if no revision is specified, the head revision will be printed.


To See the Contents of Files...	Use This Command:
...at the current head revision	`p4 print filespec`
...without the one-line file header.	`p4 print -q filespec`
...at a particular change number	`p4 print filespec@changenum`

File content comparisons

A client workspace file can be compared to any revision of the same file within in the depot with p4 diff. This command takes a filespec argument; if no revision specification is supplied, the workspace file is compared against the revision last read into the workspace.

The p4 diff command has many options available; only a few are described in the table below. For more details, please consult the Perforce Command Reference.

Whereas p4 diff compares a client workspace file against depot file revisions, p4 diff2 can be used to compare any two revisions of a file. It can even be used to compare revisions of different files. p4 diff2 takes two file arguments -- wildcards are allowed, but any wildcards in the first file argument must be matched with a corresponding wildcard in the second. This makes it possible to compare entire trees of files.

There are many more flags to p4 diff than are described below. For a full listing, please type p4 help diff at the command line, or consult the Perforce Command Reference.


To See the Differences between...	Use This Command:
...an open file within the client workspace and the revision last taken into the workspace	`p4 diff file`
...any file within the client workspace and the revision last taken into the workspace	`p4 diff -f file`
...a file within the client workspace and the same file's current head revision	`p4 diff file#head`
...a file within the client workspace and a specific revision of the same file within the depot	`p4 diff file#revnumber`
...the `n`-th and head revisions of a particular file	`p4 diff2 filespec filespec#n`
...all files at changelist `n` and the same files at changelist `m`	`p4 diff2 filespec@n filespec@m`
...all files within two branched codelines	`p4 diff2 //depot/path1/... //depot/path2/...`
...a file within the client workspace and the revision last taken into the workspace, passing the context diff flag to the underlying diff.	`p4 diff -dc file`

The last example above bears further explanation; to understand how this works, it is necessary to discuss how Perforce implements and calls underlying diff routines.

Perforce uses two separate diffs: one is built into the p4d server, and the other is used by the p4 client. Both diffs contain identical, proprietary code, but are used by separate sets of commands. The client diff is used by p4 diff and p4 resolve, and the server diff is used by p4 describe, p4 diff2, and p4 submit.

Perforce's built-in diff routine allows three -d<flag> flags: -du, -dc, and -dn; both p4 diff and p4 diff2 allow any of these flags to be specified. These flags behave identically to the corresponding flags in the standard UNIX diff.

Although the server must always use Perforce's internal diff routine, the client diff can be set to any external diff program by pointing the P4DIFF environment variable to the full path name of the desired executable. Any flags used by the external diff can be passed to it with p4 diff's -d flag. Flags are passed to the underlying diff according to the following rules:

If the character immediately following the -d is not a single quote, then all the characters between the -d and whitespace are prepended with a dash and sent to the underlying diff;
If the character immediately following the -d is a single quote, then all the characters between the opening quote and the closing quote are prepended with a dash and sent to the underlying diff.

The following examples demonstrate the use of these rules in practice.


If you want to pass the following flag to an external client diff program:	Then call p4 diff this way:
`-u`	`p4 diff -du`
`--brief`	`p4 diff -d-brief`
`-C 25`	`p4 diff -d'C 25'`

Changelists

Two separate commands are used to describe changelists. The first, p4 changes, lists changelists that meet particular criteria, without describing the files or jobs that make up the changelist. The second command, p4 describe, lists the files and jobs affected by a single changelist. These commands are described below.

Viewing changelists that meet particular criteria

To view a list of changelists that meet certain criteria, such as changelists with a certain status, or changelists that affect a particular file, use p4 changes. The output looks like this:


`Change 36 on 1997/09/29 by edk@eds_elm 'Changed filtering me' Change 35 on 1997/09/29 by edk@eds_elm 'Misc bug fixes: fixe' Change 34 on 1997/09/29 by lisag@lisa 'Added new header inf'`

By default, p4 changes displays an aggregate report containing one line for every changelist known to the system, but command line flags and arguments can be used to limit the changelists displayed to those of a particular status, or those affecting a particular file, or the last n changelists.

Currently, the output can't be restricted to changelists submitted by particular users, although you can write simple shell or Perl scripts to implement this (you'll find an example of such a script in the Perforce System Administrator's Guide)..


To See a List of Changelists...	Use This Command:
...with the first 31 characters of the changelist descriptions	`p4 changes`
...with the complete description of each changelist	`p4 changes -l`
...including only the last `n` changelists	`p4 changes -m n`
...with a particular status (`pending` or `submitted`)	`p4 changes -s status`
...limited to those that affect particular files	`p4 changes filespec`
...limited to those that affect particular files, but including changelists that affect files which were later integrated with the named files	`p4 changes -i filespec`
...limited to changelists that affect particular files, including only those changelists between revisions `m` and `n` of these files	`p4 changes filespec#m,#n`
...limited to those that affect particular files at each files revisions between labels `lab1` and `lab2`	`p4 changes filespec@lab1,@lab2`
...limited to those between two dates.	`p4 changes @date1,@date2`


Note	There aren't many Perforce commands that allow you to use revision ranges with file specifications. Please see "Revision Ranges" on page 29 for details on revision ranges.

Files and jobs affected by changelists

To view a list of files and jobs affected by a particular changelist, along with the diffs of the new file revisions and the previous revisions, use p4 describe.

The output of p4 describe looks like this:


`Change 43 by lisag@warhols on 1997/08/29 13:41:07 Made grammatical changes to basic Elm documentation Jobs fixed ... job000001 fixed on 1997/09/29 by edk@edk Fix grammar in main Elm help file Affected files ... ... //depot/doc/elm.1#2 edit Differences ... ==== //depot/doc/elm.1#2 (text) ==== 53c53 > Way number 2, what is used common-like when, you know, like --- > The second method, which is commonly used when transmitting ...<etc.>`

This output is quite lengthy; a shortened form that eliminates the diffs can be generated with p4 describe -s changenum.


To See:	Use This Command:
...a list of files contained in a pending changelist	`p4 opened -c changelist#`
...a list of all files submitted and jobs fixed by a particular changelist, displaying the diffs between the file revisions submitted in that changelist and the previous revisions	`p4 describe changenum`
...a list of all files submitted and jobs fixed by a particular changelist, without the file diffs	`p4 describe -s changenum`
...a list of all files and jobs affected by a particular changelist, while passing the context diff flag to the underlying diff program	`p4 describe -dc changenum`
...the state of particular files at a particular changelist, whether or not these files were affected by the changelist	`p4 files filespec@changenum`

For more commands that report on jobs, see "Job Reporting" on page 81.

Labels

Reporting on labels is accomplished with a very small set of commands. The only command that reports only on labels, p4 labels, prints its output in the following format:


`Label release1.3 1997/5/18 'Created by edk' Label lisas_temp 1997/10/03 'Created by lisag' ...<etc.>`

The other label reporting commands are variations of commands we've seen earlier.


To See:	Use This Command:
...a list of all labels, the dates they were created, and the name of the user who created them	`p4 labels`
...a list of files that have been included in a particular label with `p4 labelsync`	`p4 files @labelname`
...what `p4 sync` would do when retrieving files from a particular label into your client workspace	`p4 sync -n` `@labelname`

Branch and Integration Reporting

The plural form command of branch, p4 branches, lists the different branches in the system, along with their owners, dates created, and descriptions. Separate commands are used to list files within a branched codeline, to describe which files have been integrated, and to perform other branch-related reporting. The table below describes the most commonly used commands for branch- and integration- related reporting.


To See:	Use This Command:
...a list of all branches known to the system	`p4 branches`
...a list of all files in a particular branched codeline	`p4 files` `filespec`
...what a particular `p4 integrate` variation would do, without actually doing the integrate.	`p4 integrate [args] -n [filespec]`
...a list of all the revisions of a particular file,	`p4 filelog -i` `filespec`
...what a particular `p4 resolve` variation would do, without actually doing the resolve.	`p4 resolve [args] -n [filespec]`
...a list of files that have been resolved but have not yet been submitted	`p4 resolved [filespec]`
...a list of integrated, submitted files that match the `filespec` arguments	`p4 integrated` `filespec`
...a list of all the revisions of a particular file, including revision of the file(s) it was branched from.	`p4 filelog -i` `filespec`

Job Reporting

Two commands report on jobs. The first, p4 jobs, reports on all jobs known to the system; the second command, p4 fixes, reports only on those jobs that have been attached to changelists. Both these commands have numerous options.

Basic job information

To see a list of all jobs known to the system, use p4 jobs. This command produces output similar to the following:


`job000302 on 1997/08/13 by saram open 'FROM: headers no' filter_bug on 1997/08/23 by edk 'Can't read filters w'`

Its output includes the jobs name, date entered, job owner, and the first 32 characters of the job description. The job status is included if the job is open or suspended; closed jobs are indicated by the absence of job status from the report.

All jobs known to the system are displayed unless command-line options are supplied. These options are described in the table below.


To See a List of Jobs:	Use This Command:
...including all jobs known to the server	`p4 jobs`
...including the full texts of the job descriptions	`p4 jobs -l`
...for which certain fields contain particular values (For more about jobviews, see "Viewing jobs by content with jobviews" on page 69.)	`p4 jobs -e` `jobview`
...that have been fixed by changelists that contain specific files	`p4 jobs` `filespec`
...that have been fixed by changelists that contain specific files, including changelists that contain files that were later integrated into the specified files.	`p4 jobs -i` `filespec`

Jobs, fixes, and changelists

Any jobs that have been linked to a changelist with p4 change, p4 submit, or p4 fix is said to be fixed, and can be reported with p4 fixes. The output of p4 fixes looks like this:


`job000302 fixed by change 634 on 1997/09/01 by edk@eds_mach filter_bug fixed by change 540 on 1997/10/22 by edk@eds_mach`

A number of options allow the reporting of only those changes that fix a particular job, or jobs fixed by a particular changelist, or jobs fixed by changelists that are linked to particular files.

A fixed job will not necessarily have a status of closed job, since open jobs can be linked to pending changelists, and pending jobs can be reopened even after the associated changelist has been submitted. To list jobs with a particular status, use p4 jobs.


To See a Listing of...	Use This Command:
...all fixes for all jobs	`p4 fixes`
...all changelists linked to a particular job	`p4 fixes -j jobname`
...all jobs linked to a particular changelist	`p4 fixes -c changenum`
...all jobs fixed by changelists that contain particular files	`p4 fixes filespec`
...all jobs fixed by changelists that contain particular files, including changelists that contain files that were later integrated with the specified files	`p4 fixes -i filespec`

Reporting for Daemons

The Perforce change review mechanism uses the following reporting commands. Any of these commands might also be used with user-created daemons. For further information on daemons, please see the Perforce System Administrator's Guide..


To list...	Use this Command:
...the names of all counter variables currently used by your Perforce system	`p4 counters`
...the numbers of all changelists that have not yet been reported by a particular counter variable	`p4 review -t countername`
...all users who have subscribed to review particular files	`p4 reviews filespec`
...all users who have subscribed to read any files in a particular changelist	`p4 reviews -c changenum`
...a particular user's email address	`p4 users username`

System Configuration

Three commands report on the Perforce system configuration. One command reports on all Perforce users; another prints data describing all *- client workspaces, and a third reports on Perforce depots.

p4 users generates its data as follows:


`edk <edk@eds_ws> (Ed K.) accessed 1997/07/13 lisag <lisa@lisas_ws> (Lisa G.) accessed 1997/07/14`

Each line includes a username, an email address, the user's "real" name, and the date that Perforce was last accessed by that user.

To report on client workspaces, use p4 clients:


`Client eds_elm 1997/09/12 root /usr/edk 'Ed's Elm workspace' Client lisa_doc 1997/09/13 root /usr/lisag 'Created by lisag.'`

Each line includes the client name, the date the client was last updated, the client root, and the description of the client.

Depots can be reported with p4 depots. All depots known to the system are reported on; the described fields include the depot's name, its creation date, its type (local or remote), its IP address (if remote), the mapping to the local depot, and the system administrator's description of the depot.

The use of multiple depots on a single Perforce server is discussed in the Perforce System Administrator's Guide.


To view:	Use This Command:
...user information for all Perforce users	`p4 users`
...user information for only certain users	`p4 users username`
...brief descriptions of all client workspaces	`p4 clients`
...a list of all defined depots	`p4 depots`

Special Reporting Flags

Two special flags, -o and -n, can be used with certain action commands to change their behavior from action to reporting.

The -o flag is available with most of the Perforce commands that normally bring up forms for editing. This flag tells these commands to write the form information to standard output, instead of bringing the definition into the user's editor. This flag is supported by the following commands:


`p4 branch`	`p4 client`	`p4 label`
`p4 change`	`p4 job`	`p4 user`

The -n flag prevents commands from doing their job. Instead, the commands will simply tell you what they would ordinarily do. You can use the -n flag with the following commands


`p4 integrate`	`p4 resolve`	`p4 labelsync`	`p4 sync`

Reporting with Scripting

Although Perforce's reporting commands are sufficient for most needs, there may be times when you want to view data in a format that Perforce doesn't directly support. In these situations, the reporting commands can be used in combination with scripts to print only the data that you want to see. Here are two examples.

Comparing the change content of two file sets

To compare the "change content" of two sets of files, you have to diff them externally. To do this, run p4 changes twice, once on each set of files, and then use any external diff routine to compare them.

In the following example, main represents the main codeline, and r3.2 is a codeline that was originally branched from main:


`p4 changes //depot/main/... > changes-in-main p4 changes //depot/r3.2/... > changes-in-r98.4 diff changes-in-main changes-in-r98.4`

You can use this to uncover which changes have been made to r98.4 that haven't been integrated back into main.

Changelists submitted by particular users

The p4 changes command doesn't have a flag that allows only those changes submitted by particular users to be viewed, but you can do this by grepping the output of p4 changes. For example, in the Korn shell, create an executable file with these contents:


`p4 changes \| grep '.* by '$1'@`

When this script is called with a username as an argument, only those changes created by that user will be printed.

These scripting examples are (of course!) non-exhaustive. You can use scripts whenever you want to generate reports that aren't already built into the existing Perforce commands.

Perforce 2000.2 Command Line User's Guide (2000.2.ug.1)


<< Previous Chapter Job Tracking	Table of Contents Index Perforce on the Web	Next Chapter >> Installing Perforce