|
|
Boost-Commit : |
Subject: [Boost-commit] svn:boost r81188 - trunk/libs/test/doc/src
From: gennadiy.rozental_at_[hidden]
Date: 2012-11-04 23:54:38
Author: rogeeff
Date: 2012-11-04 23:54:38 EST (Sun, 04 Nov 2012)
New Revision: 81188
URL: http://svn.boost.org/trac/boost/changeset/81188
Log:
reworked glossary
Text files modified:
trunk/libs/test/doc/src/btl.xml | 1
trunk/libs/test/doc/src/utf.user-guide.glossary.xml | 147 +++++++++++++++++++--------------------
2 files changed, 74 insertions(+), 74 deletions(-)
Modified: trunk/libs/test/doc/src/btl.xml
==============================================================================
--- trunk/libs/test/doc/src/btl.xml (original)
+++ trunk/libs/test/doc/src/btl.xml 2012-11-04 23:54:38 EST (Sun, 04 Nov 2012)
@@ -21,6 +21,7 @@
<year>2009</year>
<year>2010</year>
<year>2011</year>
+ <year>2012</year>
<holder>Gennadiy Rozental</holder>
</copyright>
Modified: trunk/libs/test/doc/src/utf.user-guide.glossary.xml
==============================================================================
--- trunk/libs/test/doc/src/utf.user-guide.glossary.xml (original)
+++ trunk/libs/test/doc/src/utf.user-guide.glossary.xml 2012-11-04 23:54:38 EST (Sun, 04 Nov 2012)
@@ -3,19 +3,18 @@
<!ENTITY utf "<acronym>UTF</acronym>">
]>
<section id="utf.user-guide.glossary">
- <title>Glossary … or what's your name?</title><titleabbrev>Glossary</titleabbrev>
+ <titleabbrev>Glossary</titleabbrev>
- <para role="first-line-indented">
- Here the list of terms used throughout the this documentation.
- </para>
- <variablelist>
- <?dbhtml term-width="16%" list-width="100%"?>
- <?dbhtml term-separator=":"?>
- <?dbhtml table-summary="utf terms definition"?>
+ <glossary>
+ <title>Glossary … or what's your name?</title>
- <varlistentry id="test-module.def">
- <term><firstterm>The test module</firstterm></term>
- <listitem>
+ <para role="first-line-indented">
+ Here is the list of terms used throughout this documentation.
+ </para>
+
+ <glossentry id="test-module.def">
+ <glossterm><firstterm>The test module</firstterm></glossterm>
+ <glossdef>
<simpara>
This is a single binary that performs the test. Physically a test module consists of one or more test source files,
which can be built into an executable or a dynamic library. A test module that consists of a single test source
@@ -27,40 +26,40 @@
an executable the test runner is built-in. If a test module is built as a dynamic library, it is run by an
external test runner.
</simpara>
- </listitem>
- </varlistentry>
- <varlistentry id="test-body.def">
- <term><firstterm>The test body</firstterm></term>
- <listitem>
+ </glossdef>
+ </glossentry>
+ <glossentry id="test-body.def">
+ <glossterm><firstterm>The test body</firstterm></glossterm>
+ <glossdef>
<simpara>
This is the part of a test module that actually performs the test.
Logically test body is a collection of <link linkend="test-assertion.def">test assertions</link> wrapped in
<link linkend="test-case.def">test cases</link>, which are organized in a <link linkend="test-tree.def">test tree
</link>.
</simpara>
- </listitem>
- </varlistentry>
- <varlistentry id="test-tree.def">
- <term><firstterm>The test tree</firstterm></term>
- <listitem>
+ </glossdef>
+ </glossentry>
+ <glossentry id="test-tree.def">
+ <glossterm><firstterm>The test tree</firstterm></glossterm>
+ <glossdef>
<simpara>
This is a hierarchical structure of <link linkend="test-suite.def">test suites</link> (non-leaf nodes) and
<link linkend="test-case.def">test cases</link> (leaf nodes).
</simpara>
- </listitem>
- </varlistentry>
- <varlistentry id="test-unit.def">
- <term><firstterm>The test unit</firstterm></term>
- <listitem>
+ </glossdef>
+ </glossentry>
+ <glossentry id="test-unit.def">
+ <glossterm><firstterm>The test unit</firstterm></glossterm>
+ <glossdef>
<simpara>
This is a collective name when referred to either <link linkend="test-suite.def">test suite</link> or
<link linkend="test-case.def">test case</link>
</simpara>
- </listitem>
- </varlistentry>
- <varlistentry id="test-assertion.def">
- <term><firstterm>Test assertion</firstterm></term>
- <listitem>
+ </glossdef>
+ </glossentry>
+ <glossentry id="test-assertion.def">
+ <glossterm><firstterm>Test assertion</firstterm></glossterm>
+ <glossdef>
<simpara>
This is a single binary condition (binary in a sense that is has two outcomes: pass and fail) checked
by a test module.
@@ -71,11 +70,11 @@
assertions within single test case - advocated by those only interested in the first error in a
test module. The &utf; supports both approaches.
</simpara>
- </listitem>
- </varlistentry>
- <varlistentry id="test-case.def">
- <term><firstterm>The test case</firstterm></term>
- <listitem>
+ </glossdef>
+ </glossentry>
+ <glossentry id="test-case.def">
+ <glossterm><firstterm>The test case</firstterm></glossterm>
+ <glossdef>
<simpara>
This is an independently monitored function within a test module that
consists of one or more test assertions. The term "independently monitored" in the definition above is
@@ -84,11 +83,11 @@
case execution monitor, reported by the &utf; and testing proceeds to the next test case. Later on you are going
to see that this is on of the primary reasons to prefer multiple small test cases to a single big test function.
</simpara>
- </listitem>
- </varlistentry>
- <varlistentry id="test-suite.def">
- <term><firstterm>The test suite</firstterm></term>
- <listitem>
+ </glossdef>
+ </glossentry>
+ <glossentry id="test-suite.def">
+ <glossterm><firstterm>The test suite</firstterm></glossterm>
+ <glossdef>
<simpara>
This is a container for one or more test cases. The test suite gives you an ability to group
test cases into a single referable entity. There are various reasons why you may opt to do so, including:
@@ -115,11 +114,11 @@
The &utf; requires the test tree to contain at least one test suite with at least one test case. The top level
test suite - root node of the test tree - is called the master test suite.
</simpara>
- </listitem>
- </varlistentry>
- <varlistentry id="test-setup.def">
- <term><firstterm>The test setup</firstterm></term>
- <listitem>
+ </glossdef>
+ </glossentry>
+ <glossentry id="test-setup.def">
+ <glossterm><firstterm>The test setup</firstterm></glossterm>
+ <glossdef>
<simpara>
This is the part of a test module that is responsible for the test
preparation. It includes the following operations that take place prior to a start of the test:
@@ -145,27 +144,27 @@
Per test case" setup code, invoked for every test case it's assigned to, is also attributed to the
test initialization, even though it's executed as a part of the test case.
</simpara>
- </listitem>
- </varlistentry>
- <varlistentry id="test-cleanup.def">
- <term><firstterm>The test cleanup</firstterm></term>
- <listitem>
+ </glossdef>
+ </glossentry>
+ <glossentry id="test-cleanup.def">
+ <glossterm><firstterm>The test cleanup</firstterm></glossterm>
+ <glossdef>
<simpara>
This is the part of test module that is responsible for cleanup operations.
</simpara>
- </listitem>
- </varlistentry>
- <varlistentry id="test-fixture.def">
- <term><firstterm>The test fixture</firstterm></term>
- <listitem>
+ </glossdef>
+ </glossentry>
+ <glossentry id="test-fixture.def">
+ <glossterm><firstterm>The test fixture</firstterm></glossterm>
+ <glossdef>
<simpara>
Matching setup and cleanup operations are frequently united into a single entity called test fixture.
</simpara>
- </listitem>
- </varlistentry>
- <varlistentry id="test-runner.def">
- <term><firstterm>The test runner</firstterm></term>
- <listitem>
+ </glossdef>
+ </glossentry>
+ <glossentry id="test-runner.def">
+ <glossterm><firstterm>The test runner</firstterm></glossterm>
+ <glossdef>
<simpara>
This is an "executive manager" that runs the show. The test runner's functionality should include
the following interfaces and operations:
@@ -212,24 +211,24 @@
An advanced test runner may provide additional features, including interactive <acronym>GUI</acronym> interfaces,
test coverage and profiling support.
</para>
- </listitem>
- </varlistentry>
- <varlistentry id="test-log.def">
- <term><firstterm>The test log</firstterm></term>
- <listitem>
+ </glossdef>
+ </glossentry>
+ <glossentry id="test-log.def">
+ <glossterm><firstterm>The test log</firstterm></glossterm>
+ <glossdef>
<simpara>
This is the record of all events that occur during the testing.
</simpara>
- </listitem>
- </varlistentry>
- <varlistentry id="test-results-report.def">
- <term><firstterm>The test results report</firstterm></term>
- <listitem>
+ </glossdef>
+ </glossentry>
+ <glossentry id="test-results-report.def">
+ <glossterm><firstterm>The test results report</firstterm></glossterm>
+ <glossdef>
<simpara>
This is the report produced by the &utf; after the testing is completed, that indicates which test cases/test
suites passed and which failed.
</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
+ </glossdef>
+ </glossentry>
+ </glossary>
</section>
Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk