P4Triggers_rb.html #1 

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>File: P4Triggers.rb</title>
  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
  <link rel=StyleSheet href=".././rdoc-style.css" type="text/css" media="screen" />
  <script type="text/javascript" language="JavaScript">
  <!--
  function popCode(url) {
    window.open(url, "Code", 
          "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
  }
  //-->
  </script>
</head>

<body bgcolor="white">
<table summary="Information on file" width="100%">
 <tr class="title-row">
 <td><table summary="layout" width="100%"><tr>
   <td class="big-title-font" colspan="2">P4Triggers.rb</td>
   <td align="right"><table summary="layout" cellspacing="0" cellpadding="2">
         <tr>
           <td  class="small-title-font">Path:</td>
           <td class="small-title-font">P4Triggers.rb</td>
         </tr>
         <tr>
           <td class="small-title-font">Modified:</td>
           <td class="small-title-font">Fri Sep 26 16:25:01 BST 2003</td>
         </tr>
        </table>
    </td></tr></table></td>
  </tr>
</table>
  <!-- banner header -->



<div class="description"><h1>Introduction</h1>
<h2>Name: P4Triggers.rb</h2>
<h2>Author: Tony Smith &lt;tony@perforce.com&gt;</h2>
<h2>Description</h2>
<pre>
    A library for use when writing Perforce triggers. Methods and classes
    common to all my example triggers are to be found in here. The framework
    for a trigger is very simple:

    1. You derive your trigger class from P4Trigger
    2. You implement the validate() method to decide whether or not to
       allow the submit
    3. You send output to the user using the message() method
    4. You raise exceptions to report runtime errors P4Exceptions are
       already handled for you.
    5. Your trigger script should call P4Trigger#parse_change() and should use
       the value returned as its exit status.
</pre>
<pre>
    And that's all there is to it!

    The P4Change class merits some familiarisation because objects of this
    class are what you get when you call P4Trigger#change() and it's a
    very convenient way to examine the changelist being submitted.
</pre>
<pre>
    If you're just getting started with this framework, start by looking at
    the P4Trigger class and then look at P4Change.
</pre>
</div>





<table summary="List of classes" cellpadding="5" width="100%">
<tr><td class="tablesubtitle">Classes and Modules</td></tr>
</table>
<div class="classlist">
Class <a href="../classes/FileType.html" class="link">FileType</a><br />
Class <a href="../classes/P4.html" class="link">P4</a><br />
Class <a href="../classes/P4Change.html" class="link">P4Change</a><br />
Class <a href="../classes/P4Trigger.html" class="link">P4Trigger</a><br />

</div>



</body>
</html>
# Change User Description Committed
#3 4654 Tony Smith Add an example spec trigger to show how you might restrict the
default view for all new clients to a pre-defined set of
mappings.
#2 4640 Tony Smith Add a sample post-commit trigger that can be used to keep a master
and slave branch in sync.
#1 3637 Tony Smith Add RDoc documentation to the sample triggers.