diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/openscad.1 | 14 | ||||
| -rw-r--r-- | doc/testing.txt | 40 |
2 files changed, 52 insertions, 2 deletions
diff --git a/doc/openscad.1 b/doc/openscad.1 index a93c33f..87806f2 100644 --- a/doc/openscad.1 +++ b/doc/openscad.1 @@ -1,4 +1,4 @@ -.TH OPENSCAD 1 "2013-03-xx" +.TH OPENSCAD 1 "2013-06-xx" .\" Please adjust this date whenever revising the manpage. .SH NAME openscad \- script file based graphical CAD environment @@ -19,9 +19,19 @@ the OpenSCAD user manual at http://en.wikibooks.org/wiki/OpenSCAD_User_Manual. .TP \fB-o\fP \fIoutputfile\fP -Export the given file to \fIoutputfile\fP in STL, OFF, DXF, CSG, or PNG format, +Export the given file to \fIoutputfile\fP in STL, OFF, DXF, or PNG format, depending on file extension of \fIoutputfile\fP (which has to be lower case). If this option is given, the GUI will not be started. + +Additional formats, which are mainly used for debugging and testing (but can +also be used in automation), are AST (the input file as parsed and serialized +again), CSG (an OpenSCAD language representation of the input file with +calculations done and module calls applied), TERM (the constructive solid +geometry expression passed to OpenCSG). If \fIoutputfile\fP is \fBnull\fP, no +output file will be written, but the file will still be evaluated and all +\fBecho\fP commands will be written to the standard error output. (The +rendering process will still take place if the \fB\-\-render\fP option is +given.) .TP \fB\-d\fP \fIfile.deps\fP If the \fB-d\fP option is given, all files accessed while exporting are written diff --git a/doc/testing.txt b/doc/testing.txt index 0b14903..17847c6 100644 --- a/doc/testing.txt +++ b/doc/testing.txt @@ -64,7 +64,47 @@ This is almost the same as adding a new regression test: 4) run the test normally and verify that it passes: $ ctest -C Examples -R exampleNNN +Migration away from dedicated regression tests: +----------------------------------------------- +As the main OpenSCAD binary gained the capability to output PNG renderings, +the necessity for dedicated test binaries went away; for many test, OpenSCAD +is now directly called, resulting in better test coverage and less code to +maintain. + +So far, the following tests have been fully converted to use the main binary: + +* moduledumptest +* csgtermtest +* cgalpngtest +* opencsgtest + +Two tests still need an intermediate script that mangles away timestamps and +near-zero floating point numbers: + +* dumptest +* echotest + +Some tests are yet to be converted: + +* csgtexttest -- verify whether this is not redundant with dumptest +* throwntogethertest -- should be a .png output mode +* cgalstlsanitytest -- could probably be replaced by a shell script grepping + for nan and possibly counting faces + +These look like tests, but are not actually in use: + +* modulecachetest +* cgalcachetest + +In the course of migration, the possibilities of using the OPENSCAD_TESTING +compile time flag go away; that flag used to strip timestamps out of files, +to unify float output, and to tweak the file inclusion paths. With that flag +unused, we get better coverage of the primary code paths, at the cost of +having to do some normalization in the unit testing process (thus the dumptest +and echo test scripts). Especially, having a nonstandard MCAD library in the +user include path can now break things -- but so can having misbehaving +programs in your PATH. Troubleshooting: ------------------------------ |