libs/test/doc/html/boost_test/utf_reference/rt_param_reference/report_format.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>report_format</title>
   5 <link rel="stylesheet" href="../../../boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   7 <link rel="home" href="../../../index.html" title="Boost.Test">
   8 <link rel="up" href="../rt_param_reference.html" title="Runtime parameters reference">
   9 <link rel="prev" href="random.html" title="random">
  10 <link rel="next" href="report_level.html" title="report_level">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="random.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../rt_param_reference.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="report_level.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h4 class="title">
  27 <a name="boost_test.utf_reference.rt_param_reference.report_format"></a><a class="link" href="report_format.html" title="report_format"><code class="computeroutput"><span class="identifier">report_format</span></code></a>
  28 </h4></div></div></div>
  29 <p>
  30           Parameter <span class="emphasis"><em>report_format</em></span> allows to set the <span class="emphasis"><em>Unit
  31           Test Framework</em></span> report format to one of the formats supplied
  32           by the framework. To specify a custom report format use unit_test_report
  33           API.
  34         </p>
  35 <p>
  36           The only acceptable values for this parameter are the names of the output
  37           formats. By default the framework uses human readable format (HRF) for
  38           results reporting. Alternatively you can specify XML as report format.
  39           This format is easier to process by testing automation tools.
  40         </p>
  41 <h5>
  42 <a name="boost_test.utf_reference.rt_param_reference.report_format.h0"></a>
  43           <span class="phrase"><a name="boost_test.utf_reference.rt_param_reference.report_format.acceptable_values"></a></span><a class="link" href="report_format.html#boost_test.utf_reference.rt_param_reference.report_format.acceptable_values">Acceptable
  44           values</a>
  45         </h5>
  46 <p>
  47           <a class="link" href="../rt_param_reference.html#enum_param_value">Enumeration</a> names:
  48         </p>
  49 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  50 <li class="listitem">
  51               <span class="bold"><strong>HRF</strong></span> (default)
  52             </li>
  53 <li class="listitem">
  54               XML
  55             </li>
  56 </ul></div>
  57 <h5>
  58 <a name="boost_test.utf_reference.rt_param_reference.report_format.h1"></a>
  59           <span class="phrase"><a name="boost_test.utf_reference.rt_param_reference.report_format.command_line_syntax"></a></span><a class="link" href="report_format.html#boost_test.utf_reference.rt_param_reference.report_format.command_line_syntax">Command
  60           line syntax</a>
  61         </h5>
  62 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  63 <li class="listitem">
  64               <code class="computeroutput"><span class="special">--</span><span class="identifier">report_format</span><span class="special">=&lt;</span><span class="identifier">format</span><span class="special">&gt;</span></code>
  65             </li>
  66 <li class="listitem">
  67               <code class="computeroutput"><span class="special">-</span><span class="identifier">m</span>
  68               <span class="special">&lt;</span><span class="identifier">format</span><span class="special">&gt;</span></code>
  69             </li>
  70 </ul></div>
  71 <h5>
  72 <a name="boost_test.utf_reference.rt_param_reference.report_format.h2"></a>
  73           <span class="phrase"><a name="boost_test.utf_reference.rt_param_reference.report_format.environment_variable"></a></span><a class="link" href="report_format.html#boost_test.utf_reference.rt_param_reference.report_format.environment_variable">Environment
  74           variable</a>
  75         </h5>
  76 <pre class="programlisting"><span class="identifier">BOOST_TEST_REPORT_FORMAT</span>
  77 </pre>
  78 </div>
  79 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  80 <td align="left"></td>
  81 <td align="right"><div class="copyright-footer">Copyright &#169; 2001-2019 Boost.Test
  82       contributors<p>
  83         Distributed under the Boost Software License, Version 1.0. (See accompanying
  84         file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
  85       </p>
  86 </div></td>
  87 </tr></table>
  88 <hr>
  89 <div class="spirit-nav">
  90 <a accesskey="p" href="random.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../rt_param_reference.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="report_level.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  91 </div>
  92 </body>
  93 </html>