<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<title>Perforce Public Depot: Java Reviewer Project</title>
<!-- no htdig-keywords tag in this file -->
<!-- no keywords tag in this file -->
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<link rel="stylesheet" href="../../../../css/pure.css" type="text/css">
<link rel="stylesheet" href="../../../../css/depot.css" type="text/css">
</head>
<body>
<!-- div for entire page -->
<div id="outer">
<div id="page-top"><!-- frames the logo and search -->
<!-- logo -->
<div id="logo">
<a href="http://www.perforce.com"><img src="../../../../images/site_logo.gif" alt="Perforce Public Depot" width="219" height="50"></a>
</div>
<div id="search"><!-- search section -->
<form method="get" action="http://www.google.com/search">
<div><!-- needed so invisible field will validate -->
<input type="hidden" name="sitesearch" value="public.perforce.com">
</div><!-- silly invisible field div -->
<ul class="search-box">
<li class="left"><input type="text" size="40" name="q" value="" class="search-form"></li>
<li class="middle"><input type="submit" value="Search" class="search-button"></li>
<li class="right" style="color: black;">Powered by Google</li>
</ul>
</form><!-- top navbar search form -->
</div><!-- end search section -->
</div> <!-- end div id page-top -->
<!-- start site content -->
<div id="main-body">
<!-- navbars -->
<div id="navbar-outer">
<ul class="navbar">
<li class="nav-top"><a href="../../../../index.html" title="Home">Public Depot Home</a></li>
<li><a href="../../../../sitemap.html" title="Project Tree">Project Tree</a></li>
<!-- li><a href="search.html" title="Search">Search</a></li -->
<li><a href="../../../../browse.html" title="How to Browse" >Browse</a></li>
<li><a href="../../../../contribute.html" title="How to Contribute">Contribute</a></li>
<!-- li><a href="review.html" title="Change Review Email">Change Review Email</a></li -->
</ul>
</div>
<!-- end id.navbars -->
<div id="content-outer">
<div id="content">
<!-- Content starts here -->
<h1>Perforce Java Reviewer Project<br><sub>com.perforce.reviewer.*</sub></h1>
<!-- ABOUT THIS PROJECT -->
<a name="about"></a>
<h3>About This Project</h3>
<dl class="project">
<dt>Content</dt>
<dd>
<p>
<a href="http://public.perforce.com:8080/@ra=s@/guest/david_markley/reviewer/">Source</a>, <a href="dist/docs/index.html">documentation</a>, and
<a href="dist/reviewer.jar">JAR</a> for the Perforce Java Reviewer, a Java API-based extensible perforce server changelist reviewer. The package provide
a Reviewer class and a ChangeListener interface. The Reviewer class monitors changes submitted to the perforce server and calls the appropriate
ChangeListener implementation. A default mailer implementation is included.
</p>
</dd>
<dt>Curator</dt>
<dd>
<p>
David Markley. Please email <a href="mailto:david@markley.cc">david@markley.cc</a> if you have submitted contributions you'd like published,
if you have ideas for enhancement, or if you have preferences among the potential enhancements listed below.
</p>
</dd>
<dt>Getting Started</dt>
<dd>
<p>
The default action taken on each changelist is to send e-mail to those users who's Reviews specification matches the current change. The e-mail sent
out will contain both a text-only and HTML version of the information. This has been very useful for including links to additional information. The
format of the message can be modified in the <a href="dist/docs/com/perforce/reviewer/doc-files/reviewer.conf">configuration file</a>.
</p>
<p>
To run the reviewer you must have the <a href="http://java.sun.com/products/javamail">JavaMail</a> and
<a href="http://java.sun.com/products/javabeans/glasgow/jaf.html">Activation</a> packages from Sun. When you have downloaded them,
make sure mail.jar, activation.jar, and p4.jar (from the <a href="http://public.perforce.com/public/perforce/api/java/p4package/index.html">
Perforce Java API</a>) are in the same directory as the <a href="dist/reviewer.jar">reviewer.jar</a>
</p>
<p>
You will need to create a counter that the reviewer will use to monitor changes submitted to the perforce server. The default name the reviewer will
use is 'review'. <span class="redtxt">Make sure that the value of this counter is set to the current value of the 'change' counter. If you do not do
this, be prepared to face angry users when they receive e-mail for every change in your server!</span> To create and set the counter, you should
execute the following steps:
</p>
<pre>
% p4 counters
change = 1669
job = 21
journal = 46
% p4 counter review 1669
Counter review set.
% p4 counters
change = 1669
job = 21
journal = 46
review = 1669
</pre>
<p>
Notice that the value for the 'change' counter is used to set the 'review' counter.</p>
<p>
Before running the reviewer, you will need to modify its <a href="dist/docs/com/perforce/reviewer/doc-files/reviewer.conf">configuration file</a>.
That file contains documenation on the each of the parameters that can be specified. Save the file to /etc and modify it to fit your local environment.
</p>
<p>
As part of the reviwer.jar file, this application can be started on the command line with Java 1.2 or better using the format:</p>
<pre> java -jar reviewer.jar /etc/reviewer.conf & </pre>
<p>
The <a href="dist/docs/com/perforce/reviewer/doc-files/reviewer.conf">configuration file</a> is the only argument accepted on the command line.
This file specifies the Perforce environment and how each changelist is handled.
</p>
</dd>
</dl>
<!-- QUICKLINKS -->
<div class="quickLinks">
<ul>
<li><a href="#about">About<br>Project</a></li>
<li><a href="http://public.perforce.com:8080/@ra=s@/guest/david_markley/reviewer/">Source<br>Files</a></li>
<li><a href="dist/reviewer.jar">JAR<br>File</a></li>
<li><a href="dist/docs/index.html">API<br>Documentation</a></li>
<li><a href="http://public.perforce.com/public/perforce/api/java/p4package/index.html">P4Package<br>Project</a></li>
<li><a href="dist/docs/com/perforce/reviewer/doc-files/LICENSE.TXT"><br>LICENSE.TXT</a></li>
<li><a href="#updates">Project<br>Updates</a></li>
</ul>
</div>
<!-- SOURCE FILES -->
<a name="http://public.perforce.com:8080/@ra=s@/guest/david_markley/reviewer/"></a>
<h3>Source Files</h3>
<dl class="srcfiles">
<dd>
Click <a href="http://public.perforce.com:8080/@ra=s@/guest/david_markley/reviewer/">here</a> to access source files by David Markley.
</dd>
</dl>
<!-- JAR FILE -->
<a name="dist/reviewer.jar"></a>
<h3>JAR File</h3>
<dl class="jarfile">
<dd>
Click <a href="dist/reviewer.jar">here</a> for the Java Archive File (JAR File).
</dd>
</dl>
<!-- API DOCUMENTATION -->
<a name="dist/docs/index.html"></a>
<h3>API Documentation</h3>
<dl class="apidoc">
<dd>
Click <a href="dist/docs/index.html">here</a> for Package com.perforce.reviewer Documentation.
</dd>
</dl>
<!-- P4PACKAGE PROJECT -->
<a name="http://public.perforce.com/public/perforce/api/java/p4package/index.html"></a>
<h3>P4Package Project</h3>
<dl class="p4packproj">
<dd>
Click <a href="http://public.perforce.com/public/perforce/api/java/p4package/index.html">here</a> for the P4Package Java API Project.
</dd>
</dl>
<!-- LICENSE.TXT -->
<a name="dist/docs/com/perforce/reviewer/doc-files/LICENSE.TXT"></a>
<h3>LICENSE.TXT</h3>
<dl class="licensetxt">
<dd>
Click <a href="dist/docs/com/perforce/reviewer/doc-files/LICENSE.TXT">here</a> for the license text.
</dd>
</dl>
<!-- PROJECT UPDATES -->
<a name="#updates"></a>
<h3>Project Updates</h3>
<dl class="projupdates">
<dd>
<table class="proj update" cellspacing="0">
<tr>
<th>Date</th>
<th>Update</th>
</tr>
<tr class="zebra">
<td>April 23, 2002
</td>
<td>
Initial publication of the Java Reviewer.
</td>
</tr>
<tr>
<td>
August 12, 2002
</td>
<td>
<ul>
<li>Added support for jobs fixed.</li>
<li>Corrected problems with missing formats in the configuration file.</li>
</ul>
</td>
</tr>
</table>
</dd>
</dl>
<div class="hr-dotted"></div>
<p class="stored-file">You're browsing a file stored as <code>$Id: //public/perforce/api/index.html#6 $</code>
</p>
<!-- Content ends here -->
</div><!-- id content -->
</div><!-- id content-outer -->
</div><!-- id main-body -->
<!-- Copyright and bottom bar -->
<div id="copyright">
Copyright © 2001 Perforce
</div>
</div> <!-- id outer -->
</body>
</html>
| # | Change | User | Description | Committed | |
|---|---|---|---|---|---|
| #1 | 6476 | Marc Wensauer | Initial branch of reviewd tree to work on | ||
| //guest/perforce_software/utils/reviewd/reviewer/index.html | |||||
| #7 | 6073 | michael | Fix relative links on menus. | ||
| #6 | 6072 | michael |
Updated source link. Fixed a couple of typos. |
||
| #5 | 6026 | rlo |
Public depot fixes: * Titles formatted similarly * Navbar changed and shortened * Change review taken out of navbar * Links fixed |
||
| #4 | 6025 | rlo |
Public Depot Redesign goes live * Skin matches KB and latest WWW skin * Rudimentary search mechanism based on google * did this already, but made some big mistakes and it was easier to obliterate and start over * about the above: yikes! |
||
| #3 | 2021 | David Markley | Integrated reviewer changes to the public depot. | ||
| #2 | 1700 | David Markley | Integrated spelling correction to public depot for test. | ||
| #1 | 1682 | rmg | Add David's Java Reviewer to //public. | ||
| //guest/david_markley/reviewer/index.html | |||||
| #1 | 1671 | David Markley | Added the Java Reviewer main page. | ||