doc/classes/Autobuild.html in autobuild-0.5.1 vs doc/classes/Autobuild.html in autobuild-0.6
- old
+ new
@@ -53,58 +53,70 @@
<td class="class-name-in-header">Autobuild</td>
</tr>
<tr class="top-aligned-row">
<td><strong>In:</strong></td>
<td>
- <a href="../files/lib/autobuild/config-interpolator_rb.html">
- lib/autobuild/config-interpolator.rb
+ <a href="../files/lib/autobuild/loaders/config-interpolator_rb.html">
+ lib/autobuild/loaders/config-interpolator.rb
</a>
<br />
+ <a href="../files/lib/autobuild/loaders/config_rb.html">
+ lib/autobuild/loaders/config.rb
+ </a>
+ <br />
<a href="../files/lib/autobuild/import/svn_rb.html">
lib/autobuild/import/svn.rb
</a>
<br />
- <a href="../files/lib/autobuild/import/cvs_rb.html">
- lib/autobuild/import/cvs.rb
- </a>
- <br />
<a href="../files/lib/autobuild/import/tar_rb.html">
lib/autobuild/import/tar.rb
</a>
<br />
- <a href="../files/lib/autobuild/options_rb.html">
- lib/autobuild/options.rb
+ <a href="../files/lib/autobuild/import/cvs_rb.html">
+ lib/autobuild/import/cvs.rb
</a>
<br />
- <a href="../files/lib/autobuild/environment_rb.html">
- lib/autobuild/environment.rb
+ <a href="../files/lib/autobuild/import/darcs_rb.html">
+ lib/autobuild/import/darcs.rb
</a>
<br />
- <a href="../files/lib/autobuild/reporting_rb.html">
- lib/autobuild/reporting.rb
+ <a href="../files/lib/autobuild/packages/genom_rb.html">
+ lib/autobuild/packages/genom.rb
</a>
<br />
- <a href="../files/lib/autobuild/timestamps_rb.html">
- lib/autobuild/timestamps.rb
+ <a href="../files/lib/autobuild/packages/autotools_rb.html">
+ lib/autobuild/packages/autotools.rb
</a>
<br />
<a href="../files/lib/autobuild/packages/import_rb.html">
lib/autobuild/packages/import.rb
</a>
<br />
- <a href="../files/lib/autobuild/packages/autotools_rb.html">
- lib/autobuild/packages/autotools.rb
+ <a href="../files/lib/autobuild/exceptions_rb.html">
+ lib/autobuild/exceptions.rb
</a>
<br />
- <a href="../files/lib/autobuild/packages/genom_rb.html">
- lib/autobuild/packages/genom.rb
+ <a href="../files/lib/autobuild/environment_rb.html">
+ lib/autobuild/environment.rb
</a>
<br />
- <a href="../files/lib/autobuild/exceptions_rb.html">
- lib/autobuild/exceptions.rb
+ <a href="../files/lib/autobuild/config_rb.html">
+ lib/autobuild/config.rb
</a>
<br />
+ <a href="../files/lib/autobuild/timestamps_rb.html">
+ lib/autobuild/timestamps.rb
+ </a>
+ <br />
+ <a href="../files/lib/autobuild/reporting_rb.html">
+ lib/autobuild/reporting.rb
+ </a>
+ <br />
+ <a href="../files/lib/autobuild/package_rb.html">
+ lib/autobuild/package.rb
+ </a>
+ <br />
</td>
</tr>
</table>
</div>
@@ -122,16 +134,30 @@
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
- <a href="#M000038">get_stamp</a>
- <a href="#M000034">pathvar</a>
- <a href="#M000037">source_tree</a>
- <a href="#M000039">touch_stamp</a>
- <a href="#M000036">tree_timestamp</a>
- <a href="#M000035">update_environment</a>
+ <a href="#M000011">autotools</a>
+ <a href="#M000005">check_backward_compatibility</a>
+ <a href="#M000017">clean_log!</a>
+ <a href="#M000019">commandline</a>
+ <a href="#M000008">cvs</a>
+ <a href="#M000009">darcs</a>
+ <a href="#M000010">genom</a>
+ <a href="#M000022">get_stamp</a>
+ <a href="#M000012">import</a>
+ <a href="#M000006">load</a>
+ <a href="#M000016">logdir</a>
+ <a href="#M000015">mail</a>
+ <a href="#M000024">package_set</a>
+ <a href="#M000013">pathvar</a>
+ <a href="#M000021">source_tree</a>
+ <a href="#M000007">svn</a>
+ <a href="#M000018">tool</a>
+ <a href="#M000023">touch_stamp</a>
+ <a href="#M000020">tree_timestamp</a>
+ <a href="#M000014">update_environment</a>
</div>
</div>
</div>
@@ -141,29 +167,28 @@
<div id="section">
<div id="class-list">
<h3 class="section-bar">Classes and Modules</h3>
- Module <a href="Autobuild/Config.html" class="link">Autobuild::Config</a><br />
-Module <a href="Autobuild/Import.html" class="link">Autobuild::Import</a><br />
+ Module <a href="Autobuild/Import.html" class="link">Autobuild::Import</a><br />
+Module <a href="Autobuild/Reporting.html" class="link">Autobuild::Reporting</a><br />
Module <a href="Autobuild/Subprocess.html" class="link">Autobuild::Subprocess</a><br />
Class <a href="Autobuild/Autotools.html" class="link">Autobuild::Autotools</a><br />
Class <a href="Autobuild/CVSImporter.html" class="link">Autobuild::CVSImporter</a><br />
Class <a href="Autobuild/CommandNotFound.html" class="link">Autobuild::CommandNotFound</a><br />
Class <a href="Autobuild/ConfigException.html" class="link">Autobuild::ConfigException</a><br />
+Class <a href="Autobuild/DarcsImporter.html" class="link">Autobuild::DarcsImporter</a><br />
Class <a href="Autobuild/Exception.html" class="link">Autobuild::Exception</a><br />
Class <a href="Autobuild/GenomModule.html" class="link">Autobuild::GenomModule</a><br />
Class <a href="Autobuild/Importer.html" class="link">Autobuild::Importer</a><br />
Class <a href="Autobuild/ImporterPackage.html" class="link">Autobuild::ImporterPackage</a><br />
Class <a href="Autobuild/Interpolator.html" class="link">Autobuild::Interpolator</a><br />
Class <a href="Autobuild/MailReporter.html" class="link">Autobuild::MailReporter</a><br />
-Class <a href="Autobuild/Options.html" class="link">Autobuild::Options</a><br />
Class <a href="Autobuild/Package.html" class="link">Autobuild::Package</a><br />
Class <a href="Autobuild/PackageException.html" class="link">Autobuild::PackageException</a><br />
Class <a href="Autobuild/Reporter.html" class="link">Autobuild::Reporter</a><br />
-Class <a href="Autobuild/Reporting.html" class="link">Autobuild::Reporting</a><br />
-Class <a href="Autobuild/SVNImporter.html" class="link">Autobuild::SVNImporter</a><br />
+Class <a href="Autobuild/SVN.html" class="link">Autobuild::SVN</a><br />
Class <a href="Autobuild/SourceTreeTask.html" class="link">Autobuild::SourceTreeTask</a><br />
Class <a href="Autobuild/StdoutReporter.html" class="link">Autobuild::StdoutReporter</a><br />
Class <a href="Autobuild/SubcommandFailed.html" class="link">Autobuild::SubcommandFailed</a><br />
Class <a href="Autobuild/TarImporter.html" class="link">Autobuild::TarImporter</a><br />
Class <a href="Autobuild/UndefinedVariable.html" class="link">Autobuild::UndefinedVariable</a><br />
@@ -174,104 +199,342 @@
<h3 class="section-bar">Constants</h3>
<div class="name-list">
<table summary="Constants">
<tr class="top-aligned-row context-row">
- <td class="context-item-name">Options</td>
+ <td class="context-item-name">DEFAULT_OPTIONS</td>
<td>=</td>
- <td class="context-item-value">Struct.new( :update, :nice, :srcdir, :prefix, :builddir, :logdir, :verbose, :debug, :do_build, :daemonize, :use_http )</td>
+ <td class="context-item-value">{ :nice => 0, :srcdir => nil, :prefix => nil, :logdir => nil, :verbose => false, :debug => false, :do_build => true, :do_update => true, :daemonize => false }</td>
</tr>
+ <tr class="top-aligned-row context-row">
+ <td class="context-item-name">TARGETS</td>
+ <td>=</td>
+ <td class="context-item-value">%w{import prepare build}</td>
+ </tr>
</table>
</div>
</div>
+ <div id="attribute-list">
+ <h3 class="section-bar">Attributes</h3>
+
+ <div class="name-list">
+ <table>
+ <tr class="top-aligned-row context-row">
+ <td class="context-item-name">logdir</td>
+ <td class="context-item-value"> [W] </td>
+ <td class="context-item-desc"></td>
+ </tr>
+ <tr class="top-aligned-row context-row">
+ <td class="context-item-name">programs</td>
+ <td class="context-item-value"> [R] </td>
+ <td class="context-item-desc"></td>
+ </tr>
+ </table>
+ </div>
+ </div>
<!-- if method_list -->
<div id="methods">
<h3 class="section-bar">Public Class methods</h3>
- <div id="method-M000034" class="method-detail">
- <a name="M000034"></a>
+ <div id="method-M000011" class="method-detail">
+ <a name="M000011"></a>
<div class="method-heading">
- <a href="Autobuild.src/M000034.html" target="Code" class="method-signature"
- onclick="popupCode('Autobuild.src/M000034.html');return false;">
+ <a href="Autobuild.src/M000011.html" target="Code" class="method-signature"
+ onclick="popupCode('Autobuild.src/M000011.html');return false;">
+ <span class="method-name">autotools</span><span class="method-args">(opts, &proc)</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ </div>
+ </div>
+
+ <div id="method-M000005" class="method-detail">
+ <a name="M000005"></a>
+
+ <div class="method-heading">
+ <a href="Autobuild.src/M000005.html" target="Code" class="method-signature"
+ onclick="popupCode('Autobuild.src/M000005.html');return false;">
+ <span class="method-name">check_backward_compatibility</span><span class="method-args">(config)</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ </div>
+ </div>
+
+ <div id="method-M000017" class="method-detail">
+ <a name="M000017"></a>
+
+ <div class="method-heading">
+ <a href="Autobuild.src/M000017.html" target="Code" class="method-signature"
+ onclick="popupCode('Autobuild.src/M000017.html');return false;">
+ <span class="method-name">clean_log!</span><span class="method-args">()</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ </div>
+ </div>
+
+ <div id="method-M000019" class="method-detail">
+ <a name="M000019"></a>
+
+ <div class="method-heading">
+ <a href="Autobuild.src/M000019.html" target="Code" class="method-signature"
+ onclick="popupCode('Autobuild.src/M000019.html');return false;">
+ <span class="method-name">commandline</span><span class="method-args">(args)</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p>
+Gets autobuild options from the command line and returns the remaining
+elements
+</p>
+ </div>
+ </div>
+
+ <div id="method-M000008" class="method-detail">
+ <a name="M000008"></a>
+
+ <div class="method-heading">
+ <a href="Autobuild.src/M000008.html" target="Code" class="method-signature"
+ onclick="popupCode('Autobuild.src/M000008.html');return false;">
+ <span class="method-name">cvs</span><span class="method-args">(repo, name, package_options = {})</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ </div>
+ </div>
+
+ <div id="method-M000009" class="method-detail">
+ <a name="M000009"></a>
+
+ <div class="method-heading">
+ <a href="Autobuild.src/M000009.html" target="Code" class="method-signature"
+ onclick="popupCode('Autobuild.src/M000009.html');return false;">
+ <span class="method-name">darcs</span><span class="method-args">(source, options = {})</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ </div>
+ </div>
+
+ <div id="method-M000010" class="method-detail">
+ <a name="M000010"></a>
+
+ <div class="method-heading">
+ <a href="Autobuild.src/M000010.html" target="Code" class="method-signature"
+ onclick="popupCode('Autobuild.src/M000010.html');return false;">
+ <span class="method-name">genom</span><span class="method-args">(opts, &proc)</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ </div>
+ </div>
+
+ <div id="method-M000012" class="method-detail">
+ <a name="M000012"></a>
+
+ <div class="method-heading">
+ <a href="Autobuild.src/M000012.html" target="Code" class="method-signature"
+ onclick="popupCode('Autobuild.src/M000012.html');return false;">
+ <span class="method-name">import</span><span class="method-args">(spec, &proc)</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ </div>
+ </div>
+
+ <div id="method-M000006" class="method-detail">
+ <a name="M000006"></a>
+
+ <div class="method-heading">
+ <a href="Autobuild.src/M000006.html" target="Code" class="method-signature"
+ onclick="popupCode('Autobuild.src/M000006.html');return false;">
+ <span class="method-name">load</span><span class="method-args">(conffile, user_options = Options.nil)</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ </div>
+ </div>
+
+ <div id="method-M000016" class="method-detail">
+ <a name="M000016"></a>
+
+ <div class="method-heading">
+ <a href="Autobuild.src/M000016.html" target="Code" class="method-signature"
+ onclick="popupCode('Autobuild.src/M000016.html');return false;">
+ <span class="method-name">logdir</span><span class="method-args">()</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ </div>
+ </div>
+
+ <div id="method-M000015" class="method-detail">
+ <a name="M000015"></a>
+
+ <div class="method-heading">
+ <a href="Autobuild.src/M000015.html" target="Code" class="method-signature"
+ onclick="popupCode('Autobuild.src/M000015.html');return false;">
+ <span class="method-name">mail</span><span class="method-args">(config = nil)</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p>
+Configuration for the mail reporter
+</p>
+ </div>
+ </div>
+
+ <div id="method-M000024" class="method-detail">
+ <a name="M000024"></a>
+
+ <div class="method-heading">
+ <a href="Autobuild.src/M000024.html" target="Code" class="method-signature"
+ onclick="popupCode('Autobuild.src/M000024.html');return false;">
+ <span class="method-name">package_set</span><span class="method-args">(spec)</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ </div>
+ </div>
+
+ <div id="method-M000013" class="method-detail">
+ <a name="M000013"></a>
+
+ <div class="method-heading">
+ <a href="Autobuild.src/M000013.html" target="Code" class="method-signature"
+ onclick="popupCode('Autobuild.src/M000013.html');return false;">
<span class="method-name">pathvar</span><span class="method-args">(path, varname)</span>
</a>
</div>
<div class="method-description">
+ <p>
+Adds an element to a path-like variable
+</p>
</div>
</div>
- <div id="method-M000035" class="method-detail">
- <a name="M000035"></a>
+ <div id="method-M000007" class="method-detail">
+ <a name="M000007"></a>
<div class="method-heading">
- <a href="Autobuild.src/M000035.html" target="Code" class="method-signature"
- onclick="popupCode('Autobuild.src/M000035.html');return false;">
+ <a href="Autobuild.src/M000007.html" target="Code" class="method-signature"
+ onclick="popupCode('Autobuild.src/M000007.html');return false;">
+ <span class="method-name">svn</span><span class="method-args">(source, options = {})</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ </div>
+ </div>
+
+ <div id="method-M000018" class="method-detail">
+ <a name="M000018"></a>
+
+ <div class="method-heading">
+ <a href="Autobuild.src/M000018.html" target="Code" class="method-signature"
+ onclick="popupCode('Autobuild.src/M000018.html');return false;">
+ <span class="method-name">tool</span><span class="method-args">(name)</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p>
+Get a given program, using its name as default value
+</p>
+ </div>
+ </div>
+
+ <div id="method-M000014" class="method-detail">
+ <a name="M000014"></a>
+
+ <div class="method-heading">
+ <a href="Autobuild.src/M000014.html" target="Code" class="method-signature"
+ onclick="popupCode('Autobuild.src/M000014.html');return false;">
<span class="method-name">update_environment</span><span class="method-args">(newprefix)</span>
</a>
</div>
<div class="method-description">
+ <pre>
+ Updates the environment when a new prefix has been added
+</pre>
+<p>
+TODO: modularize that
+</p>
</div>
</div>
<h3 class="section-bar">Public Instance methods</h3>
- <div id="method-M000038" class="method-detail">
- <a name="M000038"></a>
+ <div id="method-M000022" class="method-detail">
+ <a name="M000022"></a>
<div class="method-heading">
- <a href="Autobuild.src/M000038.html" target="Code" class="method-signature"
- onclick="popupCode('Autobuild.src/M000038.html');return false;">
+ <a href="Autobuild.src/M000022.html" target="Code" class="method-signature"
+ onclick="popupCode('Autobuild.src/M000022.html');return false;">
<span class="method-name">get_stamp</span><span class="method-args">(stampfile)</span>
</a>
</div>
<div class="method-description">
</div>
</div>
- <div id="method-M000037" class="method-detail">
- <a name="M000037"></a>
+ <div id="method-M000021" class="method-detail">
+ <a name="M000021"></a>
<div class="method-heading">
- <a href="Autobuild.src/M000037.html" target="Code" class="method-signature"
- onclick="popupCode('Autobuild.src/M000037.html');return false;">
+ <a href="Autobuild.src/M000021.html" target="Code" class="method-signature"
+ onclick="popupCode('Autobuild.src/M000021.html');return false;">
<span class="method-name">source_tree</span><span class="method-args">(path, exclude, &block)</span>
</a>
</div>
<div class="method-description">
</div>
</div>
- <div id="method-M000039" class="method-detail">
- <a name="M000039"></a>
+ <div id="method-M000023" class="method-detail">
+ <a name="M000023"></a>
<div class="method-heading">
- <a href="Autobuild.src/M000039.html" target="Code" class="method-signature"
- onclick="popupCode('Autobuild.src/M000039.html');return false;">
+ <a href="Autobuild.src/M000023.html" target="Code" class="method-signature"
+ onclick="popupCode('Autobuild.src/M000023.html');return false;">
<span class="method-name">touch_stamp</span><span class="method-args">(stampfile)</span>
</a>
</div>
<div class="method-description">
</div>
</div>
- <div id="method-M000036" class="method-detail">
- <a name="M000036"></a>
+ <div id="method-M000020" class="method-detail">
+ <a name="M000020"></a>
<div class="method-heading">
- <a href="Autobuild.src/M000036.html" target="Code" class="method-signature"
- onclick="popupCode('Autobuild.src/M000036.html');return false;">
+ <a href="Autobuild.src/M000020.html" target="Code" class="method-signature"
+ onclick="popupCode('Autobuild.src/M000020.html');return false;">
<span class="method-name">tree_timestamp</span><span class="method-args">(path, *exclude)</span>
</a>
</div>
<div class="method-description">
\ No newline at end of file