Update version according to OSCI-883
[packages/precise/mcollective.git] / doc / Rakefile.html
diff --git a/doc/Rakefile.html b/doc/Rakefile.html
new file mode 100644 (file)
index 0000000..c7c43ef
--- /dev/null
@@ -0,0 +1,503 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+       "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+       <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
+
+       <title>File: Rakefile [mcollective version 2.3.3]</title>
+
+       <link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet" />
+
+       <script src="./js/jquery.js" type="text/javascript"
+               charset="utf-8"></script>
+       <script src="./js/thickbox-compressed.js" type="text/javascript"
+               charset="utf-8"></script>
+       <script src="./js/quicksearch.js" type="text/javascript"
+               charset="utf-8"></script>
+       <script src="./js/darkfish.js" type="text/javascript"
+               charset="utf-8"></script>
+</head>
+
+<body class="file">
+       <div id="metadata">
+               <div id="project-metadata">
+                       
+                       
+                       <div id="fileindex-section" class="section project-section">
+                               <h3 class="section-header">Files</h3>
+                               <ul>
+                               
+                                       <li class="file"><a href="./COPYING.html">COPYING</a></li>
+                               
+                                       <li class="file"><a href="./Gemfile.html">Gemfile</a></li>
+                               
+                                       <li class="file"><a href="./README.html">README</a></li>
+                               
+                                       <li class="file"><a href="./Rakefile.html">Rakefile</a></li>
+                               
+                                       <li class="file"><a href="./etc/client_cfg_dist.html">client.cfg.dist</a></li>
+                               
+                                       <li class="file"><a href="./etc/data-help_erb.html">data-help.erb</a></li>
+                               
+                                       <li class="file"><a href="./etc/discovery-help_erb.html">discovery-help.erb</a></li>
+                               
+                                       <li class="file"><a href="./etc/facts_yaml_dist.html">facts.yaml.dist</a></li>
+                               
+                                       <li class="file"><a href="./etc/metadata-help_erb.html">metadata-help.erb</a></li>
+                               
+                                       <li class="file"><a href="./etc/msg-help_erb.html">msg-help.erb</a></li>
+                               
+                                       <li class="file"><a href="./etc/rpc-help_erb.html">rpc-help.erb</a></li>
+                               
+                                       <li class="file"><a href="./etc/server_cfg_dist.html">server.cfg.dist</a></li>
+                               
+                                       <li class="file"><a href="./etc/ssl/PLACEHOLDER.html">PLACEHOLDER</a></li>
+                               
+                                       <li class="file"><a href="./etc/ssl/clients/PLACEHOLDER.html">PLACEHOLDER</a></li>
+                               
+                                       <li class="file"><a href="./lib/mcollective/generators/templates/action_snippet_erb.html">action_snippet.erb</a></li>
+                               
+                                       <li class="file"><a href="./lib/mcollective/generators/templates/data_input_snippet_erb.html">data_input_snippet.erb</a></li>
+                               
+                                       <li class="file"><a href="./lib/mcollective/generators/templates/ddl_erb.html">ddl.erb</a></li>
+                               
+                                       <li class="file"><a href="./lib/mcollective/generators/templates/plugin_erb.html">plugin.erb</a></li>
+                               
+                                       <li class="file"><a href="./lib/mcollective/locales/en_yml.html">en.yml</a></li>
+                               
+                                       <li class="file"><a href="./mcollective_init.html">mcollective.init</a></li>
+                               
+                               </ul>
+                       </div>
+                       
+
+                       <div id="classindex-section" class="section project-section">
+                               <h3 class="section-header">Class Index
+                                       <span class="search-toggle"><img src="./images/find.png"
+                                               height="16" width="16" alt="[+]"
+                                               title="show/hide quicksearch" /></span></h3>
+                               <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
+                               <fieldset>
+                                       <legend>Quicksearch</legend>
+                                       <input type="text" name="quicksearch" value=""
+                                               class="quicksearch-field" />
+                               </fieldset>
+                               </form>
+
+                               <ul class="link-list">
+                               
+                                       <li><a href="./MCollective.html">MCollective</a></li>
+                               
+                                       <li><a href="./MCollective/Agent.html">MCollective::Agent</a></li>
+                               
+                                       <li><a href="./MCollective/Agents.html">MCollective::Agents</a></li>
+                               
+                                       <li><a href="./MCollective/Aggregate.html">MCollective::Aggregate</a></li>
+                               
+                                       <li><a href="./MCollective/Aggregate/Base.html">MCollective::Aggregate::Base</a></li>
+                               
+                                       <li><a href="./MCollective/Aggregate/Result.html">MCollective::Aggregate::Result</a></li>
+                               
+                                       <li><a href="./MCollective/Aggregate/Result/Base.html">MCollective::Aggregate::Result::Base</a></li>
+                               
+                                       <li><a href="./MCollective/Aggregate/Result/CollectionResult.html">MCollective::Aggregate::Result::CollectionResult</a></li>
+                               
+                                       <li><a href="./MCollective/Aggregate/Result/NumericResult.html">MCollective::Aggregate::Result::NumericResult</a></li>
+                               
+                                       <li><a href="./MCollective/Application.html">MCollective::Application</a></li>
+                               
+                                       <li><a href="./MCollective/Applications.html">MCollective::Applications</a></li>
+                               
+                                       <li><a href="./MCollective/Cache.html">MCollective::Cache</a></li>
+                               
+                                       <li><a href="./MCollective/Client.html">MCollective::Client</a></li>
+                               
+                                       <li><a href="./MCollective/CodedError.html">MCollective::CodedError</a></li>
+                               
+                                       <li><a href="./MCollective/Config.html">MCollective::Config</a></li>
+                               
+                                       <li><a href="./MCollective/Connector.html">MCollective::Connector</a></li>
+                               
+                                       <li><a href="./MCollective/Connector/Base.html">MCollective::Connector::Base</a></li>
+                               
+                                       <li><a href="./MCollective/DDL.html">MCollective::DDL</a></li>
+                               
+                                       <li><a href="./MCollective/DDL/AgentDDL.html">MCollective::DDL::AgentDDL</a></li>
+                               
+                                       <li><a href="./MCollective/DDL/Base.html">MCollective::DDL::Base</a></li>
+                               
+                                       <li><a href="./MCollective/DDL/DataDDL.html">MCollective::DDL::DataDDL</a></li>
+                               
+                                       <li><a href="./MCollective/DDL/DiscoveryDDL.html">MCollective::DDL::DiscoveryDDL</a></li>
+                               
+                                       <li><a href="./MCollective/DDL/ValidatorDDL.html">MCollective::DDL::ValidatorDDL</a></li>
+                               
+                                       <li><a href="./MCollective/DDLValidationError.html">MCollective::DDLValidationError</a></li>
+                               
+                                       <li><a href="./MCollective/Data.html">MCollective::Data</a></li>
+                               
+                                       <li><a href="./MCollective/Data/Base.html">MCollective::Data::Base</a></li>
+                               
+                                       <li><a href="./MCollective/Data/Result.html">MCollective::Data::Result</a></li>
+                               
+                                       <li><a href="./MCollective/Discovery.html">MCollective::Discovery</a></li>
+                               
+                                       <li><a href="./MCollective/Facts.html">MCollective::Facts</a></li>
+                               
+                                       <li><a href="./MCollective/Facts/Base.html">MCollective::Facts::Base</a></li>
+                               
+                                       <li><a href="./MCollective/Generators.html">MCollective::Generators</a></li>
+                               
+                                       <li><a href="./MCollective/Generators/AgentGenerator.html">MCollective::Generators::AgentGenerator</a></li>
+                               
+                                       <li><a href="./MCollective/Generators/Base.html">MCollective::Generators::Base</a></li>
+                               
+                                       <li><a href="./MCollective/Generators/DataGenerator.html">MCollective::Generators::DataGenerator</a></li>
+                               
+                                       <li><a href="./MCollective/InvalidRPCData.html">MCollective::InvalidRPCData</a></li>
+                               
+                                       <li><a href="./MCollective/Log.html">MCollective::Log</a></li>
+                               
+                                       <li><a href="./MCollective/Logger.html">MCollective::Logger</a></li>
+                               
+                                       <li><a href="./MCollective/Logger/Base.html">MCollective::Logger::Base</a></li>
+                               
+                                       <li><a href="./MCollective/Logger/Console_logger.html">MCollective::Logger::Console_logger</a></li>
+                               
+                                       <li><a href="./MCollective/Logger/File_logger.html">MCollective::Logger::File_logger</a></li>
+                               
+                                       <li><a href="./MCollective/Logger/Syslog_logger.html">MCollective::Logger::Syslog_logger</a></li>
+                               
+                                       <li><a href="./MCollective/Matcher.html">MCollective::Matcher</a></li>
+                               
+                                       <li><a href="./MCollective/Matcher/Parser.html">MCollective::Matcher::Parser</a></li>
+                               
+                                       <li><a href="./MCollective/Matcher/Scanner.html">MCollective::Matcher::Scanner</a></li>
+                               
+                                       <li><a href="./MCollective/Message.html">MCollective::Message</a></li>
+                               
+                                       <li><a href="./MCollective/MissingRPCData.html">MCollective::MissingRPCData</a></li>
+                               
+                                       <li><a href="./MCollective/MsgDoesNotMatchRequestID.html">MCollective::MsgDoesNotMatchRequestID</a></li>
+                               
+                                       <li><a href="./MCollective/MsgTTLExpired.html">MCollective::MsgTTLExpired</a></li>
+                               
+                                       <li><a href="./MCollective/NotTargettedAtUs.html">MCollective::NotTargettedAtUs</a></li>
+                               
+                                       <li><a href="./MCollective/Optionparser.html">MCollective::Optionparser</a></li>
+                               
+                                       <li><a href="./MCollective/PluginManager.html">MCollective::PluginManager</a></li>
+                               
+                                       <li><a href="./MCollective/PluginPackager.html">MCollective::PluginPackager</a></li>
+                               
+                                       <li><a href="./MCollective/PluginPackager/AgentDefinition.html">MCollective::PluginPackager::AgentDefinition</a></li>
+                               
+                                       <li><a href="./MCollective/PluginPackager/StandardDefinition.html">MCollective::PluginPackager::StandardDefinition</a></li>
+                               
+                                       <li><a href="./MCollective/RPC.html">MCollective::RPC</a></li>
+                               
+                                       <li><a href="./MCollective/RPC/ActionRunner.html">MCollective::RPC::ActionRunner</a></li>
+                               
+                                       <li><a href="./MCollective/RPC/Agent.html">MCollective::RPC::Agent</a></li>
+                               
+                                       <li><a href="./MCollective/RPC/Audit.html">MCollective::RPC::Audit</a></li>
+                               
+                                       <li><a href="./MCollective/RPC/Client.html">MCollective::RPC::Client</a></li>
+                               
+                                       <li><a href="./MCollective/RPC/Helpers.html">MCollective::RPC::Helpers</a></li>
+                               
+                                       <li><a href="./MCollective/RPC/Progress.html">MCollective::RPC::Progress</a></li>
+                               
+                                       <li><a href="./MCollective/RPC/Reply.html">MCollective::RPC::Reply</a></li>
+                               
+                                       <li><a href="./MCollective/RPC/Request.html">MCollective::RPC::Request</a></li>
+                               
+                                       <li><a href="./MCollective/RPC/Result.html">MCollective::RPC::Result</a></li>
+                               
+                                       <li><a href="./MCollective/RPC/Stats.html">MCollective::RPC::Stats</a></li>
+                               
+                                       <li><a href="./MCollective/RPCAborted.html">MCollective::RPCAborted</a></li>
+                               
+                                       <li><a href="./MCollective/RPCError.html">MCollective::RPCError</a></li>
+                               
+                                       <li><a href="./MCollective/Registration.html">MCollective::Registration</a></li>
+                               
+                                       <li><a href="./MCollective/Registration/Base.html">MCollective::Registration::Base</a></li>
+                               
+                                       <li><a href="./MCollective/Runner.html">MCollective::Runner</a></li>
+                               
+                                       <li><a href="./MCollective/RunnerStats.html">MCollective::RunnerStats</a></li>
+                               
+                                       <li><a href="./MCollective/SSL.html">MCollective::SSL</a></li>
+                               
+                                       <li><a href="./MCollective/Security.html">MCollective::Security</a></li>
+                               
+                                       <li><a href="./MCollective/Security/Base.html">MCollective::Security::Base</a></li>
+                               
+                                       <li><a href="./MCollective/SecurityValidationFailed.html">MCollective::SecurityValidationFailed</a></li>
+                               
+                                       <li><a href="./MCollective/Shell.html">MCollective::Shell</a></li>
+                               
+                                       <li><a href="./MCollective/Translatable.html">MCollective::Translatable</a></li>
+                               
+                                       <li><a href="./MCollective/UnixDaemon.html">MCollective::UnixDaemon</a></li>
+                               
+                                       <li><a href="./MCollective/UnknownRPCAction.html">MCollective::UnknownRPCAction</a></li>
+                               
+                                       <li><a href="./MCollective/UnknownRPCError.html">MCollective::UnknownRPCError</a></li>
+                               
+                                       <li><a href="./MCollective/Util.html">MCollective::Util</a></li>
+                               
+                                       <li><a href="./MCollective/Validator.html">MCollective::Validator</a></li>
+                               
+                                       <li><a href="./MCollective/ValidatorError.html">MCollective::ValidatorError</a></li>
+                               
+                                       <li><a href="./MCollective/WindowsDaemon.html">MCollective::WindowsDaemon</a></li>
+                               
+                                       <li><a href="./Array.html">Array</a></li>
+                               
+                                       <li><a href="./Dir.html">Dir</a></li>
+                               
+                                       <li><a href="./Object.html">Object</a></li>
+                               
+                                       <li><a href="./String.html">String</a></li>
+                               
+                                       <li><a href="./Symbol.html">Symbol</a></li>
+                               
+                               </ul>
+                               <div id="no-class-search-results" style="display: none;">No matching classes.</div>
+                       </div>
+
+                       
+               </div>
+       </div>
+
+       <div id="documentation">
+               <p>
+RAKE_ROOT = File.expand_path(File.dirname(<em>FILE</em>))
+</p>
+<p>
+# Allow override of RELEASE using BUILD_NUMBER ENV[&#8220;RELEASE&#8221;] =
+ENV[&#8220;BUILD_NUMBER&#8220;] if ENV[&#8220;BUILD_NUMBER&#8220;]
+</p>
+<p>
+begin
+</p>
+<pre>
+  load File.join(RAKE_ROOT, 'ext', 'packaging.rake')
+</pre>
+<p>
+rescue LoadError end
+</p>
+<p>
+def announce(msg=&#8217;&#8217;)
+</p>
+<pre>
+  STDERR.puts &quot;================&quot;
+  STDERR.puts msg
+  STDERR.puts &quot;================&quot;
+</pre>
+<p>
+end
+</p>
+<p>
+def safe_system *args
+</p>
+<pre>
+  raise RuntimeError, &quot;Failed: #{args.join(' ')}&quot; unless system(*args)
+</pre>
+<p>
+end
+</p>
+<p>
+def load_tools
+</p>
+<pre>
+  unless File.directory?(File.join(RAKE_ROOT, 'ext', 'packaging'))
+    Rake::Task[&quot;package:bootstrap&quot;].invoke
+    begin
+      load File.join(RAKE_ROOT, 'ext', 'packaging.rake')
+    rescue LoadError
+      STDERR.puts &quot;Could not load packaging tools. exiting&quot;
+      exit 1
+    end
+  end
+</pre>
+<p>
+end
+</p>
+<p>
+def move_artifacts
+</p>
+<pre>
+  mv(&quot;pkg&quot;, &quot;build&quot;)
+</pre>
+<p>
+end
+</p>
+<p>
+desc &#8220;Cleanup&#8221; task :clean do
+</p>
+<pre>
+  rm_rf &quot;build&quot;
+  rm_rf &quot;doc&quot;
+</pre>
+<p>
+end
+</p>
+<p>
+desc &#8220;Create the .debs&#8221; task :deb => :clean do
+</p>
+<pre>
+  load_tools
+  announce(&quot;Building debian packages for #{@build.project}-#{@build.version}-#{@build.release}&quot;)
+  Rake::Task[&quot;package:deb&quot;].invoke
+
+  if ENV['SIGNED'] == '1'
+    deb_flag = &quot;-k#{ENV['SIGNWITH']}&quot; if ENV['SIGNWITH']
+    safe_system %{/usr/bin/debsign #{deb_flag} pkg/deb/*.changes}
+  end
+  move_artifacts
+</pre>
+<p>
+end
+</p>
+<p>
+desc &#8220;Build documentation&#8221; task :doc => :clean do
+</p>
+<pre>
+  load_tools
+  Rake::Task[&quot;package:doc&quot;].invoke
+</pre>
+<p>
+end
+</p>
+<p>
+desc &#8220;Build a gem&#8221; task :gem => :clean do
+</p>
+<pre>
+  load_tools
+  Rake::Task[&quot;gem&quot;].reenable
+  Rake::Task[&quot;package:gem&quot;].invoke
+</pre>
+<p>
+end
+</p>
+<p>
+desc &#8220;Create a tarball for this release&#8221; task :package =>
+:clean do
+</p>
+<pre>
+  load_tools
+  announce &quot;Creating #{@build.project}-#{@build.version}.tar.gz&quot;
+  Rake::Task[&quot;package:tar&quot;].invoke
+  move_artifacts
+</pre>
+<p>
+end
+</p>
+<p>
+desc &#8220;Creates a RPM&#8221; task :rpm => :clean do
+</p>
+<pre>
+  load_tools
+  announce(&quot;Building RPM for #{@build.project}-#{@build.version}-#{@build.release}&quot;)
+  Rake::Task[&quot;package:rpm&quot;].invoke
+  Rake::Task[&quot;package:srpm&quot;].invoke
+  if ENV['SIGNED'] == '1'
+    safe_system %{/usr/bin/rpm --sign pkg/**/*.rpm}
+  end
+  move_artifacts
+</pre>
+<p>
+end
+</p>
+<p>
+desc &#8220;Run spec tests&#8221; task :test do
+</p>
+<pre>
+  sh &quot;cd spec &amp;&amp; rake&quot;
+</pre>
+<p>
+end
+</p>
+<p>
+desc &#8220;Creates the website as a tarball&#8221; task :website => :clean
+do
+</p>
+<pre>
+  FileUtils.mkdir_p(&quot;build/marionette-collective.org/html&quot;)
+
+  Dir.chdir(&quot;website&quot;) do
+    safe_system(&quot;jekyll ../build/marionette-collective.org/html&quot;)
+  end
+
+  unless File.exist?(&quot;build/marionette-collective.org/html/index.html&quot;)
+    raise &quot;Failed to build website&quot;
+  end
+
+  Dir.chdir(&quot;build&quot;) do
+    safe_system(&quot;tar -cvzf marionette-collective-org-#{Time.now.to_i}.tgz marionette-collective.org&quot;)
+  end
+</pre>
+<p>
+end
+</p>
+<p>
+desc &#8220;Update the website error code reference based on current
+local&#8221; task :update_msgweb do
+</p>
+<pre>
+  mcollective_dir = File.join(File.dirname(__FILE__))
+
+  $:.insert(0, File.join(mcollective_dir, &quot;lib&quot;))
+
+  require 'mcollective'
+
+  messages = YAML.load_file(File.join(mcollective_dir, &quot;lib&quot;, &quot;mcollective&quot;, &quot;locales&quot;, &quot;en.yml&quot;))
+
+  webdir = File.join(mcollective_dir, &quot;website&quot;, &quot;messages&quot;)
+
+  I18n.load_path = Dir[File.join(mcollective_dir, &quot;lib&quot;, &quot;mcollective&quot;, &quot;locales&quot;, &quot;*.yml&quot;)]
+  I18n.locale = :en
+
+  messages[&quot;en&quot;].keys.each do |msg_code|
+    md_file = File.join(webdir, &quot;#{msg_code}.md&quot;)
+
+    puts &quot;....writing %s&quot; % md_file
+
+    File.open(md_file, &quot;w&quot;) do |md|
+      md.puts &quot;---&quot;
+      md.puts &quot;layout: default&quot;
+      md.puts &quot;title: Message detail for %s&quot; % msg_code
+      md.puts &quot;toc: false&quot;
+      md.puts &quot;---&quot;
+      md.puts
+      md.puts &quot;Example Message&quot;
+      md.puts &quot;---------------&quot;
+      md.puts
+      md.puts &quot;    %s&quot; % (MCollective::Util.t(&quot;%s.example&quot; % msg_code, :raise =&gt; true) rescue MCollective::Util.t(&quot;%s.pattern&quot; % msg_code))
+      md.puts
+      md.puts &quot;Additional Information&quot;
+      md.puts &quot;----------------------&quot;
+      md.puts
+      md.puts MCollective::Util.t(&quot;%s.expanded&quot; % msg_code, :raise =&gt; true)
+    end
+  end
+</pre>
+<p>
+end
+</p>
+
+       </div>
+
+       <div id="validator-badges">
+               <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+               <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
+                       Rdoc Generator</a> 1.1.6</small>.</p>
+       </div>
+</body>
+</html>
+