Skip to content

Commit

Permalink
Fixed some formatting and a typo.
Browse files Browse the repository at this point in the history
This patch closes issue 124.
  • Loading branch information
atomgalaxy committed Oct 22, 2017
1 parent bf4957a commit 5b63e77
Showing 1 changed file with 31 additions and 19 deletions.
50 changes: 31 additions & 19 deletions doc/guide.txt
Original file line number Diff line number Diff line change
Expand Up @@ -402,7 +402,10 @@ This test runner generates the following output:
----
include::examples/buildRunner7.txt[]
----
The default filename for the XML results is +TEST-cxxtest.xml+. The +--xunit-file+ option can be used to specify an alternative filename. Additionally, the value of the +--world+ option can be used to specify the filename +TEST-<world>.xml+.
The default filename for the XML results is +TEST-cxxtest.xml+. The
+--xunit-file+ option can be used to specify an alternative filename.
Additionally, the value of the +--world+ option can be used to specify the
filename +TEST-<world>.xml+.
Language Options
Expand Down Expand Up @@ -437,12 +440,14 @@ for compilers or linkers that have trouble compiling the default test runner.
Creating Test Runners from Parts
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The default behavior of +cxxtestgen+ is to generate a test runner
that directly integrates classes that define the tests along with
a +main()+ function that executes all test suites. It is often useful to
allow test suites to be processes separately and then linked together. The +--root+ and +--part+ options
support this logic. For example, suppose that we wish to define a test runner for tests in the headers
MyTestSuite1.h+ and +MyTestSuite2.h+. We execute +cxxtestgen+ with the +--part+ option to generate source files for each of the test suites:
The default behavior of +cxxtestgen+ is to generate a test runner that directly
integrates classes that define the tests along with a +main()+ function that
executes all test suites. It is often useful to allow test suites to be
processes separately and then linked together. The +--root+ and +--part+
options support this logic. For example, suppose that we wish to define a test
runner for tests in the headers MyTestSuite1.h+ and +MyTestSuite2.h+. We
execute +cxxtestgen+ with the +--part+ option to generate source files for each
of the test suites:
[source,bash]
----
include::examples/.buildRunner9_part.sh[]
Expand Down Expand Up @@ -479,7 +484,8 @@ For example, consider the following template file:
----
include::examples/runner10.tpl[]
----
This file specifies macros that customize the test runner, and output is generated before and after the tests are run.
This file specifies macros that customize the test runner, and output is
generated before and after the tests are run.
Note that CxxTest needs to insert certain definitions and +#include+
directives in the runner file. It normally does that before the
Expand Down Expand Up @@ -1194,7 +1200,18 @@ of Python: 2.4 - 3.3, though future releases will not support
Python 2.4. Note that this script has only been tested with the
CPython implementation. CxxTest has been tested on Linux and
Mac platforms using the `g++` and `clang++` compilers.

////
WEH - I thought about moving this section into the Getting Started
section. However, it makes sense to leave this here to reference
future installations in Debian, Mac Ports, etc. I think that that
distribution model is very strategic for cxxtest.
////

### Mac

If when using a makefile such as
---
test:
Expand All @@ -1204,25 +1221,19 @@ test:
g++ -o test-runner dlinkedlist-runner.cpp
./test-runner
---

you receive the error
---
fatal error: 'cxxtest/TestListener.h' file not found
---
And your PATH is correc try running

And your PATH is correct, try running
---
xcode-select --install
---

to authorize Xcode and let your header files work
See http://stackoverflow.com/questions/23905661/on-mac-g-fails-to-search-usr-local-include-and-usr-local-lib-by-default
////
WEH - I thought about moving this section into the Getting Started
section. However, it makes sense to leave this here to reference
future installations in Debian, Mac Ports, etc. I think that that
distribution model is very strategic for cxxtest.
////



[[discussion]]
Expand Down Expand Up @@ -1266,7 +1277,8 @@ default output stream. This test listener can be used in contexts
where a custom output stream must be specified.
////
WEH - I'd like to say more about future support for CxxTest, but I don't know more basic things like how we should plan to host CxxTest in the future.
WEH - I'd like to say more about future support for CxxTest, but I don't know
more basic things like how we should plan to host CxxTest in the future.
Discuss support for ...
Expand Down

0 comments on commit 5b63e77

Please sign in to comment.