Helix SwarmHelix Swarm

P4Exception.html

  • //
  • guest/
  • tony_smith/
  • perforce/
  • API/
  • Ruby/
  • main/
  • doc/
  • P4Exception.html #6
  • View
  • Commits
  • Open Download .zip Download (1 KB) 
  1. <html>
  2. <head>
  3.   <title>P4/Ruby</title>
  4.   <link rel="stylesheet" type="text/css" href="docstyle.css">
  5. </head>
  6. <body>
  7.   <p align="right">
  8.     <a href="index.html">Contents</a>
  9.   </p>
  10.  
  11.   <div class="classhdr">
  12.     <table border=0>
  13.       <tr>
  14. 	<td>
  15. 	  <span class="classtag">Class</span>
  16. 	  <span class="classname">P4Exception</span>
  17. 	  <span class="classparent">&lt; RuntimeError</span>
  18. 	</td>
  19. 	<td id="righttext">
  20. 	  <span class="requiretag">require</span>
  21. 	  <span class="modulename">"P4"</span>
  22. 	</td>
  23.       </tr>
  24.     </table>
  25.   </div>
  26.  
  27.   <div class="classhdr">
  28.   </div>
  29.  
  30.   <h3>Description</h3>
  31.  
  32.   Shallow subclass of RuntimeError to be used for catching Perforce specific
  33.   errors. Doesn't contain any extra information. See 
  34.   <a href="P4.html#errors">P4#errors</a> and
  35.   <a href="P4.html#warnings">P4#warnings</a>
  36.   for details of the errors giving rise to the exception.
  37.  
  38.   <div class="classmethods">
  39.     <h3>Class Methods</h3>
  40.  
  41.     None.
  42.   </div>
  43.  
  44.  
  45.   <div class="instancemethods">
  46.     <h3>Instance Methods</h3>
  47.  
  48.     None.
  49.   </div>
  50.  
  51.   <h3>See Also</h3>
  52.  
  53.   <div class="seealso">
  54.     <a href="P4.html">P4</a>
  55.     <a href="P4DepotFile.html">P4DepotFile</a>
  56.     <a href="P4Integration.html">P4Integration</a>
  57.     <a href="P4Revision.html">P4Revision</a>
  58.     <a href="P4Spec.html">P4::Spec</a>
  59.   </div>
  60.  
  61. </body>
  62. </html>
  63.   
  64.  
  65.  
# 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. «		 20 years ago
#5 4653 Tony Smith More documentation tweaks.
Just makes the pages look more
like the reference pages in the... 'Pickaxe book' «		 20 years ago
#4 4652 Tony Smith Doc update for P4Ruby.
Rework the html and the CSS to make the
docs a little easier on t...he eye and easier to use too. «		 20 years ago
#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. «		 21 years ago
#2 2426 Tony Smith Doc beautifying for P4Ruby. 22 years ago
#1 1324 Tony Smith P4/Ruby documentation update.
Changed doc layout and added
in docs for newly added method...s and classes. «		 23 years ago