doc/index.html in rubu-0.0.2 vs doc/index.html in rubu-0.0.3

- old
+ new

@@ -116,10 +116,35 @@ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_cat'>cat</span> <span class='id identifier rubyid_example'>example</span><span class='op'>/</span><span class='id identifier rubyid_bin'>bin</span><span class='op'>/</span><span class='id identifier rubyid_rubu_example'>rubu_example</span> </code></pre> <p>There are comments which highlight purpose of the build program content.</p> +<p>Sometimes it is useful to run <span class='object_link'><a href="Rubu.html" title="Rubu (class)">Rubu</a></span> automatically whenever a file changes. +Linux provides a facility called <strong>inotify</strong>, which can be +used in Ruby through “rb-inotify” gem. Automatic update example program is +in:</p> + +<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_example'>example</span><span class='op'>/</span><span class='id identifier rubyid_up'>up</span><span class='op'>-</span><span class='id identifier rubyid_to'>to</span><span class='op'>-</span><span class='id identifier rubyid_date'>date</span> +</code></pre> + +<p>This program runs <span class='object_link'><a href="Rubu.html" title="Rubu (class)">Rubu</a></span> each time there is a change in “src” or in “bin” +directory. It compiles and generates C files if necessary. If there are new +compilation requirements coming, before all previous have been completed, +it will continue compilation. When all compilations are done (i.e. none +pending), it will call <span class='object_link'><a href="Rubu.html" title="Rubu (class)">Rubu</a></span> to perform linking. “up-to-date” displays +status messages in red and green on the screen. If it is started with “-v” +option the compile commands are visible, and if it is started with “-d” +option, there is extra delay in compilation command.</p> + +<pre class="code ruby"><code class="ruby">cd example +up-to-date -v -d</code></pre> + +<p>This is useful if you want to play around with the pending compilation +processes when new changes are coming in. You can make (dummy) changes to +“hello_world.c” (for example), and follow the updates in the terminal where +you started “up-to-date”.</p> + <h2 id="label-Concepts">Concepts</h2> <p><span class='object_link'><a href="Rubu.html" title="Rubu (class)">Rubu</a></span> Build Program, RBP, is a Ruby program that uses the <span class='object_link'><a href="Rubu.html" title="Rubu (class)">Rubu</a></span> library. Typically command line options are accepted to give options for the build process.</p> @@ -369,10 +394,10 @@ <p>For this version, example is the testcase.</p> </div></div> <div id="footer"> - Generated on Sun Jul 1 17:48:17 2018 by + Generated on Sun Jul 8 19:50:19 2018 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.8.7.6 (ruby-2.3.3). </div> </body> \ No newline at end of file