doc/index.html in rubu-0.0.6 vs doc/index.html in rubu-0.0.7
- old
+ new
@@ -155,12 +155,12 @@
make the build process convenient.</p>
<p><strong>Step</strong> is build action that transforms source file(s) to
target file(s). For example, a C source file compilation is a
<strong>Step</strong> where one source file is converted to a corresponding
-object file. <strong>Step</strong> is given source <strong>Mark</strong>
-and target <strong>Mark</strong> as arguments. Hence this type of
+object file. <strong>Step</strong> is given <strong>Source-Mark</strong>
+and <strong>Target-Mark</strong> as arguments. Hence this type of
<strong>Step</strong> a is one-to-one mapping.</p>
<p>Linking multiple objects to an executable is a many-to-one mapping. This is
performed by a <strong>Step</strong> where there are multiple sources and
one target, i.e. objects and the executable respectively.</p>
@@ -203,11 +203,11 @@
example.</p>
<p>To summarize and highlight the relationships between concepts, see the
diagram below:</p>
-<pre class="code ruby"><code class="ruby">RBP => Trail+ => Step+ [s/p] => Move+ [s/p] => SourceMark*, TargetMark*
+<pre class="code ruby"><code class="ruby">RBP => Trail+ => Step+ [s/p] => Move+ [s/p] => Source-Mark*, Target-Mark*
=> Order+
=> Var*
=> Info*
* = Zero or more
@@ -221,23 +221,24 @@
includes one or more <strong>Steps</strong>, which can be executed in
sequence or in parallel.</p>
<p><strong>Step</strong> includes one or more <strong>Moves</strong>, and they
can also be sequential or parallel. <strong>Move</strong> has typically at
-least one <strong>SourceMark</strong> and at least one
-<strong>TargetMark</strong>. However, there are exceptions as well.</p>
+least one <strong>Source-Mark</strong> and at least one
+<strong>Target-Mark</strong>. However, there are exceptions as well.</p>
<p>The suggested ordering within <span class='object_link'><a href="Rubu.html" title="Rubu (module)">Rubu</a></span> Build Program is:</p>
<dl class="rdoc-list label-list"><dt>configuration
<dd>
<p>Process command line arguments and assign options that are used to control
the build process.</p>
</dd><dt>file collection
<dd>
<p>Collect source and target files either using Ruby with glob pattern, direct
references, or through manifest files. Convert file names to
-<strong>Mark</strong> objects.</p>
+<strong>Mark</strong> objects (<strong>Source-Mark</strong>,
+<strong>Target-Mark</strong>).</p>
</dd><dt>step definition
<dd>
<p>Define <strong>Steps</strong>. Inherit one of the <strong>Step</strong>
types (classes) and define at least the “step” method.</p>
</dd><dt>trail definition
@@ -272,11 +273,12 @@
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_cee_files'>cee_files</span> <span class='op'>=</span> <span class='const'>Mark</span><span class='period'>.</span><span class='id identifier rubyid_glob'>glob</span><span class='lparen'>(</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='const'>Var</span><span class='lbracket'>[</span><span class='symbol'>:source_dir</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'>/*.c</span><span class='tstring_end'>"</span></span> <span class='rparen'>)</span>
</code></pre>
<p>This creates a list of <strong>Mark</strong> objects which are source
-files. The corresponding object files can be created with “peer” method:</p>
+files, i.e. <strong>Source-Marks</strong>. The corresponding object
+(target) files can be created with “peer” method:</p>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_obj_files'>obj_files</span> <span class='op'>=</span> <span class='id identifier rubyid_cee_files'>cee_files</span><span class='period'>.</span><span class='id identifier rubyid_peer'>peer</span><span class='lparen'>(</span> <span class='const'>Var</span><span class='lbracket'>[</span> <span class='symbol'>:build_dir</span> <span class='rbracket'>]</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>.o</span><span class='tstring_end'>'</span></span> <span class='rparen'>)</span>
</code></pre>
<p>This method invocation takes an Array of <strong>Mark</strong> objects and
@@ -301,12 +303,12 @@
<p>“setup” method is typically used to change the command according to user
configuration. “step” method is the action for <strong>Step</strong>.
<span class='object_link'><a href="Rubu.html" title="Rubu (module)">Rubu</a></span> executes it, if necessary. For example, if <strong>Step</strong> is
a <strong>StepAged</strong> class, then the “step” method is only called if
-the source <strong>Mark</strong> is newer than the target
-<strong>Mark</strong>.</p>
+the <strong>Source-Mark</strong> is newer than the
+<strong>Target-Mark</strong>.</p>
<p>“step” method may include only one command or a set of commands. If one
command is needed, it can be simply executed:</p>
<pre class="code ruby"><code class="ruby"><span class='kw'>def</span> <span class='id identifier rubyid_step'>step</span>
@@ -393,10 +395,10 @@
<p>For this version, example is the testcase.</p>
</div></div>
<div id="footer">
- Generated on Tue Sep 11 08:02:18 2018 by
+ Generated on Sat Sep 29 22:28:26 2018 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.16 (ruby-2.5.1).
</div>
</div>
\ No newline at end of file