BranchMgr.html #1

  • //
  • guest/
  • tony_smith/
  • perforce/
  • utils/
  • doc/
  • specsaver/
  • classes/
  • BranchMgr.html
  • View
  • Commits
  • Open Download .zip Download (4 KB)
<?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">
<html><head>
  <title>Class: BranchMgr</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 class" width="100%" border="0" cellspacing="0">
 <tr class="title-row">
 <td class="big-title-font">
   <sup><font color="aqua">Class</font></sup> BranchMgr
 </td>
 <td align="right">
   <table summary="layout" cellspacing="0" cellpadding="2">
     <tr valign="top">
      <td class="small-title-font">In:</td>
      <td class="small-title-font">
        <a href="../files/specsaver_rb.html" class="aqua">
specsaver.rb
         </a>
<br />
      </td>
     </tr>
     <tr>
      <td class="small-title-font">Parent:</td>
      <td class="small-title-font">
        <a href="SpecMgr.html" class="aqua">
SpecMgr
         </a>
      </td>
     </tr>
   </table>
  </td>
  </tr>
</table>
  <!-- banner header -->



<div class="description"><p>
<a href="SpecMgr.html">SpecMgr</a> subclass for Branches. As the plural of
branch is branchES, this needs slightly different handling so it's derived
from <a href="SpecMgr.html">SpecMgr</a>, rather than <a
href="GenSpecMgr.html">GenSpecMgr</a>
</p>
</div>


<table summary="Methods" cellpadding="5" width="100%">
<tr><td class="tablesubtitle">Methods</td></tr>
</table>
<div class="name-list">
<a href="#M000005">description</a>&nbsp; &nbsp;
<a href="#M000003">list_specs</a>&nbsp; &nbsp;
<a href="#M000004">spec_file</a>&nbsp; &nbsp;
<a href="#M000002">update</a>&nbsp; &nbsp;
</div>




<table summary="Method list" cellpadding="5" width="100%">
<tr><td class="tablesubtitle">Public Instance methods</td></tr>
</table>
<table summary="method"  width="100%" cellspacing="0" cellpadding="5" border="0">
<tr><td class="methodtitle">
<a name="M000002"></a>
<b>update</b>( since )
</td></tr>
</table>
<div class="description">
<p>
Main interface method. Nothing special required, just shorthand for the <a
href="SpecMgr.html">SpecMgr</a> implementation.
</p>
</div>
<pre class="source">
<span class="cmt"># File specsaver.rb, line 477</span>
    <span class="kw">def</span> update( since )
	<span class="kw">super</span>( <span class="str">&quot;branch&quot;</span>, since )
    <span class="kw">end</span>
</pre>
<table summary="Method list" cellpadding="5" width="100%">
<tr><td class="tablesubtitle">Protected Instance methods</td></tr>
</table>
<table summary="method"  width="100%" cellspacing="0" cellpadding="5" border="0">
<tr><td class="methodtitle">
<a name="M000003"></a>
<b>list_specs</b>()
</td></tr>
</table>
<div class="description">
<p>
Generate a list of branchspecs using &quot;p4 branches&quot;
</p>
</div>
<pre class="source">
<span class="cmt"># File specsaver.rb, line 486</span>
    <span class="kw">def</span> list_specs
	@p4t.run_branches
    <span class="kw">end</span>
</pre>
<table summary="method"  width="100%" cellspacing="0" cellpadding="5" border="0">
<tr><td class="methodtitle">
<a name="M000004"></a>
<b>spec_file</b>( spec )
</td></tr>
</table>
<div class="description">
<p>
Map a branchspec to a depot path.
</p>
</div>
<pre class="source">
<span class="cmt"># File specsaver.rb, line 493</span>
    <span class="kw">def</span> spec_file( spec )
	@root + <span class="str">&quot;/branches/&quot;</span> + spec[ <span class="str">&quot;branch&quot;</span> ] 
    <span class="kw">end</span>
</pre>
<table summary="method"  width="100%" cellspacing="0" cellpadding="5" border="0">
<tr><td class="methodtitle">
<a name="M000005"></a>
<b>description</b>()
</td></tr>
</table>
<div class="description">
<p>
Provide the description for changelist and stdout
</p>
</div>
<pre class="source">
<span class="cmt"># File specsaver.rb, line 500</span>
    <span class="kw">def</span> description
	<span class="str">&quot;Archive updated branches&quot;</span>
    <span class="kw">end</span>
</pre>

</body>
# Change User Description Committed
#1 3095 Tony Smith First batch of documentation for specsaver.rb