Perforce Utilities Project

About This Project

Content

The Perforce Utilities Project is a collection of programs and scripts that integrate Perforce with a variety of software development tools and environments, and/or provide alternative interfaces to the Perforce SCM system.

Curator

This project is maintained by Perforce staff, with individual curators as shown below. Eventually we'll split these utilities up into separate projects, depending on their activity and growth. If you have a particular interest in any or all of this project, and would like to volunteer as a curator, please email us.

If you would like to contribute to one of the categories that does not have a curator yet, you may request to have your submitted changes integrated into this project by emailing Perforce staff at opensource@perforce.com.

Depot
Browsers
Conversion
Scripts
Review
Daemons
Pre-Submit
Triggers
Diffing and
Merging
Compatibility
Aids
Misc.

Depot Browsers

//public/perforce/utils/perfbrowse/...: perfbrowse. Shows depot hierarchies, changelists, filelogs, file contents, diffs, etc. There's a 99.1-compatible version and a 98.2-compatible version.
//public/perforce/utils/p4db/...: P4DB. Based on perfbrowse, with added features, including labels associated with files, file content viewer with annotated deltas, HTML file viewer, and The Great Submit Race.

Conversion Scripts

//public/perforce/utils/cvs2p4/...: This CVS to Perforce converter extracts metadata from a CVS repository and generates a Perforce depot using Perforce client commands. The converter handles Attic/ and .cvsignore, and has flexible support for branching. Contributed by Richard Geiger, who is also its curator. (See the README file for more info.)
//public/perforce/utils/vsstop4/...: Converts Visual Source Safe (VSS) archives to Perforce, preserving the original times and authors. Branches are translated verbatim, individual file revisions are grouped as much as possible into Perforce's notion of atomic changelists.
//public/perforce/utils/pvcstop4/...: Converts PVCS archives to Perforce, preserving the original times and authors. Branches are translated verbatim, individual file revisions are grouped as much as possible into Perforce's notion of atomic changelists.
Both the VSS and PVCS conversion projects are curated by Robert Cowham.

Review Daemons

//public/perforce/utils/reviewd/p4review.py: A Perforce notification review daemon written in Python, for use on Windows or Unix; can run in the background or via cron; allows users to subscribe to notifications about jobs (as well as changes); can notify admin about bad email addresses.
//public/perforce/utils/reviewd/p4notifyd.pl: A Perforce notification review daemon for Unix, written in Perl. This is the review daemon used for the Public Depot. Runs on Unix; written in perl; can run in the background or via cron; supports "cc:" in the description or client spec; can do logging; can add a hyperlinks to p4web (or some other web-based Perforce browser) to display full change information.
//public/perforce/utils/reviewd/reviewer/...: A Perforce notification review daemon in Java. Contributed by David Markley.

Pre-Submit Triggers

//public/perforce/utils/triggers/...: Perforce Release 99.1 introduced server support for pre-submit triggers. Here are some example scripts that can be used as triggers in a Perforce 99.1 (or later) server. These scripts were written and contributed by Jeff Bowles and Wes Peters.

Script Name	Status*	Description
Jobs.pl		Example trigger to enforce a rule "submissions must be associated with a job.".
Jobs.sh		Similar to above, but contributed by Wes Peters and written in Unix "shell". Takes a different approach to the problem, running "p4 fixes" to determine whether you're fixing something with this submission.
CheckC.pl		Use this script when you're creating new files,or integrating to a new branch, and the directory name you're writing the new file to isn't the same case as an existing directory name. For example, without using this script, if `/depot/x/y/z.c` exists, by default you won't be able to create a file named `/depot/X/Y/one.c`.
Pairs.pl		Example trigger to enforce a rule "files of suffix .x/.y need to be checked in as pairs".
Binary.pl		Example trigger to enforce a rule "submissions of .gif must binary files and .sh files should be text and...."
simple.cmd		Classroom example of writing a trigger using the Windows/NT command shell, a.k.a. "a .cmd script". (It checks that "Bug:" is included in the change description.) Doesn't do a lot, but gets the idea across.

* How to interpret the "Status" field:

Smiley Face: it's probably simple enough to use without any worries that it'll corrupt or slow down anything;
Scared face:: you probably want to read the comments at the top of the script - this might need localization/tailoring or might have performance implications you want to investigate before deploying on your production Perforce server;
Under construction: you can look, you can make copies, but it's getting reworked at the moment.

Diffing and Merging

//public/perforce/utils/emacs_mrg/...: Some emacs lisp code to make editing merges in p4 easier.

Compatibility Aids

//public/perforce/utils/c4/...: c4. A CVS-like frontend to p4. This package was contributed by Neil Russell, who is also its curator. (See the README file for more info.)
//public/perforce/utils/aegis/...: Aegis-like wrappers to p4.

Miscellany

//public/perforce/utils/p4wrapper/...: p4wrapper. A set of useful commands wrapped around p4, some (but not all) with a CVS bent. Contributed and curated by Rick Richardson. (See the README file for more info.)

You're browsing a file stored as $Id: //guest/perforce_software/utils/index.html#32 $