Code Review / packages / precise / mcollective.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | review | tree
raw | inline | side by side
Update version according to OSCI-883
[packages/precise/mcollective.git] / doc / classes / MCollective / DDL / DiscoveryDDL.html
diff --git a/doc/classes/MCollective/DDL/DiscoveryDDL.html b/doc/classes/MCollective/DDL/DiscoveryDDL.html
deleted file mode 100644 (file)
index fab1db6..0000000
--- a/doc/classes/MCollective/DDL/DiscoveryDDL.html
+++ /dev/null
@@ -1,253 +0,0 @@
-<?xml version="1.0" encoding="iso-8859-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>
-  <title>Class: MCollective::DDL::DiscoveryDDL</title>
-  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
-  <meta http-equiv="Content-Script-Type" content="text/javascript" />
-  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
-  <script type="text/javascript">
-  // <![CDATA[
-
-  function popupCode( url ) {
-    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
-  }
-
-  function toggleCode( id ) {
-    if ( document.getElementById )
-      elem = document.getElementById( id );
-    else if ( document.all )
-      elem = eval( "document.all." + id );
-    else
-      return false;
-
-    elemStyle = elem.style;
-    
-    if ( elemStyle.display != "block" ) {
-      elemStyle.display = "block"
-    } else {
-      elemStyle.display = "none"
-    }
-
-    return true;
-  }
-  
-  // Make codeblocks hidden by default
-  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-  
-  // ]]>
-  </script>
-
-</head>
-<body>
-
-
-
-    <div id="classHeader">
-        <table class="header-table">
-        <tr class="top-aligned-row">
-          <td><strong>Class</strong></td>
-          <td class="class-name-in-header">MCollective::DDL::DiscoveryDDL</td>
-        </tr>
-        <tr class="top-aligned-row">
-            <td><strong>In:</strong></td>
-            <td>
-                <a href="../../../files/lib/mcollective/ddl/discoveryddl_rb.html">
-                lib/mcollective/ddl/discoveryddl.rb
-                </a>
-        <br />
-            </td>
-        </tr>
-
-        <tr class="top-aligned-row">
-            <td><strong>Parent:</strong></td>
-            <td>
-                <a href="Base.html">
-                Base
-               </a>
-            </td>
-        </tr>
-        </table>
-    </div>
-  <!-- banner header -->
-
-  <div id="bodyContent">
-
-
-
-  <div id="contextContent">
-
-    <div id="description">
-      <p>
-<a href="../DDL.html">DDL</a> for <a
-href="DiscoveryDDL.html#M000165">discovery</a> plugins, a full example can
-be seen below
-</p>
-<p>
-metadata :name =&gt; &quot;mc&quot;,
-</p>
-<pre>
-            :description =&gt; &quot;MCollective Broadcast based discovery&quot;,
-            :author      =&gt; &quot;R.I.Pienaar &lt;rip@devco.net&gt;&quot;,
-            :license     =&gt; &quot;ASL 2.0&quot;,
-            :version     =&gt; &quot;0.1&quot;,
-            :url         =&gt; &quot;http://marionette-collective.org/&quot;,
-            :timeout     =&gt; 2
-</pre>
-<p>
-<a href="DiscoveryDDL.html#M000165">discovery</a> do
-</p>
-<pre>
-    capabilities [:classes, :facts, :identity, :agents, :compound]
-</pre>
-<p>
-end
-</p>
-
-    </div>
-
-
-   </div>
-
-    <div id="method-list">
-      <h3 class="section-bar">Methods</h3>
-
-      <div class="name-list">
-      <a href="#M000164">capabilities</a>&nbsp;&nbsp;
-      <a href="#M000165">discovery</a>&nbsp;&nbsp;
-      <a href="#M000163">discovery_interface</a>&nbsp;&nbsp;
-      </div>
-    </div>
-
-  </div>
-
-
-    <!-- if includes -->
-
-    <div id="section">
-
-
-
-
-
-      
-
-
-    <!-- if method_list -->
-    <div id="methods">
-      <h3 class="section-bar">Public Instance methods</h3>
-
-      <div id="method-M000164" class="method-detail">
-        <a name="M000164"></a>
-
-        <div class="method-heading">
-          <a href="#M000164" class="method-signature">
-          <span class="method-name">capabilities</span><span class="method-args">(*caps)</span>
-          </a>
-        </div>
-      
-        <div class="method-description">
-          <p>
-records valid <a href="DiscoveryDDL.html#M000164">capabilities</a> for <a
-href="DiscoveryDDL.html#M000165">discovery</a> plugins
-</p>
-          <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000164-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000164-source">
-<pre>
-    <span class="ruby-comment cmt"># File lib/mcollective/ddl/discoveryddl.rb, line 22</span>
-22:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">capabilities</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">caps</span>)
-23:         <span class="ruby-identifier">caps</span> = [<span class="ruby-identifier">caps</span>].<span class="ruby-identifier">flatten</span>
-24: 
-25:         <span class="ruby-identifier">raise</span> <span class="ruby-value str">&quot;Discovery plugin capabilities can't be empty&quot;</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">caps</span>.<span class="ruby-identifier">empty?</span>
-26: 
-27:         <span class="ruby-identifier">caps</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">cap</span><span class="ruby-operator">|</span>
-28:           <span class="ruby-keyword kw">if</span> [<span class="ruby-identifier">:classes</span>, <span class="ruby-identifier">:facts</span>, <span class="ruby-identifier">:identity</span>, <span class="ruby-identifier">:agents</span>, <span class="ruby-identifier">:compound</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">cap</span>)
-29:             <span class="ruby-ivar">@entities</span>[<span class="ruby-identifier">:discovery</span>][<span class="ruby-identifier">:capabilities</span>] <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">cap</span>
-30:           <span class="ruby-keyword kw">else</span>
-31:             <span class="ruby-identifier">raise</span> <span class="ruby-value str">&quot;%s is not a valid capability, valid capabilities are :classes, :facts, :identity, :agents and :compound&quot;</span> <span class="ruby-operator">%</span> <span class="ruby-identifier">cap</span>
-32:           <span class="ruby-keyword kw">end</span>
-33:         <span class="ruby-keyword kw">end</span>
-34:       <span class="ruby-keyword kw">end</span>
-</pre>
-          </div>
-        </div>
-      </div>
-
-      <div id="method-M000165" class="method-detail">
-        <a name="M000165"></a>
-
-        <div class="method-heading">
-          <a href="#M000165" class="method-signature">
-          <span class="method-name">discovery</span><span class="method-args">(&amp;block)</span>
-          </a>
-        </div>
-      
-        <div class="method-description">
-          <p>
-Creates the definition for new <a
-href="DiscoveryDDL.html#M000165">discovery</a> plugins
-</p>
-<pre>
-   discovery do
-      capabilities [:classes, :facts, :identity, :agents, :compound]
-   end
-</pre>
-          <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000165-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000165-source">
-<pre>
-    <span class="ruby-comment cmt"># File lib/mcollective/ddl/discoveryddl.rb, line 41</span>
-41:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">discovery</span>(<span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
-42:         <span class="ruby-identifier">raise</span> <span class="ruby-value str">&quot;Discovery plugins can only have one definition&quot;</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@entities</span>[<span class="ruby-identifier">:discovery</span>]
-43: 
-44:         <span class="ruby-ivar">@entities</span>[<span class="ruby-identifier">:discovery</span>] = {<span class="ruby-identifier">:capabilities</span> =<span class="ruby-operator">&gt;</span> []}
-45: 
-46:         <span class="ruby-ivar">@current_entity</span> = <span class="ruby-identifier">:discovery</span>
-47:         <span class="ruby-identifier">block</span>.<span class="ruby-identifier">call</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">block_given?</span>
-48:         <span class="ruby-ivar">@current_entity</span> = <span class="ruby-keyword kw">nil</span>
-49:       <span class="ruby-keyword kw">end</span>
-</pre>
-          </div>
-        </div>
-      </div>
-
-      <div id="method-M000163" class="method-detail">
-        <a name="M000163"></a>
-
-        <div class="method-heading">
-          <a href="#M000163" class="method-signature">
-          <span class="method-name">discovery_interface</span><span class="method-args">()</span>
-          </a>
-        </div>
-      
-        <div class="method-description">
-          <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000163-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000163-source">
-<pre>
-    <span class="ruby-comment cmt"># File lib/mcollective/ddl/discoveryddl.rb, line 17</span>
-17:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">discovery_interface</span>
-18:         <span class="ruby-ivar">@entities</span>[<span class="ruby-identifier">:discovery</span>]
-19:       <span class="ruby-keyword kw">end</span>
-</pre>
-          </div>
-        </div>
-      </div>
-
-
-    </div>
-
-
-  </div>
-
-
-<div id="validator-badges">
-  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file