Changeset 4355 for waeup/branches

Timestamp:

25 Jun 2009, 10:05:28 (15 years ago)

Author:

uli

Message:

Update docs.

File:

• waeup/branches/ulif-rewrite/src/waeup/doc/developernotes.txt (modified) (2 diffs)

waeup/branches/ulif-rewrite/src/waeup/doc/developernotes.txt

@@ -35 +35 @@
 * A subversion client (svn)
 
+* enscript (enscript) [optional]
+
+  This is only needed if you want test coverage reports.
+
 All these packages can be installed on Debian systems like this::
 
   # apt-get install python2.5 python2.5-dev python2.5-dbg \
-                    gcc libc6-dev svn
+                    gcc libc6-dev svn enscript
 
 Afterwards you should be able to enter::
@@ -282 +286 @@
 line was used in tests.
 
+To have a more convenient cmdline interface, we also provide some
+shortcuts::
+
+  $ bin/coverage-detect
+
+will run all the tests as shown above and put the results in
+``parts/coverage-detect/coverage``.
+
+After that you can run::
+
+  $ bin/coverage-report
+
+to get a browsable HTML representation of test coverage in
+``parts/coverage-detect/coverage/report``.
+
+Both, the coverage reports and HTML documentation generated by sphinx
+can be packed and put onto a website as-is.
+
+It is also possible to generate the docs and reports nightly by a
+buildbot or something like this.