libs/test/doc/html/boost_test/test_output/log_formats.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Log formats</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="../test_output.html" title="Controlling outputs">
   9 <link rel="prev" href="test_tools_support_for_logging/log_floating_points.html" title="Logging floating point type numbers">
  10 <link rel="next" href="log_formats/test_log_output.html" title="Test log output">
  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="test_tools_support_for_logging/log_floating_points.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../test_output.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="log_formats/test_log_output.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h3 class="title">
  27 <a name="boost_test.test_output.log_formats"></a><a class="link" href="log_formats.html" title="Log formats">Log formats</a>
  28 </h3></div></div></div>
  29 <div class="toc"><dl class="toc">
  30 <dt><span class="section"><a href="log_formats/test_log_output.html">Test
  31         log output</a></span></dt>
  32 <dt><span class="section"><a href="log_formats/log_human_readable_format.html">HRF:
  33         Human readable log format</a></span></dt>
  34 <dt><span class="section"><a href="log_formats/log_xml_format.html">XML
  35         log format</a></span></dt>
  36 <dt><span class="section"><a href="log_formats/log_junit_format.html">JUNIT
  37         log format</a></span></dt>
  38 </dl></div>
  39 <p>
  40         The <span class="emphasis"><em>Unit Test Framework</em></span> supports several log formats:
  41       </p>
  42 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  43 <li class="listitem">
  44             <a class="link" href="log_formats/log_human_readable_format.html" title="HRF: Human readable log format">HRF</a>:
  45             human readable format
  46           </li>
  47 <li class="listitem">
  48             <a class="link" href="log_formats/log_xml_format.html" title="XML log format">XML</a>:
  49             an machine interpretable log format
  50           </li>
  51 <li class="listitem">
  52             <a class="link" href="log_formats/log_junit_format.html" title="JUNIT log format">JUNIT</a>:
  53             a standardized log format understandable by automated tools such as Continuous
  54             Builds
  55           </li>
  56 </ul></div>
  57 <h5>
  58 <a name="boost_test.test_output.log_formats.h0"></a>
  59         <span class="phrase"><a name="boost_test.test_output.log_formats.design"></a></span><a class="link" href="log_formats.html#boost_test.test_output.log_formats.design">Design</a>
  60       </h5>
  61 <p>
  62         The following functionalities are supported by the logging framework:
  63       </p>
  64 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  65 <li class="listitem">
  66             each logger manages its own log level. The rationale is that some log
  67             format are meant for automated processing, and by design need to carry
  68             all the information that will later be digested by a visualization tool.
  69           </li>
  70 <li class="listitem">
  71             several log format may be active at the same time. The rationale is that
  72             the user might want to see a non-exhaustive log in his terminal using
  73             a human friendly format, while having a detailed full log in a file with
  74             a format dedicated to automated processing.
  75           </li>
  76 <li class="listitem">
  77             each logger <span class="emphasis"><em>indicates</em></span> its default output stream.
  78             some logger may prefer to output to one of the standard stream while
  79             other may prefer output to a file.
  80           </li>
  81 </ul></div>
  82 <div class="note"><table border="0" summary="Note">
  83 <tr>
  84 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../doc/src/images/note.png"></td>
  85 <th align="left">Note</th>
  86 </tr>
  87 <tr><td align="left" valign="top"><p>
  88           The logger indicates the default output stream in case the default should
  89           be used.
  90         </p></td></tr>
  91 </table></div>
  92 <h5>
  93 <a name="boost_test.test_output.log_formats.h1"></a>
  94         <span class="phrase"><a name="boost_test.test_output.log_formats.defaults"></a></span><a class="link" href="log_formats.html#boost_test.test_output.log_formats.defaults">Defaults</a>
  95       </h5>
  96 <p>
  97         By default the active log level threshold is set to
  98       </p>
  99 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
 100 <li class="listitem">
 101             <a class="link" href="log_formats/test_log_output.html" title="Test log output">"non
 102             fatal error messages"</a> and the test log output is generated
 103             in <a class="link" href="log_formats/log_human_readable_format.html" title="HRF: Human readable log format">human
 104             readable format</a>.
 105           </li>
 106 <li class="listitem">
 107             <a class="link" href="log_formats/test_log_output.html" title="Test log output">"general
 108             information"</a> for <a class="link" href="log_formats/log_junit_format.html" title="JUNIT log format">JUNIT</a>
 109             log format
 110           </li>
 111 </ul></div>
 112 <p>
 113         The active log level threshold and the output format can be configured at
 114         runtime during a test module invocation and at compile time from within a
 115         test module using the <a class="link" href="logging_api.html" title="Logging API">test
 116         log public interfaces</a>. The behavior is logger specific though.
 117       </p>
 118 </div>
 119 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 120 <td align="left"></td>
 121 <td align="right"><div class="copyright-footer">Copyright &#169; 2001-2019 Boost.Test
 122       contributors<p>
 123         Distributed under the Boost Software License, Version 1.0. (See accompanying
 124         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>)
 125       </p>
 126 </div></td>
 127 </tr></table>
 128 <hr>
 129 <div class="spirit-nav">
 130 <a accesskey="p" href="test_tools_support_for_logging/log_floating_points.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../test_output.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="log_formats/test_log_output.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 131 </div>
 132 </body>
 133 </html>