documentation/0.16.0-SNAPSHOT/precommit/qbt/index.html - yetus - Git at Google

 <!---
   Licensed to the Apache Software Foundation (ASF) under one
   or more contributor license agreements.  See the NOTICE file
   distributed with this work for additional information
   regarding copyright ownership.  The ASF licenses this file
   to you under the Apache License, Version 2.0 (the
   "License"); you may not use this file except in compliance
   with the License.  You may obtain a copy of the License at

     http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing,
   software distributed under the License is distributed on an
   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
   KIND, either express or implied.  See the License for the
   specific language governing permissions and limitations
   under the License.
 -->

 <html>
     <head>
         <meta charset="utf-8">
         <title>Apache Yetus</title>
         <meta name="viewport" content="width=device-width, initial-scale=1.0">
         <meta name="description" content="">
         <meta name="author" content="">

         <link href="../../../../assets/css/bootstrap.css" rel="stylesheet">
         <link href="../../../../assets/css/bootstrap-theme.css" rel="stylesheet">
         <link href="../../../../assets/css/font-awesome.css" rel="stylesheet">

         <!-- JS -->
         <script type="text/javascript" src="../../../../assets/js/jquery-2.1.4.min.js"></script>
         <script type="text/javascript" src="../../../../assets/js/bootstrap.js"></script>
   </head>
     <body>

 <div class="navbar navbar-inverse navbar-static-top" role="navigation">
     <div class="container">
         <div class="navbar-header">
             <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
                 <span class="sr-only">Toggle navigation</span>
                 <span class="icon-bar"></span>
                 <span class="icon-bar"></span>
                 <span class="icon-bar"></span>
             </button>
             <a class="img-responsive pull-left" href="/">
                 <img style="max-height: 40px; margin-top: 5px; margin-bottom: 5px;" src="../../../../assets/img/yetus_logo.png" alt="Apache Yetus logo" />
             </a>
         </div>
         <div class="navbar-collapse collapse">
             <ul class="nav navbar-nav">
                 <li><a href="/downloads/">Downloads</a>
                 <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.13.0/">Docs for v0.13.0</a></li>
                       <li><a href="/documentation/0.14.1/">Docs for v0.14.1</a></li>
                       <li><a href="/documentation/0.15.0/">Docs for v0.15.0</a></li>
                       <li><a href="/documentation/in-progress/">In Progress Docs for Contributors</a>
                       </li>
                       <li><a href="/documentation/history/">History of the Project</a>
                       </li>
                     </ul>
                 </li>
                 <li class="dropdown">
                     <a class="dropdown-toggle" data-toggle="dropdown" href="#">Get Involved <span class="caret"></span></a>
                     <ul class="dropdown-menu" role="menu" aria-labelledby="drop1">
                         <li role="presentation"><a role="menuitem" tabindex="-1" href="/mailinglists"><i class="fa fa-commenting"></i> Mailing Lists</a>
                         </li>
                         <li role="presentation"><a role="menuitem" tabindex="-1" href="https://issues.apache.org/jira/browse/YETUS"><i class="fa fa-bug"></i> JIRA (Bugs)</a>
                         </li>
                         <li role="presentation"><a role="menuitem" tabindex="-1" href="https://gitbox.apache.org/repos/asf/yetus.git"><i class="fa fa-code"></i> Source (Apache)</a>
                         </li>
                         <li role="presentation"><a role="menuitem" tabindex="-1" href="https://github.com/apache/yetus"><i class="fa fa-github-alt"></i> Source (GitHub)</a>
                         </li>
                         <li role="presentation"><a role="menuitem" tabindex="-1" href="/contribute/"><i class="fa fa-code-fork"></i> Contributing</a>
                         </li>
                         <li role="presentation"><a role="menuitem" tabindex="-1" href="https://twitter.com/ApacheYetus"><i class="fa fa-twitter"></i> @ApacheYetus</a>
                         </li>
                     </ul>
                 </li>
                 <li>
                     <li class="dropdown">
                         <a class="dropdown-toggle" data-toggle="dropdown" href="#">Apache Software Foundation <b class="caret"></b></a>
                         <ul class="dropdown-menu" role="menu">
                             <li><a href="https://www.apache.org">Apache Homepage</a>
                             </li>
                             <li><a href="https://www.apache.org/licenses/">Apache License</a>
                             </li>
                             <li><a href="https://www.apache.org/foundation/sponsorship.html">Sponsorship</a>
                             </li>
                             <li><a href="https://www.apache.org/foundation/thanks.html">Thanks</a>
                             </li>
                             <li><a href="https://www.apache.org/security/">Security</a>
                             </li>
                         </ul>
                     </li>
                 </li>
             </ul>
         </div>
         <!--/.nav-collapse -->
     </div>
 </div>

       <div class="container">
         <!---
   Licensed to the Apache Software Foundation (ASF) under one
   or more contributor license agreements.  See the NOTICE file
   distributed with this work for additional information
   regarding copyright ownership.  The ASF licenses this file
   to you under the Apache License, Version 2.0 (the
   "License"); you may not use this file except in compliance
   with the License.  You may obtain a copy of the License at

     http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing,
   software distributed under the License is distributed on an
   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
   KIND, either express or implied.  See the License for the
   specific language governing permissions and limitations
   under the License.
 -->

 <h1 id="qbt">qbt</h1>

 <!-- MarkdownTOC levels="1,2" autolink="true" indent="  " bullets="*" bracket="round" -->

 <ul>
   <li><a href="#reporting">Reporting</a></li>
   <li><a href="#archiving">Archiving</a></li>
 </ul>

 <!-- /MarkdownTOC -->

 <p><code>qbt</code> is a command to execute <code>test-patch</code> without a patch.  It uses<br />
 the same plug-ins and the same options as <code>test-patch</code>.  The only<br />
 difference is that no patch file, location, etc should be supplied.<br />
 It is meant to be a way to easily get <code>test-patch</code>'s output on your<br />
 current source tree.  It is suitable to be run as a regularly<br />
 scheduled build as part of your overall development strategy.</p>

 <h1 id="reporting">Reporting</h1>

 <p>When using an automation tool, it may be useful to use the<br />
 <code>--console-report-file</code> option to send the summary email to a<br />
 file. This can then be used with systems like Jenkin's<br />
 email-ext plug-in to send the output as an emailed report:</p>

 <div class="highlight"><pre class="highlight plaintext"><code>${FILE,path="&lt;report-file-path&gt;"}
 </code></pre></div>
 <p>For something a bit more structured, there is also the <code>--html-report-file</code><br />
 option.  Using this output, again with Jenkins' email-ext plug-in, it is<br />
 possible to build some very nice looking output that is easily customized:</p>

 <div class="highlight"><pre class="highlight html"><code><span class="nt">&lt;html&gt;</span>
 <span class="nt">&lt;head&gt;</span>
 <span class="nt">&lt;style&gt;</span>
 <span class="nt">table</span> <span class="p">{</span>
     <span class="nl">border-collapse</span><span class="p">:</span> <span class="nb">collapse</span><span class="p">;</span>
 <span class="p">}</span>
 <span class="nt">table</span><span class="o">,</span> <span class="nt">th</span><span class="o">,</span> <span class="nt">td</span> <span class="p">{</span>
    <span class="nl">border</span><span class="p">:</span> <span class="m">1px</span> <span class="nb">solid</span> <span class="no">black</span><span class="p">;</span>
 <span class="p">}</span>
 <span class="nt">tr</span><span class="nd">:nth-child</span><span class="o">(</span><span class="nt">even</span><span class="o">)</span><span class="p">{</span><span class="nl">background-color</span><span class="p">:</span> <span class="m">#f2f2f2</span><span class="p">}</span>
 <span class="nt">&lt;/style&gt;</span>
 <span class="nt">&lt;/head&gt;</span>
 <span class="nt">&lt;body&gt;</span>
 <span class="nt">&lt;p&gt;</span>See the <span class="nt">&lt;a</span> <span class="na">href=</span><span class="s">"${BUILD_URL}"</span><span class="nt">&gt;</span>Jenkins Build<span class="nt">&lt;/a&gt;</span> for more information.<span class="nt">&lt;/p&gt;</span>
 <span class="nt">&lt;p&gt;</span>${CHANGES, format="<span class="nt">&lt;div&gt;</span>[%d] (%a) %m<span class="nt">&lt;/div&gt;</span>"}<span class="nt">&lt;/p&gt;</span>
 <span class="nt">&lt;p&gt;&lt;/p&gt;</span>
 ${FILE,path="<span class="nt">&lt;report-file-path&gt;</span>"}
 <span class="nt">&lt;/body&gt;&lt;/html&gt;</span>
 </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 information on failures: what voted -1, what tests failed, what subsystems are long running (configurable with the <code>--brief-report-long</code> option), and a list of any attached log files.</p>

 <p>NOTE: Be aware that ASF mailing lists do not allow HTML formatted email.</p>

 <h1 id="archiving">Archiving</h1>

 <p>It may be useful to save off certain files while qbt is running for more<br />
 post-processing by another utility.  If the <code>rsync</code> command is available,<br />
 then the archiving functionality may be used.</p>

 <p>The <code>--archive-list</code> option takes a comma separated list of <code>find -name</code><br />
 patterns and copies them to the patch directory's archiver subdirectory.<br />
 It will preserve the directory structure of the source tree so that<br />
 multiple matching file names will be preserved.</p>

     </div>

 <div class="container">
     <hr>
     <footer class="footer">
         <div class="row-fluid">
             <div class="span12 text-left">
               <div class="span12">
                 Copyright 2008-2023 <a href="https://www.apache.org/">Apache Software Foundation</a>. Licensed under the <a href="https://www.apache.org/licenses/">Apache License v2.0</a>. Apache Yetus and the Apache feather logo are trademarks of The Apache Software Foundation.
               </div>
             </div>

         </div>

     </footer>
 </div>

   </body>
 </html>
	<!---
	Licensed to the Apache Software Foundation (ASF) under one
	or more contributor license agreements. See the NOTICE file
	distributed with this work for additional information
	regarding copyright ownership. The ASF licenses this file
	to you under the Apache License, Version 2.0 (the
	"License"); you may not use this file except in compliance
	with the License. You may obtain a copy of the License at

	http://www.apache.org/licenses/LICENSE-2.0

	Unless required by applicable law or agreed to in writing,
	software distributed under the License is distributed on an
	"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
	KIND, either express or implied. See the License for the
	specific language governing permissions and limitations
	under the License.
	-->

	<html>
	<head>
	<meta charset="utf-8">
	<title>Apache Yetus</title>
	<meta name="viewport" content="width=device-width, initial-scale=1.0">
	<meta name="description" content="">
	<meta name="author" content="">

	<link href="../../../../assets/css/bootstrap.css" rel="stylesheet">
	<link href="../../../../assets/css/bootstrap-theme.css" rel="stylesheet">
	<link href="../../../../assets/css/font-awesome.css" rel="stylesheet">

	<!-- JS -->
	<script type="text/javascript" src="../../../../assets/js/jquery-2.1.4.min.js"></script>
	<script type="text/javascript" src="../../../../assets/js/bootstrap.js"></script>
	</head>
	<body>

	<div class="navbar navbar-inverse navbar-static-top" role="navigation">
	<div class="container">
	<div class="navbar-header">
	<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
	<span class="sr-only">Toggle navigation</span>
	<span class="icon-bar"></span>
	<span class="icon-bar"></span>
	<span class="icon-bar"></span>
	</button>
	<a class="img-responsive pull-left" href="/">
	<img style="max-height: 40px; margin-top: 5px; margin-bottom: 5px;" src="../../../../assets/img/yetus_logo.png" alt="Apache Yetus logo" />
	</a>
	</div>
	<div class="navbar-collapse collapse">
	<ul class="nav navbar-nav">
	<li><a href="/downloads/">Downloads</a>
	<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.13.0/">Docs for v0.13.0</a></li>
	<li><a href="/documentation/0.14.1/">Docs for v0.14.1</a></li>
	<li><a href="/documentation/0.15.0/">Docs for v0.15.0</a></li>
	<li><a href="/documentation/in-progress/">In Progress Docs for Contributors</a>
	</li>
	<li><a href="/documentation/history/">History of the Project</a>
	</li>
	</ul>
	</li>
	<li class="dropdown">
	<a class="dropdown-toggle" data-toggle="dropdown" href="#">Get Involved <span class="caret"></span></a>
	<ul class="dropdown-menu" role="menu" aria-labelledby="drop1">
	<li role="presentation"><a role="menuitem" tabindex="-1" href="/mailinglists"><i class="fa fa-commenting"></i> Mailing Lists</a>
	</li>
	<li role="presentation"><a role="menuitem" tabindex="-1" href="https://issues.apache.org/jira/browse/YETUS"><i class="fa fa-bug"></i> JIRA (Bugs)</a>
	</li>
	<li role="presentation"><a role="menuitem" tabindex="-1" href="https://gitbox.apache.org/repos/asf/yetus.git"><i class="fa fa-code"></i> Source (Apache)</a>
	</li>
	<li role="presentation"><a role="menuitem" tabindex="-1" href="https://github.com/apache/yetus"><i class="fa fa-github-alt"></i> Source (GitHub)</a>
	</li>
	<li role="presentation"><a role="menuitem" tabindex="-1" href="/contribute/"><i class="fa fa-code-fork"></i> Contributing</a>
	</li>
	<li role="presentation"><a role="menuitem" tabindex="-1" href="https://twitter.com/ApacheYetus"><i class="fa fa-twitter"></i> @ApacheYetus</a>
	</li>
	</ul>
	</li>
	<li>
	<li class="dropdown">
	<a class="dropdown-toggle" data-toggle="dropdown" href="#">Apache Software Foundation <b class="caret"></b></a>
	<ul class="dropdown-menu" role="menu">
	<li><a href="https://www.apache.org">Apache Homepage</a>
	</li>
	<li><a href="https://www.apache.org/licenses/">Apache License</a>
	</li>
	<li><a href="https://www.apache.org/foundation/sponsorship.html">Sponsorship</a>
	</li>
	<li><a href="https://www.apache.org/foundation/thanks.html">Thanks</a>
	</li>
	<li><a href="https://www.apache.org/security/">Security</a>
	</li>
	</ul>
	</li>
	</li>
	</ul>
	</div>
	<!--/.nav-collapse -->
	</div>
	</div>

	<div class="container">
	<!---
	Licensed to the Apache Software Foundation (ASF) under one
	or more contributor license agreements. See the NOTICE file
	distributed with this work for additional information
	regarding copyright ownership. The ASF licenses this file
	to you under the Apache License, Version 2.0 (the
	"License"); you may not use this file except in compliance
	with the License. You may obtain a copy of the License at

	http://www.apache.org/licenses/LICENSE-2.0

	Unless required by applicable law or agreed to in writing,
	software distributed under the License is distributed on an
	"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
	KIND, either express or implied. See the License for the
	specific language governing permissions and limitations
	under the License.
	-->

	<h1 id="qbt">qbt</h1>

	<!-- MarkdownTOC levels="1,2" autolink="true" indent=" " bullets="*" bracket="round" -->

	<ul>
	<li><a href="#reporting">Reporting</a></li>
	<li><a href="#archiving">Archiving</a></li>
	</ul>

	<!-- /MarkdownTOC -->

	<p><code>qbt</code> is a command to execute <code>test-patch</code> without a patch. It uses<br />
	the same plug-ins and the same options as <code>test-patch</code>. The only<br />
	difference is that no patch file, location, etc should be supplied.<br />
	It is meant to be a way to easily get <code>test-patch</code>'s output on your<br />
	current source tree. It is suitable to be run as a regularly<br />
	scheduled build as part of your overall development strategy.</p>

	<h1 id="reporting">Reporting</h1>

	<p>When using an automation tool, it may be useful to use the<br />
	<code>--console-report-file</code> option to send the summary email to a<br />
	file. This can then be used with systems like Jenkin's<br />
	email-ext plug-in to send the output as an emailed report:</p>

	<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><br />
	option. Using this output, again with Jenkins' email-ext plug-in, it is<br />
	possible to build some very nice looking output that is easily customized:</p>

	<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>
	<span class="nl">border-collapse</span><span class="p">:</span> <span class="nb">collapse</span><span class="p">;</span>
	<span class="p">}</span>
	<span class="nt">table</span><span class="o">,</span> <span class="nt">th</span><span class="o">,</span> <span class="nt">td</span> <span class="p">{</span>
	<span class="nl">border</span><span class="p">:</span> <span class="m">1px</span> <span class="nb">solid</span> <span class="no">black</span><span class="p">;</span>
	<span class="p">}</span>
	<span class="nt">tr</span><span class="nd">:nth-child</span><span class="o">(</span><span class="nt">even</span><span class="o">)</span><span class="p">{</span><span class="nl">background-color</span><span class="p">:</span> <span class="m">#f2f2f2</span><span class="p">}</span>
	<span class="nt"></style></span>
	<span class="nt"></head></span>
	<span class="nt"><body></span>
	<span class="nt"><p></span>See the <span class="nt"><a</span> <span class="na">href=</span><span class="s">"${BUILD_URL}"</span><span class="nt">></span>Jenkins Build<span class="nt"></a></span> for more information.<span class="nt"></p></span>
	<span class="nt"><p></span>${CHANGES, format="<span class="nt"><div></span>[%d] (%a) %m<span class="nt"></div></span>"}<span class="nt"></p></span>
	<span class="nt"><p></p></span>
	${FILE,path="<span class="nt"><report-file-path></span>"}
	<span class="nt"></body></html></span>
	</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 information on failures: what voted -1, what tests failed, what subsystems are long running (configurable with the <code>--brief-report-long</code> option), and a list of any attached log files.</p>

	<p>NOTE: Be aware that ASF mailing lists do not allow HTML formatted email.</p>

	<h1 id="archiving">Archiving</h1>

	<p>It may be useful to save off certain files while qbt is running for more<br />
	post-processing by another utility. If the <code>rsync</code> command is available,<br />
	then the archiving functionality may be used.</p>

	<p>The <code>--archive-list</code> option takes a comma separated list of <code>find -name</code><br />
	patterns and copies them to the patch directory's archiver subdirectory.<br />
	It will preserve the directory structure of the source tree so that<br />
	multiple matching file names will be preserved.</p>

	</div>

	<div class="container">
	<hr>
	<footer class="footer">
	<div class="row-fluid">
	<div class="span12 text-left">
	<div class="span12">
	Copyright 2008-2023 <a href="https://www.apache.org/">Apache Software Foundation</a>. Licensed under the <a href="https://www.apache.org/licenses/">Apache License v2.0</a>. Apache Yetus and the Apache feather logo are trademarks of The Apache Software Foundation.
	</div>
	</div>

	</div>

	</footer>
	</div>

	</body>
	</html>