<?php $isip_window_title = "ISIP Homepage"; ?>
<?php include("/data/isip/www/templates/documentation/header/header.html"); ?>

<!--#set var="isip_page_title" value="cvs" -->
<!--#include virtual="/hse/ies/templates/documentation/body/index_utility.html" -->
<?php include("/data/isip/www/templates/documentation/body/bar.html"); ?>

<a name="name">
<b>
name:
<a href="/perl/ifc_document.pl?file=$isip/util/misc/cvs/isip_commit_prep.pl">isip_commit_prep</a>,
<a href="/perl/ifc_document.pl?file=$isip/util/misc/cvs/isip_log_accum.pl">isip_log_accum</a>
</b>

<br><br>

<a name="synopsis">
<b>synopsis:</b>
<br><br>

<blockquote>
isip_commit_prep -r &lt;directory&gt; &lt;file(s)&gt;<br>
isip_log_accum -m &lt;email address&gt; '&lt;directory&gt; &lt;file(s)&gt;'<br>
</blockquote>

<a name="quick_start">
<b>quick start:</b>
<br><br>

<blockquote>
isip_commit_prep -r class/system/Integral Integral.h itgl_00.cc<br>
isip_log_accum -m checkin@isip 'class/system/Integral Integral.h itgl_00.cc'
</blockquote>

<a name="description"> 
<b>description:</b>
<br><br>

<ul>
  This directory contains the support scripts necessary for grouping
  checkin messages into more useful (and less numerous) checkin mails
  from the Concurrent Versions System (CVS). If you follow the simple
  example for checkin mail described in the CVS manual, a separate
  mail will be sent for each directory of each checkin. Needless to
  say this creates an undesirable amount of mail, since often a minor
  change will span many classes (and hence many directories).

  <br><br>

  The scripts were originally contributed to the CVS distribution by
  David Hampton (hampton@cisco.com), edited by Greg A. Woods
  (woods@web.net), and customized locally by ISIP.
  <br><br>
  
  <dl>
    <dt><a href="/perl/ifc_document.pl?file=$isip/util/misc/cvs/isip_log_accum.pl">isip_log_accum</a></dt>
    <dd>
	 Perl filter to handle the log messages from the checkin of
	 files in a directory. This script will group the lists of
	 files by log message, and mail a single consolidated log
	 message at the end of the commit.<br><br>
	 This file assumes a pre-commit checkin program that leaves
	 the names of the first and last commit directories in a
	 temporary file. </dd>
	 <br><br>
    <dt><a href="/perl/ifc_document.pl?file=$isip/util/misc/cvs/isip_commit_prep.pl">isip_commit_prep</a></dt>
    <dd>

	 Perl filter to handle pre-commit checking of files.  This
	 program records the last directory where commits will be
	 taking place for use by the log_accum.pl script.  For new
	 files, it forces the existence of a RCS "Id" keyword in the
	 first ten lines of the file.  For existing files, it checks
	 version number in the "Id" line to prevent losing changes
	 because an old version of a file was copied into the
	 diretcory.</dd>
  </dl>

</ul>

<a name="options">
<b>options:</b>
<br><br>

<ul>
  None.
</ul>       

<a name="operands">
<b>operands:</b>
<br><br>

<ul>
  None.
</ul>

<a name="examples">
<b>examples:</b>
<br><br>

<ul>
  None.
</ul>

<a name="manuals">
<b>manuals:</b>
<br><br>

<ul>
  None.
</ul>
       
<a name="languages">
<b>languages:</b>
<br><br>

<ul>
  perl.
</ul>
       
<a name="variables">
<b>environment variables:</b>
<br><br>

<ul>
  None.
</ul>

<a name="files">
<b>files:</b>
<br><br>

<ul>
  In order for checkin mail to work properly, you must configure the CVS administrative files to call these scripts. Specifically, add the following line to <a href="/perl/ifc_document.pl?file=$isip/CVSROOT/commitinfo">CVSROOT/commitinfo</a>: <ul>
    <pre>ALL     /isip/tools/bin/scripts/isip_commit_prep -r</pre>
    </ul>

    and the following line to <a href="/perl/ifc_document.pl?file=$isip/CVSROOT/loginfo">CVSROOT/loginfo</a>: <ul>
    <pre>ALL     /isip/tools/bin/scripts/isip_log_accum -m checkin %s</pre>
    </ul>
    Note that checkin is our mail alias for checkin mail (checkin@isip.msstate.edu).
</ul>
       
<a name="see_also">
<b>see also:</b>
<br><br>

<ul>
  None.
</ul>

<a name="notes">
<b>notes:</b>
<br><br>

<ul>
  None.
</ul>

<!--#include virtual="/hse/ies/templates/documentation/footer/footer.html" -->
