P4Exception.html #6

  • //
  • guest/
  • tony_smith/
  • perforce/
  • API/
  • Ruby/
  • main/
  • doc/
  • P4Exception.html
  • View
  • Commits
  • Open Download .zip Download (1 KB)
<html>
<head>
  <title>P4/Ruby</title>
  <link rel="stylesheet" type="text/css" href="docstyle.css">
</head>
<body>
  <p align="right">
    <a href="index.html">Contents</a>
  </p>

  <div class="classhdr">
    <table border=0>
      <tr>
	<td>
	  <span class="classtag">Class</span>
	  <span class="classname">P4Exception</span>
	  <span class="classparent">&lt; RuntimeError</span>
	</td>
	<td id="righttext">
	  <span class="requiretag">require</span>
	  <span class="modulename">"P4"</span>
	</td>
      </tr>
    </table>
  </div>

  <div class="classhdr">
  </div>

  <h3>Description</h3>

  Shallow subclass of RuntimeError to be used for catching Perforce specific
  errors. Doesn't contain any extra information. See 
  <a href="P4.html#errors">P4#errors</a> and
  <a href="P4.html#warnings">P4#warnings</a>
  for details of the errors giving rise to the exception.

  <div class="classmethods">
    <h3>Class Methods</h3>

    None.
  </div>


  <div class="instancemethods">
    <h3>Instance Methods</h3>

    None.
  </div>

  <h3>See Also</h3>

  <div class="seealso">
    <a href="P4.html">P4</a>
    <a href="P4DepotFile.html">P4DepotFile</a>
    <a href="P4Integration.html">P4Integration</a>
    <a href="P4Revision.html">P4Revision</a>
    <a href="P4Spec.html">P4::Spec</a>
  </div>

</body>
</html>
  


# Change User Description Committed
#6 4680 Tony Smith Make P4Ruby return new P4::Spec objects instead of plain old
hashes when parse_forms mode is in use. A P4::Spec object is derived
from Hash so should be backwards compatible with previous code.

P4::Spec provides limited fieldname validation on forms and
accessor methods for quick and easy access to the fields in the
form. The accessor methods are all prefixed with '_' to avoid
colliding with methods from the Hash parent class. This is a little
ugly, but deriving from hash is a big win, so it's worth it.

This change also fixes a minor bug found along the way. Spec parsing
and formatting wouldn't work with labels, branches, depots and groups
unless you'd previously run a P4::fetch_label( <label> ),
P4::fetch_branch( <branch> ) etc. etc. This is because the spec
parsing code internally runs one of these commands in order to grab
the specdef from the server but it wasn't providing a spec name. i.e.
it was using 'p4 client -o' and assuming that this would work for
other types of spec too. It does, but not for all spec types. So,
now the spec parsing code will use a bogus name for the spec types
that require it.
#5 4653 Tony Smith More documentation tweaks.
Just makes the pages look more
like the reference pages in the 'Pickaxe book'
#4 4652 Tony Smith Doc update for P4Ruby.
Rework the html and the CSS to make the
docs a little easier on the eye and easier to use too.
#3 4255 Tony Smith P4Ruby doc reformatting.
Now uses CSS instead of 1x1 image and too
many tables. Could no doubt be improved upon, but it's a start.
#2 2426 Tony Smith Doc beautifying for P4Ruby.
#1 1324 Tony Smith P4/Ruby documentation update.
Changed doc layout and added
in docs for newly added methods and classes.