diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/TODO.txt | 1 | ||||
| -rw-r--r-- | doc/release-checklist.txt | 6 | ||||
| -rw-r--r-- | doc/testing.txt | 56 |
3 files changed, 32 insertions, 31 deletions
diff --git a/doc/TODO.txt b/doc/TODO.txt index d027c2e..97f1a95 100644 --- a/doc/TODO.txt +++ b/doc/TODO.txt @@ -255,7 +255,6 @@ o variants of module transparent() { %child(); } o define modules o define functions o built-in variables and constants (builtin-tests.scad) -o Write a regression test for the hexagonal cylinder orientation issue o Caching - Test that caching is actually performed (speedup + same results) - Test the modifier characters correctly influence the cache (also when diff --git a/doc/release-checklist.txt b/doc/release-checklist.txt index 2ff9593..71158f6 100644 --- a/doc/release-checklist.txt +++ b/doc/release-checklist.txt @@ -2,8 +2,8 @@ OpenSCAD Release Checklist -------------------------- o Update version - release-linux.sh - publish-macosx.sh + scripts/release-linux.sh + scripts/publish-macosx.sh FIXME: Windows o Update RELEASE_NOTES @@ -12,7 +12,7 @@ o Tag release git tag "openscad-2011.12" o build source package - git archive --format=tar openscad-2011.12 --prefix=openscad-2011.12/ | gzip > openscad-2011.12.src.tar.gz + scripts/git-archive-all.py --prefix=openscad-2011.12/ openscad-2011.12.src.tar.gz o build binaries tar xzf openscad-2011.12.src.tar.gz diff --git a/doc/testing.txt b/doc/testing.txt index 4623a96..f690939 100644 --- a/doc/testing.txt +++ b/doc/testing.txt @@ -10,7 +10,7 @@ $ cd tests $ cmake . $ make -Windows: +Windows + MSVC: First, get a normal build working by following instructions at http://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Building_on_Windows @@ -22,6 +22,10 @@ Then, from the QT command prompt: > cmake . > nmake -f Makefile +Cross compiling Linux->Win32: + +Please see openscad/tests/CMingw-cross-env.cmake for instructions. + B) Running tests $ ctest Runs tests enabled by default @@ -50,55 +54,53 @@ Adding a new regression test: Troubleshooting: ------------------------------ -0. Headless unix servers (no X11) +0. Headless unix servers -$ Xvfb :5 -screen 0 800x600x24 & +If you are attempting to run the tests on a unix-like system but only +have shell-console access, you may be able to run the tests by using a +virtual framebuffer program like Xvnc or Xvfb. For example: + +$ Xvfb :5 -screen 0 800x600x24 & $ DISPLAY=:5 ctest -1. Trouble finding libraries +Some versions of Xvfb may fail, however. + +1. Trouble finding libraries on unix To help CMAKE find eigen2, OpenCSG, CGAL, Boost, and GLEW, you can use environment variables, just like for the main qmake & openscad.pro. Examples: - OPENCSGDIR=~/OpenCSG-1.3.2 EIGEN2DIR=~/eigen2 cmake . + OPENSCAD_LIBRARIES=~ cmake . + CGALDIR=~/CGAL-3.9 BOOSTDIR=~/boost-1.47.0 cmake . - Valid variables are as follows (see CMakeLists.txt for more info): + Valid variables are as follows: BOOSTDIR, CGALDIR, EIGEN2DIR, GLEWDIR, OPENCSGDIR, OPENSCAD_LIBRARIES -2. Logs +2. Location of logs Logs of test runs are found in tests/build/Testing/Temporary -Pretty-printed index.html is in a subdir of tests/build/Testing/Temporary +A pretty-printed index.html is in a subdir of tests/build/Testing/Temporary Expected results are found in tests/regression/* Actual results are found in tests/build/testname-output/* -3. Cross-compiling +3. Image-based tests takes a long time, they fail, and the log says 'return -11' -Cross-compiling of tests has not been automated nor tested +Imagemagick may have crashed while comparing the expected images to the +test-run generated (actual) images. You can try using the alternate +ImageMagick comparison method by by erasing CMakeCache, and re-running +cmake with -DCOMPARATOR=ncc. This will enable the Normalized Cross +Comparison method. -4. Image-based tests takes a long time, they fail, and it says 'return -11' - -Imagemagick may have crashed. You can try using the alternate IM comparator -based on Normalized Cross Correlation. Pass -DCOMPARATOR=ncc to cmake - -5. Testing images fails with 'morphology' not found for ImageMagick +4. Testing images fails with 'morphology not found" for ImageMagick in the log Your version of imagemagick is old. Upgrade, or pass -DCOMPARATOR=old to cmake. The comparison will be of lowered reliability. -6. Unexplained or bizarre errors. - -This can happen on dynamic-library systems (linux) where you try to use -your own version of a library while the system still has another version -under the system paths. You can diagnose this by looking at your cmake -log as well as your sysinfo.txt file, as well as running 'ldd' against -your binaries, to make sure that the proper versions of libraries are -getting compiled and linked with the test binaries. - -7. Other issues +5. Other issues -The OpenSCAD User Manual has a section on buildling. Check there for updates: +The OpenSCAD User Manual has a section on buildling. Please check there +for updates: http://en.wikibooks.org/wiki/OpenSCAD_User_Manual |