man/man0/README.html in tork-20.0.0 vs man/man0/README.html in tork-20.0.1
- old
+ new
@@ -1,10 +1,10 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
- <meta name="generator" content="md2man 4.0.0 https://github.com/sunaku/md2man" />
+ <meta name="generator" content="md2man 5.0.1 https://github.com/sunaku/md2man" />
<title>README</title>
<link rel="stylesheet" href="../style.css"/>
<!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
</head>
<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man0">man0</a>/README</span></div></div><div class="container-fluid"><pre><code>_______ _______
@@ -19,17 +19,17 @@
<li>Manuals: <a href="https://sunaku.github.io/tork/man">https://sunaku.github.io/tork/man</a></li>
<li>Sources: <a href="https://github.com/sunaku/tork">https://github.com/sunaku/tork</a></li>
<li>Support: <a href="https://github.com/sunaku/tork/issues">https://github.com/sunaku/tork/issues</a></li>
<li>Package: <a href="https://rubygems.org/gems/tork">https://rubygems.org/gems/tork</a></li>
</ul>
-<h1 id="test-with-fork"><a name="test-with-fork" href="#test-with-fork" class="md2man-permalink" title="permalink"></a><span class="md2man-title"><em>Test</span> <span class="md2man-section">with</span> <span class="md2man-date">fork</em></span></h1><p>Tork runs your tests as they change, in parallel:</p>
+<h1 id="test-with-fork"><span class="md2man-title"><em>Test</span> <span class="md2man-section">with</span> <span class="md2man-date">fork</em></span><a name="test-with-fork" href="#test-with-fork" class="md2man-permalink" title="permalink"></a></h1><p>Tork runs your tests as they change, in parallel:</p>
<ol>
<li><p>Absorbs test execution overhead into a master process.</p></li>
<li><p>Forks to inherit overhead and run test files in parallel.</p></li>
<li><p>Avoids running unchanged tests inside changed test files.</p></li>
</ol>
-<h2 id="features"><a name="features" href="#features" class="md2man-permalink" title="permalink"></a>Features</h2>
+<h2 id="features">Features<a name="features" href="#features" class="md2man-permalink" title="permalink"></a></h2>
<ul>
<li><p>No configuration necessary: simply run <code>tork</code> to start testing <em>now!</em></p></li>
<li><p>Runs test files in parallel using fork for multi-core/CPU utilization.</p></li>
<li><p>Tests <em>changes</em> your Ruby application for rapid TDD: avoids running (1)
unchanged test files and (2) unchanged tests inside changed test files.</p></li>
@@ -39,11 +39,11 @@
<li><p>Logs the output from your tests into separate files: one log per test.</p></li>
<li><p>Configurable through Ruby scripts in your current working directory.</p></li>
<li><p>You can override the modular <code>tork*</code> programs with your own in $PATH.</p></li>
<li><p>You can remotely control other <code>tork*</code> programs using <a class="md2man-reference" href="../man1/tork-remote.1.html">tork-remote(1)</a>.</p></li>
</ul>
-<h3 id="architecture"><a name="architecture" href="#architecture" class="md2man-permalink" title="permalink"></a>Architecture</h3><p>Following UNIX philosophy, Tork is composed of simple text-based programs that
+<h3 id="architecture">Architecture<a name="architecture" href="#architecture" class="md2man-permalink" title="permalink"></a></h3><p>Following UNIX philosophy, Tork is composed of simple text-based programs that
<em>do one thing well</em>. As a result, you can even create your own user interface
for Tork by wrapping the <a class="md2man-reference" href="../man1/tork-driver.1.html">tork-driver(1)</a> program appropriately!</p>
<ul>
<li><a class="md2man-reference" href="../man1/tork.1.html">tork(1)</a> is an interactive command-line user interface for <a class="md2man-reference" href="../man1/tork-driver.1.html">tork-driver(1)</a></li>
<li><a class="md2man-reference" href="../man1/tork-runner.1.html">tork-runner(1)</a> runs your test suite once, non-interactively, and then exits</li>
@@ -75,13 +75,13 @@
# run lines 4, 33, and 21 of test/some_test.rb
echo run_test_file test/some_test.rb 4 33 21 | tork-remote tork-engine
</code></pre></li>
</ol>
<p>Alternatively, you can use <a class="md2man-reference" href="../man1/tork-runner.1.html">tork-runner(1)</a> to run your test suite in one shot
-and then exit with a nonzero status if tests failed, similar to <code>rake test</code>.</p><h2 id="installation"><a name="installation" href="#installation" class="md2man-permalink" title="permalink"></a>Installation</h2><pre><code>gem install tork
+and then exit with a nonzero status if tests failed, similar to <code>rake test</code>.</p><h2 id="installation">Installation<a name="installation" href="#installation" class="md2man-permalink" title="permalink"></a></h2><pre><code>gem install tork
</code></pre>
-<h3 id="prerequisites"><a name="prerequisites" href="#prerequisites" class="md2man-permalink" title="permalink"></a>Prerequisites</h3>
+<h3 id="prerequisites">Prerequisites<a name="prerequisites" href="#prerequisites" class="md2man-permalink" title="permalink"></a></h3>
<ul>
<li><p>Ruby 1.8.7 or 1.9.3 or newer.</p></li>
<li><p>Operating system that supports POSIX signals and the <code>fork()</code> system call.
To check if your system qualifies, launch <a class="md2man-reference">irb(1)</a> and enter the following:</p><pre><code>Process.respond_to? :fork # must be true
Signal.list.key? 'TERM' # must be true
@@ -89,17 +89,17 @@
</code></pre></li>
<li><p>To make the <a class="md2man-reference" href="../man1/tork-herald.1.html">tork-herald(1)</a> program's filesystem monitoring more efficient:</p><pre><code>gem install rb-inotify # linux
gem install rb-fsevent # macosx
</code></pre></li>
</ul>
-<h3 id="development"><a name="development" href="#development" class="md2man-permalink" title="permalink"></a>Development</h3><pre><code>git clone git://github.com/sunaku/tork
+<h3 id="development">Development<a name="development" href="#development" class="md2man-permalink" title="permalink"></a></h3><pre><code>git clone git://github.com/sunaku/tork
cd tork
bundle install
bundle exec tork --help # run it directly
bundle exec rake --tasks # packaging tasks
</code></pre>
-<h2 id="usage"><a name="usage" href="#usage" class="md2man-permalink" title="permalink"></a>Usage</h2><h3 id="at-the-command-line"><a name="at-the-command-line" href="#at-the-command-line" class="md2man-permalink" title="permalink"></a>At the command line</h3><pre><code>tork --help
+<h2 id="usage">Usage<a name="usage" href="#usage" class="md2man-permalink" title="permalink"></a></h2><h3 id="at-the-command-line">At the command line<a name="at-the-command-line" href="#at-the-command-line" class="md2man-permalink" title="permalink"></a></h3><pre><code>tork --help
</code></pre>
<p>You can add line editing, history, and filename completion:</p><pre><code>rlwrap -c tork
</code></pre>
<p>You can control <a class="md2man-reference" href="../man1/tork.1.html">tork(1)</a> interactively from another terminal:</p><pre><code>tork-remote tork-engine
# type your commands here, one per line.
@@ -108,32 +108,32 @@
<p>You can also do the same non-interactively using a pipeline:</p><pre><code># run lines 4, 33, and 21 of test/some_test.rb
echo run_test_file test/some_test.rb 4 33 21 | tork-remote tork-engine
</code></pre>
<p>You can monitor your test processes from another terminal:</p><pre><code>watch 'pgrep -f ^tork | xargs -r ps uf'
</code></pre>
-<h3 id="with-bundler"><a name="with-bundler" href="#with-bundler" class="md2man-permalink" title="permalink"></a>With Bundler</h3><p>The <code>bundler</code> configuration helper loads a Bundler bundle into <a class="md2man-reference" href="../man1/tork-master.1.html">tork-master(1)</a>.
+<h3 id="with-bundler">With Bundler<a name="with-bundler" href="#with-bundler" class="md2man-permalink" title="permalink"></a></h3><p>The <code>bundler</code> configuration helper loads a Bundler bundle into <a class="md2man-reference" href="../man1/tork-master.1.html">tork-master(1)</a>.
The <code>default</code> configuration helper does this for you automatically if there is
a <code>Gemfile</code> or <code>Gemfile.lock</code> file present in your current working directory.</p><p>As a result, you don't need to add Tork to your <code>Gemfile</code> <em>just</em> to run tests!
-Instead, installing Tork as a Ruby gem <em>outside</em> of your bundle is sufficient.</p><p>Try it: go into any bundled application and call <code>tork</code> to run its test suite.</p><h3 id="with-minitest"><a name="with-minitest" href="#with-minitest" class="md2man-permalink" title="permalink"></a>With MiniTest</h3><p>MiniTest 1.3.2 and newer contain a bug where <code>minitest/autorun</code> won't run any
+Instead, installing Tork as a Ruby gem <em>outside</em> of your bundle is sufficient.</p><p>Try it: go into any bundled application and call <code>tork</code> to run its test suite.</p><h3 id="with-minitest">With MiniTest<a name="with-minitest" href="#with-minitest" class="md2man-permalink" title="permalink"></a></h3><p>MiniTest 1.3.2 and newer contain a bug where <code>minitest/autorun</code> won't run any
tests if someone calls <code>Kernel#exit</code> explicitly or simply loads a library
(such as RSpec) which makes the call implicitly. Use Tork 19.0.2+ to avoid
-this problem or <a href="https://github.com/seattlerb/minitest/pull/183/files">apply this patch to the minitest library</a> to fix the problem.</p><h3 id="with-rspec"><a name="with-rspec" href="#with-rspec" class="md2man-permalink" title="permalink"></a>With RSpec</h3><p>RSpec 2.9.0 and newer contain a bug where RSpec's autorun helper won't run any
+this problem or <a href="https://github.com/seattlerb/minitest/pull/183/files">apply this patch to the minitest library</a> to fix the problem.</p><h3 id="with-rspec">With RSpec<a name="with-rspec" href="#with-rspec" class="md2man-permalink" title="permalink"></a></h3><p>RSpec 2.9.0 and newer contain a bug where RSpec's autorun helper won't run any
specs if someone calls <code>Kernel#exit</code> explicitly or simply loads a library
(such as Test::Unit) which makes the call implicitly. Use Tork 19.0.2+ to
avoid this problem or <a href="https://github.com/rspec/rspec-core/pull/720/files">apply this patch to the rspec-core library</a> to fix the problem.</p><p>RSpec 2.8.0 and older contain <a href="https://github.com/sunaku/tork/issues/31">a bug</a> where a nonzero exit status (caused
by an uncaught exception) is overridden by RSpec's <code>Kernel#at_exit</code> handler to
-be zero, thereby falsely indicating that a spec had passed. <a href="https://github.com/rspec/rspec-core/pull/569/files">This patch</a> fixes the problem.</p><h3 id="with-ruby-on-rails"><a name="with-ruby-on-rails" href="#with-ruby-on-rails" class="md2man-permalink" title="permalink"></a>With <a href="http://rubyonrails.org">Ruby on Rails</a></h3><p>For Rails 3 or newer, use the <code>rails</code> configuration helper <em>before</em> the <code>test</code>
+be zero, thereby falsely indicating that a spec had passed. <a href="https://github.com/rspec/rspec-core/pull/569/files">This patch</a> fixes the problem.</p><h3 id="with-ruby-on-rails">With <a href="http://rubyonrails.org">Ruby on Rails</a><a name="with-ruby-on-rails" href="#with-ruby-on-rails" class="md2man-permalink" title="permalink"></a></h3><p>For Rails 3 or newer, use the <code>rails</code> configuration helper <em>before</em> the <code>test</code>
or <code>spec</code> helpers. Otherwise your test helper will load Rails <em>before</em> the
specified <code>rails</code> configuration helper has a chance to disable class caching!</p><p>For older Rails, make sure your <code>config/environments/test.rb</code> file contains:</p><pre><code>config.cache_classes = false
</code></pre>
<p>For older Rails, to use SQLite3 as your test database, install the <a href="https://github.com/stepahn/memory_test_fix">in-memory
database adapter</a>. Otherwise, you <em>might</em> face these errors:</p>
<blockquote>
<p>SQLite3::BusyException: database is locked</p><p>cannot start a transaction within a transaction</p></blockquote>
<p>For older Rails, to use SQLite3 as your test database along with browser-based
acceptance testing frameworks such as Capybara, see
-<a href="http://www.spacevatican.org/2012/8/18/threading-the-rat/">http://www.spacevatican.org/2012/8/18/threading-the-rat/</a></p><h2 id="configuration"><a name="configuration" href="#configuration" class="md2man-permalink" title="permalink"></a>Configuration</h2><p>Tork looks for a configuration directory named <code>.tork/</code> inside its working
+<a href="http://www.spacevatican.org/2012/8/18/threading-the-rat/">http://www.spacevatican.org/2012/8/18/threading-the-rat/</a></p><h2 id="configuration">Configuration<a name="configuration" href="#configuration" class="md2man-permalink" title="permalink"></a></h2><p>Tork looks for a configuration directory named <code>.tork/</code> inside its working
directory. The configuration directory contains specially-named Ruby scripts,
within which you can query and modify the settings for various tork programs.
See the "FILES" sections in the manual pages of tork programs for details.</p><p>Note that tork <em>does not</em> automatically reload changes from your configuration
-directory. Consequently, you must restart tork if your configuration changes.</p><h2 id="license"><a name="license" href="#license" class="md2man-permalink" title="permalink"></a>License</h2><p>Released under the ISC license. See the LICENSE file for details.</p></div></body>
+directory. Consequently, you must restart tork if your configuration changes.</p><h2 id="license">License<a name="license" href="#license" class="md2man-permalink" title="permalink"></a></h2><p>Released under the ISC license. See the LICENSE file for details.</p></div></body>
</html>