<?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: GenSpecMgr</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> GenSpecMgr
</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>
Generic spec manager class. Provides the base implementation for the <a
href="JobMgr.html#M000046">list_specs</a>() and <a
href="JobMgr.html#M000047">spec_file</a>() methods and a shorthand for the
update() method
</p>
</div>
<table summary="Methods" cellpadding="5" width="100%">
<tr><td class="tablesubtitle">Methods</td></tr>
</table>
<div class="name-list">
<a href="#M000018">description</a>
<a href="#M000016">list_specs</a>
<a href="#M000014">new</a>
<a href="#M000017">spec_file</a>
<a href="#M000015">update</a>
</div>
<table summary="Method list" cellpadding="5" width="100%">
<tr><td class="tablesubtitle">Public Class methods</td></tr>
</table>
<table summary="method" width="100%" cellspacing="0" cellpadding="5" border="0">
<tr><td class="methodtitle">
<a name="M000014"></a>
<b>new</b>( type, root, p4t, p4u )
</td></tr>
</table>
<div class="description">
<p>
Constructor. Provide the type of spec ("client",
"label" etc.), the client root and tagged and noon-tagged P4
client instances.
</p>
</div>
<pre class="source">
<span class="cmt"># File specsaver.rb, line 251</span>
<span class="kw">def</span> initialize( type, root, p4t, p4u )
@type = type
<span class="kw">super</span>( root, p4t, p4u )
<span class="kw">end</span>
</pre>
<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="M000015"></a>
<b>update</b>( since )
</td></tr>
</table>
<div class="description">
<p>
Shorthand wrapper around SpecMgr#update()
</p>
</div>
<pre class="source">
<span class="cmt"># File specsaver.rb, line 259</span>
<span class="kw">def</span> update( since )
<span class="kw">super</span>( @type, 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="M000016"></a>
<b>list_specs</b>()
</td></tr>
</table>
<div class="description">
<p>
Generate a list of all specs of the current type. The default
implementation just appends an "s" to the type name and uses that
as a P4 command. e.g. "p4 clients" etc. etc.
</p>
</div>
<pre class="source">
<span class="cmt"># File specsaver.rb, line 270</span>
<span class="kw">def</span> list_specs
eval( }@p4t.run_#{@type}s} )
<span class="kw">end</span>
</pre>
<table summary="method" width="100%" cellspacing="0" cellpadding="5" border="0">
<tr><td class="methodtitle">
<a name="M000017"></a>
<b>spec_file</b>( spec )
</td></tr>
</table>
<div class="description">
<p>
Map a spec type and name to a depot path where this spec will be archived.
</p>
</div>
<pre class="source">
<span class="cmt"># File specsaver.rb, line 278</span>
<span class="kw">def</span> spec_file( spec )
@root + "/#{@type}s/" + type2name( @type, spec )
<span class="kw">end</span>
</pre>
<table summary="method" width="100%" cellspacing="0" cellpadding="5" border="0">
<tr><td class="methodtitle">
<a name="M000018"></a>
<b>description</b>()
</td></tr>
</table>
<div class="description">
<p>
Provide a description for changelists and for stdout
</p>
</div>
<pre class="source">
<span class="cmt"># File specsaver.rb, line 285</span>
<span class="kw">def</span> description
"Archive updated #{@type}s"
<span class="kw">end</span>
</pre>
</body>
| # |
Change |
User |
Description |
Committed |
|
|
#1
|
3095 |
Tony Smith |
First batch of documentation for specsaver.rb |
|
|