HelixWebServices.html #1 

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>
  Module: HelixWebServices
  
    &mdash; Documentation by YARD 0.8.7.6
  
</title>

  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />

  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />

<script type="text/javascript" charset="utf-8">
  hasFrames = window.top.frames.main ? true : false;
  relpath = '';
  framesUrl = "frames.html#!HelixWebServices.html";
</script>


  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>

  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>


  </head>
  <body>
    <div id="header">
      <div id="menu">
  
    <a href="_index.html">Index (H)</a> &raquo;
    
    
    <span class="title">HelixWebServices</span>
  

  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>

      <div id="search">
  
    <a class="full_list_link" id="class_list_link"
        href="class_list.html">
      Class List
    </a>
  
    <a class="full_list_link" id="method_list_link"
        href="method_list.html">
      Method List
    </a>
  
    <a class="full_list_link" id="file_list_link"
        href="file_list.html">
      File List
    </a>
  
</div>
      <div class="clear"></div>
    </div>

    <iframe id="search_frame"></iframe>

    <div id="content"><h1>Module: HelixWebServices
  
  
  
</h1>

<dl class="box">
  
  
    
  
    
  
  
  
    <dt class="r1 last">Defined in:</dt>
    <dd class="r1 last">lib/helix_web_services/version.rb<span class="defines">,<br />
  lib/helix_web_services.rb,<br /> lib/helix_web_services/version.rb,<br /> lib/helix_web_services/build_version.rb</span>
</dd>
  
</dl>
<div class="clear"></div>

<h2>Overview</h2><div class="docstring">
  <div class="discussion">
    
<p>Version strings in HWS</p>

<p>The main “Ruby” string is a legal version of our “Product Release
Identification Standard”:</p>

<p><a
href="https://confluence.perforce.com:8443/display/EN/Product+Release+Identification+Standards">confluence.perforce.com:8443/display/EN/Product+Release+Identification+Standards</a></p>

<p>A few notes:</p>
<ol><li>
<p>While HWS does build for different OSes, it does not have an explicit 
architecture. So we use "NOARCH".</p>
</li><li>
<p>The "Product ID" is currently "HWS".</p>
</li><li>
<p>We do include the date and changelist of the <em>tarball</em>.</p>
</li></ol>

<p>An official verison may be: HWS/NOARCH/2015.1/123456 (2015/08/17)</p>

<p>A pre-release version will include information in the middle:</p>

<p>HWS/NOARCH/2015.1.MAIN-TEST_ONLY/123456 (2015/08/17)</p>

<p>For Ruby, the version string will be [<a
href="REV">YEAR].</a>.[CHANGELIST]. Preleases will have a branch specifier:
[<a href="REV">YEAR].</a>.<a href="branch">0.</a>[CHANGELIST].</p>

<p>Ergo, a Ruby version string will look like 2015.1.0.main123456</p>

<p>These strings are either defined in a file <code>./build_version.rb</code>.</p>


  </div>
</div>
<div class="tags">
  

</div><h2>Defined Under Namespace</h2>
<p class="children">
  
    
      <strong class="modules">Modules:</strong> <span class='object_link'><a href="HelixWebServices/ErrorHandling.html" title="HelixWebServices::ErrorHandling (module)">ErrorHandling</a></span>
    
  
    
      <strong class="classes">Classes:</strong> <span class='object_link'><a href="HelixWebServices/Master.html" title="HelixWebServices::Master (class)">Master</a></span>
    
  
</p>

  <h2>Constant Summary</h2>
  
    <dl class="constants">
      
        <dt id="VERSION-constant" class="">VERSION =
          
        </dt>
        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>2015.1.0.main</span><span class='tstring_end'>&#39;</span></span></pre></dd>
      
        <dt id="PRODUCT_ID-constant" class="">PRODUCT_ID =
          
        </dt>
        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>HWS/NOARCH/2015.1.main/201509150120</span><span class='tstring_end'>&#39;</span></span></pre></dd>
      
    </dl>
  









</div>

    <div id="footer">
  Generated on Tue Sep 15 01:20:28 2015 by
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
  0.8.7.6 (ruby-2.2.3).
</div>

  </body>
</html>
# Change User Description Committed
#1 15741 ptomiak Branch HWS for my use.