index.html #1

<HTML>
<HEAD>
<TITLE>Perforce Java Reviewer Project</TITLE>
</HEAD>

<BODY BGCOLOR="#FFFFFF"><CENTER>
<P>
<A NAME="toc"></A>
<h2>
<sub><a href="http://public.perforce.com/public/index.html">Perforce Public Depot</a></sub><br>
Perforce Java Reviewer Project<br>
<sub>com.perforce.reviewer.*</sub>
</H2>
<P>

<TABLE BORDER=0><TR><TD>
<B><UL>
<LI><A HREF="#about">About This Project</A>
<LI><A href="http://public.perforce.com:8080/@ra=s@/guest/david_markley/reviewer/">Source Files</A>
<LI><A href="dist/reviewer.jar">JAR File</A>
<LI><A HREF="dist/docs/index.html">API Documentation</A>
</UL></B></TD>
<TD valign="top"><B><UL>
<LI><A HREF="http://public.perforce.com/public/perforce/api/java/p4package/index.html">P4Package Project</A>
<LI><A HREF="dist/docs/com/perforce/reviewer/doc-files/LICENSE.TXT">LICENSE.TXT</A>
<LI><A HREF="#updates">Project Updates</A>
</UL></B>
</TABLE>
</CENTER>

<!------------------------------------------------------------------>
<P>
<TABLE CELLSPACING=0 BORDER=0 WIDTH=100%><TR><TD BGCOLOR=FFCC66>

<A NAME="about"></A>
<H2>About This Project
</H2>

<TD WIDTH=5% BGCOLOR=FFCC66 ALIGN=RIGHT><FONT SIZE="-2"><A HREF="#toc">
Back to<BR>Table of<BR>Contents</A></TD></TR>
</TABLE>
<!------------------------------------------------------------------>
<p>
<table cellpadding=5%>
<tr><td align="right" valign=top><b>Content</b></td>
<td valign=top>
<A href="http://public.perforce.com:8080/@ra=s@/public/perforce/api/java/reviewer/">Source</A>, <A HREF="dist/docs/index.html">documentation</A>, and <A href="dist/reviewer.jar">JAR</A> for the Perforce Java Reviwer, 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.
</td></tr>
<tr><td align="right" valign=top><b>Curator</b></td>
<td valign=top>
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.
</td></tr>
<tr><td align="right" valign=top nowrap><b>Getting Started</b></td>
<td valign=top>
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>
To run the reviewer you must have the <a target="_top" href="http://java.sun.com/products/javamail">JavaMail</a> and <a target="_top" 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>
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'. <font color="red">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!</font> To create and set the counter, you should execute the following steps:
<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>
Notice that the value for the 'change' counter is used to set the 'review' counter.
<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>
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:
<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.
</td></tr>
</table>
<!------------------------------------------------------------------>
<P>
<TABLE CELLSPACING=0 BORDER=0 WIDTH=100%><TR><TD BGCOLOR=FFCC66>

<A NAME="updates"></A>
<H2>Project Updates</H2>

<TD BGCOLOR="FFCC66" ALIGN="RIGHT"><FONT SIZE="-2"><A HREF="#toc">
Back to<BR>Table of<BR>Contents</A></TD></TR>
</TABLE>
<!------------------------------------------------------------------>
<table width="100%" border="1">
<thead><tr><th valign="top">Date</th><th valign="top" width="70%">Update</th></tr></thead>
<tbody>
<tr><td nowrap="t" valign="top"><b>April 23, 2001</b></td><td width="70%" valign="top">
Initial publication of the Java Reviewer.
</td></tr>
</tbody></table>
<br><br>
<!------------------------------------------------------------------>
<P>
<TABLE CELLSPACING=0 BORDER=0 WIDTH=100%>
<TR>

<TD WIDTH=15% BGCOLOR=FFCC66 ALIGN=LEFT VALIGN=CENTER>
<FONT SIZE="-2">
Copyright &copy;<br>
2001<br>
<a href="http://www.perforce.com">Perforce Software</a><br>
</FONT>
</TD>

<TD WIDTH=70% BGCOLOR=FFCC66 ALIGN=CENTER>
<FONT SIZE="-2">
You're browsing a file stored as<br> 
<code>$Id: //public/perforce/api/index.html#6 $</code><br> 
in the 
<A HREF=http://public.perforce.com/public/index.html>Perforce Public Depot</A>.
</FONT>
</TD>

<TD WIDTH=15% BGCOLOR=FFCC66 ALIGN=RIGHT>
<FONT SIZE="-2"><A HREF="#toc">
Back to<BR>Table of<BR>Contents</A></TD></TR>
</FONT>
</TD>

</TR>
</TABLE>
<!------------------------------------------------------------------>
</BODY>
#	Change	User	Description
#1	1985	Sean Nolan	my initial branch
//guest/perforce_software/utils/reviewd/reviewer/index.html
#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.