http://git-wip-us.apache.org/repos/asf/yetus/blob/4a356e40/documentation/0.7.0/precommit-apidocs/test-patch/index.html ---------------------------------------------------------------------- diff --git a/documentation/0.7.0/precommit-apidocs/test-patch/index.html b/documentation/0.7.0/precommit-apidocs/test-patch/index.html index 94535d1..5fa6bad 100644 --- a/documentation/0.7.0/precommit-apidocs/test-patch/index.html +++ b/documentation/0.7.0/precommit-apidocs/test-patch/index.html @@ -53,10 +53,9 @@ <li class="dropdown"> <a class="dropdown-toggle" data-toggle="dropdown" href="#">Documentation <span class="caret"></span></a> <ul class="dropdown-menu" role="menu"> - <li><a href="/documentation/0.4.0/">Docs for v0.4.0</a></li> - <li><a href="/documentation/0.5.0/">Docs for v0.5.0</a></li> <li><a href="/documentation/0.6.0/">Docs for v0.6.0</a></li> <li><a href="/documentation/0.7.0/">Docs for v0.7.0</a></li> + <li><a href="/documentation/0.8.0/">Docs for v0.8.0</a></li> <li><a href="/documentation/in-progress/">In Progress Docs for Contributors</a> </li> </ul> @@ -201,8 +200,8 @@ <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>relative_dir path -</code></pre> +<div class="highlight"><pre class="highlight plaintext"><code>relative_dir path +</code></pre></div> <ul> <li>Description</li> </ul> @@ -238,8 +237,8 @@ <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>verify_multijdk_test test -</code></pre> +<div class="highlight"><pre class="highlight plaintext"><code>verify_multijdk_test test +</code></pre></div> <ul> <li>Description</li> </ul> @@ -277,8 +276,8 @@ <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>add_footer_table subsystem string -</code></pre> +<div class="highlight"><pre class="highlight plaintext"><code>add_footer_table subsystem string +</code></pre></div> <ul> <li>Description</li> </ul> @@ -312,8 +311,8 @@ <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>add_header_line string -</code></pre> +<div class="highlight"><pre class="highlight plaintext"><code>add_header_line string +</code></pre></div> <ul> <li>Description</li> </ul> @@ -347,8 +346,8 @@ <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>add_test_table failurereason testlist -</code></pre> +<div class="highlight"><pre class="highlight plaintext"><code>add_test_table failurereason testlist +</code></pre></div> <ul> <li>Description</li> </ul> @@ -382,8 +381,8 @@ <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>add_vote_table +1/0/-1/H subsystem string -</code></pre> +<div class="highlight"><pre class="highlight plaintext"><code>add_vote_table +1/0/-1/H subsystem string +</code></pre></div> <ul> <li>Description</li> </ul> @@ -417,8 +416,8 @@ <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>big_console_header string -</code></pre> +<div class="highlight"><pre class="highlight plaintext"><code>big_console_header string +</code></pre></div> <ul> <li>Description</li> </ul> @@ -452,8 +451,8 @@ <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>clock_display seconds -</code></pre> +<div class="highlight"><pre class="highlight plaintext"><code>clock_display seconds +</code></pre></div> <ul> <li>Description</li> </ul> @@ -487,8 +486,8 @@ <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>echo_and_redirect filename command [..] -</code></pre> +<div class="highlight"><pre class="highlight plaintext"><code>echo_and_redirect filename command [..] +</code></pre></div> <ul> <li>Description</li> </ul> @@ -522,8 +521,8 @@ <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>generate_stack -</code></pre> +<div class="highlight"><pre class="highlight plaintext"><code>generate_stack +</code></pre></div> <ul> <li>Description</li> </ul> @@ -557,8 +556,8 @@ <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>module_file_fragment module -</code></pre> +<div class="highlight"><pre class="highlight plaintext"><code>module_file_fragment module +</code></pre></div> <ul> <li>Description</li> </ul> @@ -592,8 +591,8 @@ <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>offset_clock seconds -</code></pre> +<div class="highlight"><pre class="highlight plaintext"><code>offset_clock seconds +</code></pre></div> <ul> <li>Description</li> </ul> @@ -627,8 +626,8 @@ <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>setup_defaults -</code></pre> +<div class="highlight"><pre class="highlight plaintext"><code>setup_defaults +</code></pre></div> <ul> <li>Description</li> </ul> @@ -662,8 +661,8 @@ <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>start_clock -</code></pre> +<div class="highlight"><pre class="highlight plaintext"><code>start_clock +</code></pre></div> <ul> <li>Description</li> </ul> @@ -697,8 +696,8 @@ <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>stop_clock -</code></pre> +<div class="highlight"><pre class="highlight plaintext"><code>stop_clock +</code></pre></div> <ul> <li>Description</li> </ul> @@ -732,8 +731,8 @@ <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>write_comment filename -</code></pre> +<div class="highlight"><pre class="highlight plaintext"><code>write_comment filename +</code></pre></div> <ul> <li>Description</li> </ul> @@ -767,8 +766,8 @@ <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>yetus_usage -</code></pre> +<div class="highlight"><pre class="highlight plaintext"><code>yetus_usage +</code></pre></div> <ul> <li>Description</li> </ul> @@ -804,8 +803,8 @@ <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>archive -</code></pre> +<div class="highlight"><pre class="highlight plaintext"><code>archive +</code></pre></div> <ul> <li>Description</li> </ul> @@ -839,8 +838,8 @@ <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>bugsystem_linecomments filename -</code></pre> +<div class="highlight"><pre class="highlight plaintext"><code>bugsystem_linecomments filename +</code></pre></div> <ul> <li>Description</li> </ul> @@ -874,8 +873,8 @@ <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>buildtool_cwd MODULE_ index -</code></pre> +<div class="highlight"><pre class="highlight plaintext"><code>buildtool_cwd MODULE_ index +</code></pre></div> <ul> <li>Description</li> </ul> @@ -909,8 +908,8 @@ <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>calcdiffs branchlog patchlog testtype -</code></pre> +<div class="highlight"><pre class="highlight plaintext"><code>calcdiffs branchlog patchlog testtype +</code></pre></div> <ul> <li>Description</li> </ul> @@ -944,8 +943,8 @@ <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>clear_personality_queue -</code></pre> +<div class="highlight"><pre class="highlight plaintext"><code>clear_personality_queue +</code></pre></div> <ul> <li>Description</li> </ul> @@ -979,8 +978,8 @@ <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>column_calcdiffs branchlog patchlog -</code></pre> +<div class="highlight"><pre class="highlight plaintext"><code>column_calcdiffs branchlog patchlog +</code></pre></div> <ul> <li>Description</li> </ul> @@ -1014,8 +1013,8 @@ <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>compile branch|patch -</code></pre> +<div class="highlight"><pre class="highlight plaintext"><code>compile branch|patch +</code></pre></div> <ul> <li>Description</li> </ul> @@ -1051,8 +1050,8 @@ <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>compile_cycle branch|patch -</code></pre> +<div class="highlight"><pre class="highlight plaintext"><code>compile_cycle branch|patch +</code></pre></div> <ul> <li>Description</li> </ul> @@ -1088,8 +1087,8 @@ <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>compile_jvm branch|patch -</code></pre> +<div class="highlight"><pre class="highlight plaintext"><code>compile_jvm branch|patch +</code></pre></div> <ul> <li>Description</li> </ul> @@ -1125,8 +1124,8 @@ <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>compile_nonjvm branch|patch -</code></pre> +<div class="highlight"><pre class="highlight plaintext"><code>compile_nonjvm branch|patch +</code></pre></div> <ul> <li>Description</li> </ul> @@ -1162,8 +1161,8 @@ <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>dequeue_personality_module modulenames -</code></pre> +<div class="highlight"><pre class="highlight plaintext"><code>dequeue_personality_module modulenames +</code></pre></div> <ul> <li>Description</li> </ul> @@ -1197,8 +1196,8 @@ <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>distclean -</code></pre> +<div class="highlight"><pre class="highlight plaintext"><code>distclean +</code></pre></div> <ul> <li>Description</li> </ul> @@ -1234,8 +1233,8 @@ <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>error_calcdiffs branchlog patchlog -</code></pre> +<div class="highlight"><pre class="highlight plaintext"><code>error_calcdiffs branchlog patchlog +</code></pre></div> <ul> <li>Description</li> </ul> @@ -1269,8 +1268,8 @@ <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>generic_calcdiff_status totalbranchissues totalpatchissues newpatchissues -</code></pre> +<div class="highlight"><pre class="highlight plaintext"><code>generic_calcdiff_status totalbranchissues totalpatchissues newpatchissues +</code></pre></div> <ul> <li>Description</li> </ul> @@ -1304,8 +1303,8 @@ <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>generic_logfilter -</code></pre> +<div class="highlight"><pre class="highlight plaintext"><code>generic_logfilter +</code></pre></div> <ul> <li>Description</li> </ul> @@ -1339,8 +1338,8 @@ <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>generic_post_handler origlog testtype multijdkmode run commands -</code></pre> +<div class="highlight"><pre class="highlight plaintext"><code>generic_post_handler origlog testtype multijdkmode run commands +</code></pre></div> <ul> <li>Description</li> </ul> @@ -1376,8 +1375,8 @@ <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>generic_postlog_compare origlog testtype multijdkmode -</code></pre> +<div class="highlight"><pre class="highlight plaintext"><code>generic_postlog_compare origlog testtype multijdkmode +</code></pre></div> <ul> <li>Description</li> </ul> @@ -1413,8 +1412,8 @@ <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>generic_pre_handler testype multijdk -</code></pre> +<div class="highlight"><pre class="highlight plaintext"><code>generic_pre_handler testype multijdk +</code></pre></div> <ul> <li>Description</li> </ul> @@ -1450,8 +1449,8 @@ <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>initialize $@ -</code></pre> +<div class="highlight"><pre class="highlight plaintext"><code>initialize $@ +</code></pre></div> <ul> <li>Description</li> </ul> @@ -1487,8 +1486,8 @@ <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>module_status moduleindex -1-0|0|+1 logvalue message -</code></pre> +<div class="highlight"><pre class="highlight plaintext"><code>module_status moduleindex -1-0|0|+1 logvalue message +</code></pre></div> <ul> <li>Description</li> </ul> @@ -1522,8 +1521,8 @@ <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>modules_backup -</code></pre> +<div class="highlight"><pre class="highlight plaintext"><code>modules_backup +</code></pre></div> <ul> <li>Description</li> </ul> @@ -1557,8 +1556,8 @@ <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>modules_messages repostatus testtype summarymode -</code></pre> +<div class="highlight"><pre class="highlight plaintext"><code>modules_messages repostatus testtype summarymode +</code></pre></div> <ul> <li>Description</li> </ul> @@ -1592,8 +1591,8 @@ <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>modules_reset -</code></pre> +<div class="highlight"><pre class="highlight plaintext"><code>modules_reset +</code></pre></div> <ul> <li>Description</li> </ul> @@ -1627,8 +1626,8 @@ <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>modules_restore -</code></pre> +<div class="highlight"><pre class="highlight plaintext"><code>modules_restore +</code></pre></div> <ul> <li>Description</li> </ul> @@ -1662,8 +1661,8 @@ <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>modules_workers repostatus testtype mvncmdline -</code></pre> +<div class="highlight"><pre class="highlight plaintext"><code>modules_workers repostatus testtype mvncmdline +</code></pre></div> <ul> <li>Description</li> </ul> @@ -1697,8 +1696,8 @@ <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>patchfiletests branch|patch -</code></pre> +<div class="highlight"><pre class="highlight plaintext"><code>patchfiletests branch|patch +</code></pre></div> <ul> <li>Description</li> </ul> @@ -1734,8 +1733,8 @@ <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>personality_enqueue_module module profiles/flags/etc -</code></pre> +<div class="highlight"><pre class="highlight plaintext"><code>personality_enqueue_module module profiles/flags/etc +</code></pre></div> <ul> <li>Description</li> </ul> @@ -1771,8 +1770,8 @@ <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>prepopulate_footer -</code></pre> +<div class="highlight"><pre class="highlight plaintext"><code>prepopulate_footer +</code></pre></div> <ul> <li>Description</li> </ul> @@ -1806,8 +1805,8 @@ <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>report_jvm_version directory -</code></pre> +<div class="highlight"><pre class="highlight plaintext"><code>report_jvm_version directory +</code></pre></div> <ul> <li>Description</li> </ul> @@ -1843,8 +1842,8 @@ <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>start_coprocessors -</code></pre> +<div class="highlight"><pre class="highlight plaintext"><code>start_coprocessors +</code></pre></div> <ul> <li>Description</li> </ul> @@ -1878,8 +1877,8 @@ <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>stop_coprocessors -</code></pre> +<div class="highlight"><pre class="highlight plaintext"><code>stop_coprocessors +</code></pre></div> <ul> <li>Description</li> </ul> @@ -1913,8 +1912,8 @@ <ul> <li>Synopsis</li> </ul> -<pre class="highlight plaintext"><code>verify_patchdir_still_exists -</code></pre> +<div class="highlight"><pre class="highlight plaintext"><code>verify_patchdir_still_exists +</code></pre></div> <ul> <li>Description</li> </ul>
http://git-wip-us.apache.org/repos/asf/yetus/blob/4a356e40/documentation/0.7.0/precommit-architecture/index.html ---------------------------------------------------------------------- diff --git a/documentation/0.7.0/precommit-architecture/index.html b/documentation/0.7.0/precommit-architecture/index.html index 762bdac..3f77df4 100644 --- a/documentation/0.7.0/precommit-architecture/index.html +++ b/documentation/0.7.0/precommit-architecture/index.html @@ -53,10 +53,9 @@ <li class="dropdown"> <a class="dropdown-toggle" data-toggle="dropdown" href="#">Documentation <span class="caret"></span></a> <ul class="dropdown-menu" role="menu"> - <li><a href="/documentation/0.4.0/">Docs for v0.4.0</a></li> - <li><a href="/documentation/0.5.0/">Docs for v0.5.0</a></li> <li><a href="/documentation/0.6.0/">Docs for v0.6.0</a></li> <li><a href="/documentation/0.7.0/">Docs for v0.7.0</a></li> + <li><a href="/documentation/0.8.0/">Docs for v0.8.0</a></li> <li><a href="/documentation/in-progress/">In Progress Docs for Contributors</a> </li> </ul> http://git-wip-us.apache.org/repos/asf/yetus/blob/4a356e40/documentation/0.7.0/precommit-basic/index.html ---------------------------------------------------------------------- diff --git a/documentation/0.7.0/precommit-basic/index.html b/documentation/0.7.0/precommit-basic/index.html index 586db6f..f00ae6b 100644 --- a/documentation/0.7.0/precommit-basic/index.html +++ b/documentation/0.7.0/precommit-basic/index.html @@ -53,10 +53,9 @@ <li class="dropdown"> <a class="dropdown-toggle" data-toggle="dropdown" href="#">Documentation <span class="caret"></span></a> <ul class="dropdown-menu" role="menu"> - <li><a href="/documentation/0.4.0/">Docs for v0.4.0</a></li> - <li><a href="/documentation/0.5.0/">Docs for v0.5.0</a></li> <li><a href="/documentation/0.6.0/">Docs for v0.6.0</a></li> <li><a href="/documentation/0.7.0/">Docs for v0.7.0</a></li> + <li><a href="/documentation/0.8.0/">Docs for v0.8.0</a></li> <li><a href="/documentation/in-progress/">In Progress Docs for Contributors</a> </li> </ul> @@ -221,46 +220,46 @@ as a whole.</p> <h1 id="basic-usage">Basic Usage</h1> <p>The first step for a successful deployment is determining which features/plug-ins to enable:</p> -<pre class="highlight shell"><code><span class="gp">$ </span><span class="nb">test</span>-patch.sh --list-plugins -</code></pre> +<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>test-patch.sh <span class="nt">--list-plugins</span> +</code></pre></div> <p>This option will list all of the available plug-ins that are installed in the default location. From this list, the specific plug-ins can be enabled:</p> -<pre class="highlight shell"><code><span class="gp">$ </span><span class="nb">test</span>-patch.sh --plugins<span class="o">=</span><span class="s2">"ant,maven,shellcheck,xml"</span> <other options> -</code></pre> +<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>test-patch.sh <span class="nt">--plugins</span><span class="o">=</span><span class="s2">"ant,maven,shellcheck,xml"</span> <other options> +</code></pre></div> <p>As a short-cut, every plug-in may be enabled via the special ‘all’ type:</p> -<pre class="highlight shell"><code><span class="gp">$ </span><span class="nb">test</span>-patch.sh --plugins<span class="o">=</span><span class="s2">"all"</span> <other options> -</code></pre> +<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>test-patch.sh <span class="nt">--plugins</span><span class="o">=</span><span class="s2">"all"</span> <other options> +</code></pre></div> <p><code>--plugins</code> also allows some basic <q>arithmetic</q>:</p> -<pre class="highlight shell"><code><span class="gp">$ </span><span class="nb">test</span>-patch.sh --plugins<span class="o">=</span><span class="s2">"all,-checkstyle,-findbugs"</span> <other options> -</code></pre> +<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>test-patch.sh <span class="nt">--plugins</span><span class="o">=</span><span class="s2">"all,-checkstyle,-findbugs"</span> <other options> +</code></pre></div> <p>This will enable all plug-ins for potential usage, except for checkstyle and findbugs.</p> <p><strong>NOTE: The examples in this section will assume that the necessary <code>--plugins</code> option has been set on the command line as appropriate for your particular installation.</strong></p> <p>This command will execute basic patch testing against a patch file stored in <q>filename</q>:</p> -<pre class="highlight shell"><code><span class="gp">$ </span><span class="nb">cd</span> <your repo> -<span class="gp">$ </span><span class="nb">test</span>-patch.sh --dirty-workspace --project<span class="o">=</span>projectname <filename> -</code></pre> +<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span><span class="nb">cd</span> <your repo> +<span class="nv">$ </span>test-patch.sh <span class="nt">--dirty-workspace</span> <span class="nt">--project</span><span class="o">=</span>projectname <filename> +</code></pre></div> <p>The <code>--dirty-workspace</code> flag tells test-patch that the repository is not clean and it is ok to continue. By default, unit tests are not run since they may take a significant amount of time.</p> <p>To do turn them on, we need to provide the –run-tests option:</p> -<pre class="highlight shell"><code><span class="gp">$ </span><span class="nb">cd</span> <your repo> -<span class="gp">$ </span><span class="nb">test</span>-patch.sh --dirty-workspace --run-tests <filename> -</code></pre> +<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span><span class="nb">cd</span> <your repo> +<span class="nv">$ </span>test-patch.sh <span class="nt">--dirty-workspace</span> <span class="nt">--run-tests</span> <filename> +</code></pre></div> <p>This is the same command, but now runs the unit tests.</p> <p>A typical configuration is to have two repositories. One with the code you are working on and another, clean repository. This means you can:</p> -<pre class="highlight shell"><code><span class="gp">$ </span><span class="nb">cd</span> <workrepo> -<span class="gp">$ </span>git diff master > /tmp/patchfile -<span class="gp">$ </span><span class="nb">cd</span> ../<testrepo> -<span class="gp">$ </span><span class="nb">test</span>-patch.sh --basedir<span class="o">=</span><testrepo> --resetrepo /tmp/patchfile -</code></pre> +<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span><span class="nb">cd</span> <workrepo> +<span class="nv">$ </span>git diff master <span class="o">></span> /tmp/patchfile +<span class="nv">$ </span><span class="nb">cd</span> ../<testrepo> +<span class="nv">$ </span>test-patch.sh <span class="nt">--basedir</span><span class="o">=</span><testrepo> <span class="nt">--resetrepo</span> /tmp/patchfile +</code></pre></div> <p>We used two new options here. –basedir sets the location of the repository to use for testing. –resetrepo tells test patch that it can go into <strong>destructive</strong> mode. Destructive mode will wipe out any changes made to that repository, so use it with care!</p> <h1 id="fork-bomb-protection">Fork Bomb Protection</h1> <p>By default, test-patch.sh will set the user soft limit (ulimit -Su) to a relatively low 1,000 processes (and, on some operating systems with some languages such as Java, threads!). This is to prevent errant processes from eating up all system resources. If this limit is too low, it may be necessary to use the <code>--proclimit</code> option. For example:</p> -<pre class="highlight shell"><code><span class="gp">$ </span><span class="nb">test</span>-patch --proclimit<span class="o">=</span>10000 -</code></pre> +<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>test-patch <span class="nt">--proclimit</span><span class="o">=</span>10000 +</code></pre></div> <p>… will set it to be 10,000 processes.</p> <p>NOTE: The actual implementation of this feature is dependent upon the version of Bash. For bash v4 and higher (most operating systems), the fork bomb protection is generally only used for the build and QA tools. This means Apache Yetus should continue to function. For earlier versions of bash (e.g., OS X), the limit is applied to all of test-patch. If the limit is hit, Apache Yetus will itself likely crash.</p> @@ -270,24 +269,24 @@ as a whole.</p> <p>After the tests have run, there is a directory that contains all of the test-patch related artifacts. This is generally referred to as the patchprocess directory. By default, test-patch tries to make something off of /tmp to contain this content. Using the <code>--patch-dir</code> option, one can specify exactly which directory to use. This is helpful for automated precommit testing so that Jenkins or other automated workflow system knows where to look to gather up the output.</p> <p>For example:</p> -<pre class="highlight shell"><code><span class="gp">$ </span><span class="nb">test</span>-patch.sh --robot --patch-dir<span class="o">=</span><span class="k">${</span><span class="nv">WORKSPACE</span><span class="k">}</span>/patchprocess --basedir<span class="o">=</span><span class="k">${</span><span class="nv">WORKSPACE</span><span class="k">}</span>/source <span class="k">${</span><span class="nv">WORKSPACE</span><span class="k">}</span>/patchfile -</code></pre> +<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>test-patch.sh <span class="nt">--robot</span> <span class="nt">--patch-dir</span><span class="o">=</span><span class="k">${</span><span class="nv">WORKSPACE</span><span class="k">}</span>/patchprocess <span class="nt">--basedir</span><span class="o">=</span><span class="k">${</span><span class="nv">WORKSPACE</span><span class="k">}</span>/source <span class="k">${</span><span class="nv">WORKSPACE</span><span class="k">}</span>/patchfile +</code></pre></div> <p>… will trigger test-patch to run in fully automated mode, using ${WORKSPACE}/patchprocess as its scratch space, ${WORKSPACE}/source as the source repository, and ${WORKSPACE}/patchfile as the name of the patch to test against. This will always run the unit tests, write answers back to bug systems, remove old, stopped/exited Docker containers after 24 hours and images after 1 week, forcibly use –resetrepo, and more.</p> <p><strong>NOTE: Make sure to add the patch directory to <code>.gitignore</code> if the directory is inside the source tree to avoid deleting it, as <code>test-patch</code> does a <code>git clean</code> to remove untracked files from previous runs.</strong></p> <p>The –build-url option is also useful when running in –robot mode so that emails and such have a location to look at the output artifacts:</p> -<pre class="highlight shell"><code><span class="gp">$ </span><span class="nb">test</span>-patch.sh --robot --build-url<span class="o">=</span>http://server.example.name:80/<span class="k">${</span><span class="nv">buildnumber</span><span class="k">}</span>/ -</code></pre> +<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>test-patch.sh <span class="nt">--robot</span> <span class="nt">--build-url</span><span class="o">=</span>http://server.example.name:80/<span class="k">${</span><span class="nv">buildnumber</span><span class="k">}</span>/ +</code></pre></div> <p>Some plug-ins such as Maven have special handling if there are multiple executions of test-patch happening at once. It is very common when using automation systems to have multiple runs on the same host. In order to assist these plug-ins, an instance identifier may be provided:</p> -<pre class="highlight shell"><code><span class="gp">$ </span><span class="nb">test</span>-patch.sh --robot --instance<span class="o">=</span>1 -</code></pre> +<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>test-patch.sh <span class="nt">--robot</span> <span class="nt">--instance</span><span class="o">=</span>1 +</code></pre></div> <p>If –robot is specified without an instance, a random number is generated and used.</p> <p>There is some special handling if Jenkins is actually your automation tool. Instead of using –robot, use –jenkins:</p> -<pre class="highlight shell"><code><span class="gp">$ </span><span class="nb">test</span>-patch.sh --jenkins --patch-dir<span class="o">=</span><span class="k">${</span><span class="nv">WORKSPACE</span><span class="k">}</span>/patchprocess --basedir<span class="o">=</span><span class="k">${</span><span class="nv">WORKSPACE</span><span class="k">}</span>/source <span class="k">${</span><span class="nv">WORKSPACE</span><span class="k">}</span>/patchfile -</code></pre> +<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>test-patch.sh <span class="nt">--jenkins</span> <span class="nt">--patch-dir</span><span class="o">=</span><span class="k">${</span><span class="nv">WORKSPACE</span><span class="k">}</span>/patchprocess <span class="nt">--basedir</span><span class="o">=</span><span class="k">${</span><span class="nv">WORKSPACE</span><span class="k">}</span>/source <span class="k">${</span><span class="nv">WORKSPACE</span><span class="k">}</span>/patchfile +</code></pre></div> <p>This will enable –robot, set the –build-url option from the ${BUILD_URL} environment variable, and the instance identifier is set to the ${EXECUTOR_NUMBER}.</p> <p>If stuck containers are a problem, a more aggressive robot may be enabled with the –sentinel option. This option enables killing containers that have been running for over 24 hours as well.</p> @@ -295,8 +294,8 @@ have a location to look at the output artifacts:</p> <h1 id="build-tool">Build Tool</h1> <p>Out of the box, test-patch is built to use maven. But what if the project is built using something else, such as ant?</p> -<pre class="highlight shell"><code><span class="gp">$ </span><span class="nb">test</span>-patch.sh <span class="o">(</span>other options<span class="o">)</span> --build-tool<span class="o">=</span>ant -</code></pre> +<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>test-patch.sh <span class="o">(</span>other options<span class="o">)</span> <span class="nt">--build-tool</span><span class="o">=</span>ant +</code></pre></div> <p>will tell test-patch to use ant instead of maven to drive the project.</p> <h1 id="providing-patch-files">Providing Patch Files</h1> @@ -309,26 +308,26 @@ have a location to look at the output artifacts:</p> on the naming convention please refer to <a href="../precommit-patchnames/">patch-naming-conventions</a></strong></p> <p>For example:</p> -<pre class="highlight shell"><code><span class="gp">$ </span><span class="nb">test</span>-patch.sh <span class="o">(</span>other options<span class="o">)</span> HADOOP-9905 -</code></pre> +<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>test-patch.sh <span class="o">(</span>other options<span class="o">)</span> HADOOP-9905 +</code></pre></div> <p>… will process the patch file associated with this JIRA issue.</p> <p>If the Apache JIRA system is not in use, then override options may be provided on the command line to point to a different JIRA instance.</p> -<pre class="highlight shell"><code><span class="gp">$ </span><span class="nb">test</span>-patch.sh --jira-issue-re<span class="o">=</span><span class="s1">'^PROJECT-[0-9]+$'</span> --jira-base-url<span class="o">=</span><span class="s1">'https://example.com/jira'</span> PROJECT-90 -</code></pre> +<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>test-patch.sh <span class="nt">--jira-issue-re</span><span class="o">=</span><span class="s1">'^PROJECT-[0-9]+$'</span> <span class="nt">--jira-base-url</span><span class="o">=</span><span class="s1">'https://example.com/jira'</span> PROJECT-90 +</code></pre></div> <p>… will process the patch file attached to PROJECT-90 on the JIRA instance located on the example.com server.</p> <h2 id="github">GITHUB</h2> <p>test-patch has some basic support for Github. test-patch supports many forms of providing pull requests to work on:</p> -<pre class="highlight shell"><code><span class="gp">$ </span><span class="nb">test</span>-patch.sh --github-repo<span class="o">=</span>apache/pig GH:99 -</code></pre> +<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>test-patch.sh <span class="nt">--github-repo</span><span class="o">=</span>apache/pig GH:99 +</code></pre></div> <p>or</p> -<pre class="highlight shell"><code><span class="gp">$ </span><span class="nb">test</span>-patch.sh https://github.com/apache/pig/pulls/99 -</code></pre> +<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>test-patch.sh https://github.com/apache/pig/pulls/99 +</code></pre></div> <p>or</p> -<pre class="highlight shell"><code><span class="gp">$ </span><span class="nb">test</span>-patch.sh https://github.com/apache/pig/pulls/99.patch -</code></pre> +<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>test-patch.sh https://github.com/apache/pig/pulls/99.patch +</code></pre></div> <p>… will process PR #99 on the apache/pig repo.</p> <h2 id="generic-urls">Generic URLs</h2> @@ -336,8 +335,8 @@ have a location to look at the output artifacts:</p> <p>Luckily, test-patch supports ways to provide unified diffs via URLs.</p> <p>For example:</p> -<pre class="highlight shell"><code><span class="gp">$ </span><span class="nb">test</span>-patch.sh <span class="o">(</span>other options<span class="o">)</span> https://example.com/webserver/file.patch -</code></pre> +<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>test-patch.sh <span class="o">(</span>other options<span class="o">)</span> https://example.com/webserver/file.patch +</code></pre></div> <p>… will download and process the file.patch from the example.com webserver.</p> <h1 id="project-specific-capabilities">Project-specific Capabilities</h1> @@ -345,20 +344,20 @@ have a location to look at the output artifacts:</p> <p>Due to the extensible nature of the system, test-patch allows for projects to define project-specific rules which we call personalities. (How to build those rules is covered elsewhere.) There are two ways to specify which personality to use:</p> <h2 id="direct-method">Direct Method</h2> -<pre class="highlight shell"><code><span class="gp">$ </span><span class="nb">test</span>-patch.sh <span class="o">(</span>other options<span class="o">)</span> --personality<span class="o">=(</span>filename<span class="o">)</span> -</code></pre> +<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>test-patch.sh <span class="o">(</span>other options<span class="o">)</span> <span class="nt">--personality</span><span class="o">=(</span>filename<span class="o">)</span> +</code></pre></div> <p>This tells test-patch to use the personality in the given file.</p> <h2 id="project-method">Project Method</h2> <p>However, test-patch can detect if it is a personality that is in its <q>personality</q> directory based upon the project name:</p> -<pre class="highlight shell"><code><span class="gp">$ </span><span class="nb">test</span>-patch.sh <span class="o">(</span>other options<span class="o">)</span> --project<span class="o">=(</span>project<span class="o">)</span> -</code></pre> +<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>test-patch.sh <span class="o">(</span>other options<span class="o">)</span> <span class="nt">--project</span><span class="o">=(</span>project<span class="o">)</span> +</code></pre></div> <h1 id="multijdk">MultiJDK</h1> <p>For many projects, it is useful to test Java code against multiple versions of JDKs at the same time. test-patch can do this with the –multijdkdirs option:</p> -<pre class="highlight shell"><code><span class="gp">$ </span><span class="nb">test</span>-patch.sh <span class="o">(</span>other options<span class="o">)</span> --multijdkdirs<span class="o">=</span><span class="s2">"/j/d/k/1,/j/d/k/2"</span> -</code></pre> +<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>test-patch.sh <span class="o">(</span>other options<span class="o">)</span> <span class="nt">--multijdkdirs</span><span class="o">=</span><span class="s2">"/j/d/k/1,/j/d/k/2"</span> +</code></pre></div> <p>Not all Java tests support this mode, but those that do will now run their tests with all of the given versions of Java consecutively (e.g., javac–the Java compliation test). Tests that do not support MultiJDK mode (e.g., checkstyle, mvn install) will use JAVA_HOME.</p> <p>NOTE: JAVA_HOME is always appended to the list of JDKs in MultiJDK mode. If JAVA_HOME is in the list, it will be moved to the end.</p> @@ -366,8 +365,8 @@ have a location to look at the output artifacts:</p> <h1 id="docker">Docker</h1> <p>test-patch also has a mode to utilize Docker:</p> -<pre class="highlight shell"><code><span class="gp">$ </span><span class="nb">test</span>-patch.sh <span class="o">(</span>other options<span class="o">)</span> --docker -</code></pre> +<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>test-patch.sh <span class="o">(</span>other options<span class="o">)</span> <span class="nt">--docker</span> +</code></pre></div> <p>This will do some preliminary setup and then re-execute itself inside a Docker container. For more information on how to provide a custom Dockerfile and other Docker-specific features, see the advanced guide.</p> <h1 id="in-closing">In Closing</h1> http://git-wip-us.apache.org/repos/asf/yetus/blob/4a356e40/documentation/0.7.0/precommit-bugsystems/index.html ---------------------------------------------------------------------- diff --git a/documentation/0.7.0/precommit-bugsystems/index.html b/documentation/0.7.0/precommit-bugsystems/index.html index ff0be92..a918fb5 100644 --- a/documentation/0.7.0/precommit-bugsystems/index.html +++ b/documentation/0.7.0/precommit-bugsystems/index.html @@ -53,10 +53,9 @@ <li class="dropdown"> <a class="dropdown-toggle" data-toggle="dropdown" href="#">Documentation <span class="caret"></span></a> <ul class="dropdown-menu" role="menu"> - <li><a href="/documentation/0.4.0/">Docs for v0.4.0</a></li> - <li><a href="/documentation/0.5.0/">Docs for v0.5.0</a></li> <li><a href="/documentation/0.6.0/">Docs for v0.6.0</a></li> <li><a href="/documentation/0.7.0/">Docs for v0.7.0</a></li> + <li><a href="/documentation/0.8.0/">Docs for v0.8.0</a></li> <li><a href="/documentation/in-progress/">In Progress Docs for Contributors</a> </li> </ul> @@ -124,8 +123,8 @@ <h1 id="bug-system-support">Bug System Support</h1> <p>test-patch has the ability to support multiple bug systems. Bug tools have some extra hooks to fetch patches, line-level reporting, and posting a final report. Every bug system plug-in must have one line in order to be recognized:</p> -<pre class="highlight shell"><code>add_bugsystem <pluginname> -</code></pre> +<div class="highlight"><pre class="highlight shell"><code>add_bugsystem <pluginname> +</code></pre></div> <ul> <li><p>pluginname_locate_patch</p> @@ -162,8 +161,8 @@ <h1 id="bugzilla-specific">Bugzilla Specific</h1> <p>Currently, Bugzilla support is read-only. To use it, the Bug ID must be preferenced with ‘BZ:’. For example:</p> -<pre class="highlight shell"><code><span class="gp">$ </span><span class="nb">test</span>-patch.sh <span class="o">(</span>other options<span class="o">)</span> BZ:4 -</code></pre> +<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>test-patch.sh <span class="o">(</span>other options<span class="o">)</span> BZ:4 +</code></pre></div> <p>… will pull down Bugzilla ID #4.</p> <p>Using the <code>--bugzilla-base-url</code> on the command line or BUGZILLA_BASE_URL in a project’s personality will define the location of the Bugzilla instance. By default, it is <a href="https://bz.apache.org/bugzilla";>https://bz.apache.org/bugzilla</a> .</p> http://git-wip-us.apache.org/repos/asf/yetus/blob/4a356e40/documentation/0.7.0/precommit-buildtools/index.html ---------------------------------------------------------------------- diff --git a/documentation/0.7.0/precommit-buildtools/index.html b/documentation/0.7.0/precommit-buildtools/index.html index 113bcf4..d7f7818 100644 --- a/documentation/0.7.0/precommit-buildtools/index.html +++ b/documentation/0.7.0/precommit-buildtools/index.html @@ -53,10 +53,9 @@ <li class="dropdown"> <a class="dropdown-toggle" data-toggle="dropdown" href="#">Documentation <span class="caret"></span></a> <ul class="dropdown-menu" role="menu"> - <li><a href="/documentation/0.4.0/">Docs for v0.4.0</a></li> - <li><a href="/documentation/0.5.0/">Docs for v0.5.0</a></li> <li><a href="/documentation/0.6.0/">Docs for v0.6.0</a></li> <li><a href="/documentation/0.7.0/">Docs for v0.7.0</a></li> + <li><a href="/documentation/0.8.0/">Docs for v0.8.0</a></li> <li><a href="/documentation/in-progress/">In Progress Docs for Contributors</a> </li> </ul> @@ -124,8 +123,8 @@ <h1 id="build-tool-support">Build Tool Support</h1> <p>test-patch has the ability to support multiple build tools. Build tool plug-ins have some extra hooks to do source and object maintenance at key points. Every build tool plug-in must have one line in order to be recognized:</p> -<pre class="highlight shell"><code>add_build_tool <pluginname> -</code></pre> +<div class="highlight"><pre class="highlight shell"><code>add_build_tool <pluginname> +</code></pre></div> <h1 id="global-variables">Global Variables</h1> <ul> @@ -147,8 +146,8 @@ </ul> <p>This allows for custom directories to be created and used as necessary.</p> -<pre class="highlight plaintext"><code>The default is module. -</code></pre> +<div class="highlight"><pre class="highlight plaintext"><code>The default is module. +</code></pre></div> <ul> <li><p>UNSUPPORTED_TEST</p> http://git-wip-us.apache.org/repos/asf/yetus/blob/4a356e40/documentation/0.7.0/precommit-docker-cleanup/index.html ---------------------------------------------------------------------- diff --git a/documentation/0.7.0/precommit-docker-cleanup/index.html b/documentation/0.7.0/precommit-docker-cleanup/index.html index 8cfe9c7..01d8648 100644 --- a/documentation/0.7.0/precommit-docker-cleanup/index.html +++ b/documentation/0.7.0/precommit-docker-cleanup/index.html @@ -53,10 +53,9 @@ <li class="dropdown"> <a class="dropdown-toggle" data-toggle="dropdown" href="#">Documentation <span class="caret"></span></a> <ul class="dropdown-menu" role="menu"> - <li><a href="/documentation/0.4.0/">Docs for v0.4.0</a></li> - <li><a href="/documentation/0.5.0/">Docs for v0.5.0</a></li> <li><a href="/documentation/0.6.0/">Docs for v0.6.0</a></li> <li><a href="/documentation/0.7.0/">Docs for v0.7.0</a></li> + <li><a href="/documentation/0.8.0/">Docs for v0.8.0</a></li> <li><a href="/documentation/in-progress/">In Progress Docs for Contributors</a> </li> </ul> @@ -128,7 +127,7 @@ <h1 id="usage">Usage</h1> <p>Executing <code>docker-cleanup</code> will peform the same Docker image as the <code>--robot</code> option.</p> -<pre class="highlight shell"><code><span class="gp">$ </span>docker-cleanup +<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>docker-cleanup ... Removing old images @@ -139,9 +138,9 @@ Deleted: sha256:1a96c79a0a9ab538c6c7765dc908eca3e689270b778d6ae2add558e89792a7d8 Docker Container Maintenance ... -</code></pre> +</code></pre></div> <p><code>docker-cleanup</code> also supports the <code>--sentinel</code> mode to kill and remove stale running containers:</p> -<pre class="highlight shell"><code><span class="gp">$ </span>docker-cleanup --sentinel +<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>docker-cleanup <span class="nt">--sentinel</span> ... Removing old images @@ -154,7 +153,7 @@ Deleted: sha256:1a96c79a0a9ab538c6c7765dc908eca3e689270b778d6ae2add558e89792a7d8 ... Attempting to remove docker container /big_kowalevski <span class="o">[</span>5ffd22a56ebcfe38d72b9078e0e7133ab6dc054115a4804e504c910bdbdeea45] ... -</code></pre> +</code></pre></div> </div> <div class="container"> <hr> http://git-wip-us.apache.org/repos/asf/yetus/blob/4a356e40/documentation/0.7.0/precommit-glossary/index.html ---------------------------------------------------------------------- diff --git a/documentation/0.7.0/precommit-glossary/index.html b/documentation/0.7.0/precommit-glossary/index.html index 2ca8a5f..40dadd7 100644 --- a/documentation/0.7.0/precommit-glossary/index.html +++ b/documentation/0.7.0/precommit-glossary/index.html @@ -53,10 +53,9 @@ <li class="dropdown"> <a class="dropdown-toggle" data-toggle="dropdown" href="#">Documentation <span class="caret"></span></a> <ul class="dropdown-menu" role="menu"> - <li><a href="/documentation/0.4.0/">Docs for v0.4.0</a></li> - <li><a href="/documentation/0.5.0/">Docs for v0.5.0</a></li> <li><a href="/documentation/0.6.0/">Docs for v0.6.0</a></li> <li><a href="/documentation/0.7.0/">Docs for v0.7.0</a></li> + <li><a href="/documentation/0.8.0/">Docs for v0.8.0</a></li> <li><a href="/documentation/in-progress/">In Progress Docs for Contributors</a> </li> </ul> http://git-wip-us.apache.org/repos/asf/yetus/blob/4a356e40/documentation/0.7.0/precommit-patchnames/index.html ---------------------------------------------------------------------- diff --git a/documentation/0.7.0/precommit-patchnames/index.html b/documentation/0.7.0/precommit-patchnames/index.html index 92a1138..9d03030 100644 --- a/documentation/0.7.0/precommit-patchnames/index.html +++ b/documentation/0.7.0/precommit-patchnames/index.html @@ -53,10 +53,9 @@ <li class="dropdown"> <a class="dropdown-toggle" data-toggle="dropdown" href="#">Documentation <span class="caret"></span></a> <ul class="dropdown-menu" role="menu"> - <li><a href="/documentation/0.4.0/">Docs for v0.4.0</a></li> - <li><a href="/documentation/0.5.0/">Docs for v0.5.0</a></li> <li><a href="/documentation/0.6.0/">Docs for v0.6.0</a></li> <li><a href="/documentation/0.7.0/">Docs for v0.7.0</a></li> + <li><a href="/documentation/0.8.0/">Docs for v0.8.0</a></li> <li><a href="/documentation/in-progress/">In Progress Docs for Contributors</a> </li> </ul> http://git-wip-us.apache.org/repos/asf/yetus/blob/4a356e40/documentation/0.7.0/precommit-qbt/index.html ---------------------------------------------------------------------- diff --git a/documentation/0.7.0/precommit-qbt/index.html b/documentation/0.7.0/precommit-qbt/index.html index b8be172..1d3bf67 100644 --- a/documentation/0.7.0/precommit-qbt/index.html +++ b/documentation/0.7.0/precommit-qbt/index.html @@ -53,10 +53,9 @@ <li class="dropdown"> <a class="dropdown-toggle" data-toggle="dropdown" href="#">Documentation <span class="caret"></span></a> <ul class="dropdown-menu" role="menu"> - <li><a href="/documentation/0.4.0/">Docs for v0.4.0</a></li> - <li><a href="/documentation/0.5.0/">Docs for v0.5.0</a></li> <li><a href="/documentation/0.6.0/">Docs for v0.6.0</a></li> <li><a href="/documentation/0.7.0/">Docs for v0.7.0</a></li> + <li><a href="/documentation/0.8.0/">Docs for v0.8.0</a></li> <li><a href="/documentation/in-progress/">In Progress Docs for Contributors</a> </li> </ul> @@ -136,12 +135,12 @@ scheduled build as part of your overall development strategy.</p> <code>--console-report-file</code> option to send the summary email to a file. This can then be used with systems like Jenkin’s email-ext plug-in to send the output as an emailed report:</p> -<pre class="highlight plaintext"><code>${FILE,path="<report-file-path>"} -</code></pre> +<div class="highlight"><pre class="highlight plaintext"><code>${FILE,path="<report-file-path>"} +</code></pre></div> <p>For something a bit more structured, there is also the <code>--html-report-file</code> option. Using this output, again with Jenkins’ email-ext plug-in, it is possible to build some very nice looking output that is easily customized:</p> -<pre class="highlight html"><code><span class="nt"><html></span> +<div class="highlight"><pre class="highlight html"><code><span class="nt"><html></span> <span class="nt"><head></span> <span class="nt"><style></span> <span class="nt">table</span> <span class="p">{</span> @@ -159,7 +158,7 @@ possible to build some very nice looking output that is easily customized:</p> <span class="nt"><p></p></span> ${FILE,path="<span class="nt"><report-file-path></span>"} <span class="nt"></body></html></span> -</code></pre> +</code></pre></div> <p>If your mailing lists do not allow HTML-formatted email, then the <code>--brief-report-file</code> provides a solution. This option creates a very plain, reduced content text file suitable for email. It contains just the barebones information needed to get http://git-wip-us.apache.org/repos/asf/yetus/blob/4a356e40/documentation/0.7.0/precommit-smart-apply-patch/index.html ---------------------------------------------------------------------- diff --git a/documentation/0.7.0/precommit-smart-apply-patch/index.html b/documentation/0.7.0/precommit-smart-apply-patch/index.html index 42e26e5..d35539e 100644 --- a/documentation/0.7.0/precommit-smart-apply-patch/index.html +++ b/documentation/0.7.0/precommit-smart-apply-patch/index.html @@ -53,10 +53,9 @@ <li class="dropdown"> <a class="dropdown-toggle" data-toggle="dropdown" href="#">Documentation <span class="caret"></span></a> <ul class="dropdown-menu" role="menu"> - <li><a href="/documentation/0.4.0/">Docs for v0.4.0</a></li> - <li><a href="/documentation/0.5.0/">Docs for v0.5.0</a></li> <li><a href="/documentation/0.6.0/">Docs for v0.6.0</a></li> <li><a href="/documentation/0.7.0/">Docs for v0.7.0</a></li> + <li><a href="/documentation/0.8.0/">Docs for v0.8.0</a></li> <li><a href="/documentation/in-progress/">In Progress Docs for Contributors</a> </li> </ul> @@ -128,16 +127,16 @@ <h1 id="usage">Usage</h1> <p>Its simplest form is used when a patch is stored in a local file:</p> -<pre class="highlight shell"><code><span class="gp">$ </span>smart-apply-patch patch -</code></pre> +<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>smart-apply-patch patch +</code></pre></div> <p>This will cause the command to run through various ways to verify and then apply the patch to the current repo, including deducing a patch level.</p> <p>Perhaps you just want to see if the patch even applies without changing your local repo. The <code>--dry-run</code> option will just test for applicability:</p> -<pre class="highlight shell"><code><span class="gp">$ </span>smart-apply-patch --dry-run patch -</code></pre> +<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>smart-apply-patch <span class="nt">--dry-run</span> patch +</code></pre></div> <p>For committers of projects, there is a special mode:</p> -<pre class="highlight shell"><code><span class="gp">$ </span>smart-apply-patch --committer patch -</code></pre> +<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>smart-apply-patch <span class="nt">--committer</span> patch +</code></pre></div> <p>that in addition to applying the patch will also attempt to:</p> <ul> http://git-wip-us.apache.org/repos/asf/yetus/blob/4a356e40/documentation/0.7.0/precommit-testformats/index.html ---------------------------------------------------------------------- diff --git a/documentation/0.7.0/precommit-testformats/index.html b/documentation/0.7.0/precommit-testformats/index.html index ea8092d..0586f24 100644 --- a/documentation/0.7.0/precommit-testformats/index.html +++ b/documentation/0.7.0/precommit-testformats/index.html @@ -53,10 +53,9 @@ <li class="dropdown"> <a class="dropdown-toggle" data-toggle="dropdown" href="#">Documentation <span class="caret"></span></a> <ul class="dropdown-menu" role="menu"> - <li><a href="/documentation/0.4.0/">Docs for v0.4.0</a></li> - <li><a href="/documentation/0.5.0/">Docs for v0.5.0</a></li> <li><a href="/documentation/0.6.0/">Docs for v0.6.0</a></li> <li><a href="/documentation/0.7.0/">Docs for v0.7.0</a></li> + <li><a href="/documentation/0.8.0/">Docs for v0.8.0</a></li> <li><a href="/documentation/in-progress/">In Progress Docs for Contributors</a> </li> </ul> @@ -124,8 +123,8 @@ <h1 id="test-format-support">Test Format Support</h1> <p>test-patch has the ability to support multiple test formats. Test formats have some extra hooks to process the output of test tools and write the results to some tables. Every test format plug-in must have one line in order to be recognized:</p> -<pre class="highlight shell"><code>add_test_format <pluginname> -</code></pre> +<div class="highlight"><pre class="highlight shell"><code>add_test_format <pluginname> +</code></pre></div> <p>Test format plugins can provide following two methods, which will be called by test-patch if defined.</p> <ul> http://git-wip-us.apache.org/repos/asf/yetus/blob/4a356e40/documentation/0.7.0/releasedocmaker/index.html ---------------------------------------------------------------------- diff --git a/documentation/0.7.0/releasedocmaker/index.html b/documentation/0.7.0/releasedocmaker/index.html index 3ba9762..ba0a642 100644 --- a/documentation/0.7.0/releasedocmaker/index.html +++ b/documentation/0.7.0/releasedocmaker/index.html @@ -53,10 +53,9 @@ <li class="dropdown"> <a class="dropdown-toggle" data-toggle="dropdown" href="#">Documentation <span class="caret"></span></a> <ul class="dropdown-menu" role="menu"> - <li><a href="/documentation/0.4.0/">Docs for v0.4.0</a></li> - <li><a href="/documentation/0.5.0/">Docs for v0.5.0</a></li> <li><a href="/documentation/0.6.0/">Docs for v0.6.0</a></li> <li><a href="/documentation/0.7.0/">Docs for v0.7.0</a></li> + <li><a href="/documentation/0.8.0/">Docs for v0.8.0</a></li> <li><a href="/documentation/in-progress/">In Progress Docs for Contributors</a> </li> </ul> @@ -162,8 +161,8 @@ <h1 id="basic-usage">Basic Usage</h1> <p>Minimally, the name of the JIRA project and a version registered in JIRA must be provided:</p> -<pre class="highlight shell"><code><span class="gp">$ </span>releasedocmaker --project <span class="o">(</span>project<span class="o">)</span> --version <span class="o">(</span>version<span class="o">)</span> -</code></pre> +<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>releasedocmaker <span class="nt">--project</span> <span class="o">(</span>project<span class="o">)</span> <span class="nt">--version</span> <span class="o">(</span>version<span class="o">)</span> +</code></pre></div> <p>This will query Apache JIRA, generating two files in a directory named after the given version in an extended markdown format which can be processed by both mvn site and GitHub.</p> <ul> @@ -179,44 +178,44 @@ <p>If your JIRA project supports the release note field, this will contain any JIRA mentioned in the CHANGELOG that is either an incompatible change or has a release note associated with it. If your JIRA project does not support the release notes field, this will be the description field.</p> <p>For example, to build the release documentation for HBase v1.2.0:</p> -<pre class="highlight shell"><code><span class="gp">$ </span>releasedocmaker --project HBASE --version 1.2.0 -</code></pre> +<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>releasedocmaker <span class="nt">--project</span> HBASE <span class="nt">--version</span> 1.2.0 +</code></pre></div> <p>By default, release notes are expected to be in plain text. However, you can write them in markdown if you include a header at the top of your release note:</p> -<pre class="highlight xml"><code><span class="c"><!-- markdown --></span> +<div class="highlight"><pre class="highlight xml"><code><span class="c"><!-- markdown --></span> remaining text -</code></pre> +</code></pre></div> <h1 id="changing-the-header">Changing the Header</h1> <p>By default, it will use a header that matches the project name. But that is kind of ugly and the case may be wrong. Luckily, the title can be changed:</p> -<pre class="highlight shell"><code><span class="gp">$ </span>releasedocmaker --project HBASE --version 1.2.0 --projecttitle <span class="s2">"Apache HBase"</span> -</code></pre> +<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>releasedocmaker <span class="nt">--project</span> HBASE <span class="nt">--version</span> 1.2.0 <span class="nt">--projecttitle</span> <span class="s2">"Apache HBase"</span> +</code></pre></div> <p>Now instead of <q>HBASE</q>, it will use <q>Apache HBase</q> for some titles and headers.</p> <h1 id="versioned-files-and-directories">Versioned Files and Directories</h1> <p>It is sometimes useful to create the CHANGELOG and RELEASENOTES with versions attached. <code>releasedocmaker</code> supports both independently.</p> -<pre class="highlight shell"><code><span class="gp">$ </span>releasedocmaker --project HBASE --version 1.2.0 --fileversions -</code></pre> +<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>releasedocmaker <span class="nt">--project</span> HBASE <span class="nt">--version</span> 1.2.0 <span class="nt">--fileversions</span> +</code></pre></div> <p>This command line will now create CHANGELOG.1.2.0.md and RELEASENOTES.1.2.0.md files.</p> -<pre class="highlight shell"><code><span class="gp">$ </span>releasedocmaker --project HBASE --version 1.2.0 --dirversions -</code></pre> +<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>releasedocmaker <span class="nt">--project</span> HBASE <span class="nt">--version</span> 1.2.0 <span class="nt">--dirversions</span> +</code></pre></div> <p>This command line will now create a directory called 1.2.0 and inside will be the CHANGELOG.md and RELEASENOTES.md files.</p> <p>Using both at the same time…</p> -<pre class="highlight shell"><code><span class="gp">$ </span>releasedocmaker --project HBASE --version 1.2.0 --fileversions --dirversions -</code></pre> +<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>releasedocmaker <span class="nt">--project</span> HBASE <span class="nt">--version</span> 1.2.0 <span class="nt">--fileversions</span> <span class="nt">--dirversions</span> +</code></pre></div> <p>… results in 1.2.0/CHANGELOG.1.2.0.md and 1.2.0/RELEASENOTES.1.2.0.md files.</p> <h1 id="multiple-versions">Multiple Versions</h1> <p>Using either <code>--dirversions</code> or <code>--fileversions</code> or both simultaneously, <code>releasedocmaker</code> can also generate multiple versions at once</p> -<pre class="highlight shell"><code><span class="gp">$ </span>releasedocmaker --project HBASE --version 1.0.0 --version 1.2.0 --dirversions -</code></pre> +<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>releasedocmaker <span class="nt">--project</span> HBASE <span class="nt">--version</span> 1.0.0 <span class="nt">--version</span> 1.2.0 <span class="nt">--dirversions</span> +</code></pre></div> <p>This will create the files for versions 1.0.0 and versions 1.2.0 in their own directories.</p> <p>But what if the version numbers are not known? releasedocmaker can also generate version data based upon ranges:</p> -<pre class="highlight shell"><code><span class="gp">$ </span>releasedocmaker --project HBASE --version 1.0.0 --version 1.2.0 --range --fileversions -</code></pre> +<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>releasedocmaker <span class="nt">--project</span> HBASE <span class="nt">--version</span> 1.0.0 <span class="nt">--version</span> 1.2.0 <span class="nt">--range</span> <span class="nt">--fileversions</span> +</code></pre></div> <p>In this form, releasedocmaker will query JIRA, discover all versions that alphabetically appear to be between 1.0.0 and 1.2.0, inclusive, and generate all of the relative release documents. This is especially useful when bootstrapping an existing project.</p> <h1 id="unreleased-dates">Unreleased Dates</h1> @@ -224,8 +223,8 @@ remaining text <p>For released versions, releasedocmaker will pull the date of the release from JIRA. However, for unreleased versions it marks the release as <q>Unreleased</q>. This can be inconvenient when actually building a release and wanting to include it inside the source package.</p> <p>The –usetoday option can be used to signify that instead of using Unreleased, releasedocmaker should use today’s date.</p> -<pre class="highlight shell"><code><span class="gp">$ </span>releasedocmaker --project HBASE --version 1.0.0 --usetoday -</code></pre> +<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>releasedocmaker <span class="nt">--project</span> HBASE <span class="nt">--version</span> 1.0.0 <span class="nt">--usetoday</span> +</code></pre></div> <p>After using this option and release, don’t forget to change JIRA’s release date to match!</p> <h1 id="sorted-output">Sorted Output</h1> @@ -235,23 +234,23 @@ remaining text <h2 id="resolution-date-base-sort">Resolution Date-base Sort</h2> <p>By default, releasedocmaker will sort the output based upon the resolution date of the issue starting with older resolutions. This is the same as giving these options:</p> -<pre class="highlight shell"><code><span class="gp">$ </span>releasedocmaker --project falcon --version 0.6 --sorttype resolutiondate --sortorder older -</code></pre> +<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>releasedocmaker <span class="nt">--project</span> falcon <span class="nt">--version</span> 0.6 <span class="nt">--sorttype</span> resolutiondate <span class="nt">--sortorder</span> older +</code></pre></div> <p>The order can be reversed so that newer issues appear on top by providing the ‘newer’ flag:</p> -<pre class="highlight shell"><code><span class="gp">$ </span>releasedocmaker --project falcon --version 0.6 --sorttype resolutiondate --sortorder newer -</code></pre> +<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>releasedocmaker <span class="nt">--project</span> falcon <span class="nt">--version</span> 0.6 <span class="nt">--sorttype</span> resolutiondate <span class="nt">--sortorder</span> newer +</code></pre></div> <p>In the case of multiple projects given on the command line, the projects will be interspersed.</p> <h2 id="issue-number-based-sort">Issue Number-based Sort</h2> <p>An alternative to the date-based sort is to sort based upon the issue id. This may be accomplished via:</p> -<pre class="highlight shell"><code><span class="gp">$ </span>releasedocmaker --project falcon --version 0.6 --sorttype issueid --sortorder asc -</code></pre> +<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>releasedocmaker <span class="nt">--project</span> falcon <span class="nt">--version</span> 0.6 <span class="nt">--sorttype</span> issueid <span class="nt">--sortorder</span> asc +</code></pre></div> <p>This will now sort by the issue id, listing them in lowest to highest (or ascending) order.</p> <p>The order may be reversed to list them in highest to lowest (or descending) order by providing the appropriate flag:</p> -<pre class="highlight shell"><code><span class="gp">$ </span>releasedocmaker --project falcon --version 0.6 --sorttype issueid --sortorder desc -</code></pre> +<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>releasedocmaker <span class="nt">--project</span> falcon <span class="nt">--version</span> 0.6 <span class="nt">--sorttype</span> issueid <span class="nt">--sortorder</span> desc +</code></pre></div> <p>In the case of multiple projects given on the command line, the projects will be grouped and then sorted by issue id.</p> <h1 id="backward-incompatible-changes">Backward Incompatible Changes</h1> @@ -259,18 +258,18 @@ remaining text <p>To check if an issue is backward-incompatible the releasedocmaker script first checks the <q>Hadoop Flags</q> field in the issue. If this field is found to be blank then it searches for the ‘backward-incompatible’ label. You can override the default value for this label by using –incompatiblelabel option e.g.</p> -<pre class="highlight shell"><code><span class="gp">$ </span>releasedocmaker --project falcon --version 0.6 --incompatiblelabel not-compatible -</code></pre> +<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>releasedocmaker <span class="nt">--project</span> falcon <span class="nt">--version</span> 0.6 <span class="nt">--incompatiblelabel</span> not-compatible +</code></pre></div> <p>or equivalently using the shorter -X option</p> -<pre class="highlight shell"><code><span class="gp">$ </span>releasedocmaker --project falcon --version 0.6 -X not-compatible -</code></pre> +<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>releasedocmaker <span class="nt">--project</span> falcon <span class="nt">--version</span> 0.6 <span class="nt">-X</span> not-compatible +</code></pre></div> <h1 id="lint-mode">Lint Mode</h1> <p>In order to ensure proper formatting while using mvn site, releasedocmaker puts in periods (.) for fields that are empty or unassigned. This can be unsightly and not proper for any given project. There are also other things, such as missing release notes for incompatible changes, that are less than desirable.</p> <p>In order to help release managers from having to scan through potentially large documents, releasedocmaker features a lint mode, triggered via –lint:</p> -<pre class="highlight shell"><code><span class="gp">$ </span>releasedocmaker --project HBASE --version 1.0.0 --lint -</code></pre> +<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>releasedocmaker <span class="nt">--project</span> HBASE <span class="nt">--version</span> 1.0.0 <span class="nt">--lint</span> +</code></pre></div> <p>This will do the normal JIRA querying, looking for items it considers problematic. It will print the information to the screen and then exit with either success or failure, depending upon if any issues were discovered.</p> <h1 id="index-mode">Index Mode</h1> @@ -286,8 +285,8 @@ For example directories with names like 0.6, 1.2.2, 1.2alpha etc. will all be li <h1 id="release-version">Release Version</h1> <p>You can find the version of the releasedocmaker that you are using by giving the -V option. This may be helpful in finding documentation for the version you are using.</p> -<pre class="highlight shell"><code><span class="gp">$ </span>releasedocmaker -V -</code></pre> +<div class="highlight"><pre class="highlight shell"><code><span class="nv">$ </span>releasedocmaker <span class="nt">-V</span> +</code></pre></div> </div> <div class="container"> <hr>
