Another minor change, but this should almost get us to the point that we
[lyx.git] / development / keystest / README
blobe798016b4bd74ad24fdcf16c3397bdf960c1ccea
1 --- LyXtest ---
3 This is a program to spam LyX with millions of randomly generated key
4 presses, and collect the crash results.
6 Since the code involves spamming random keypresses, I'd recommend
7 running it in a VM, well away from your main X windows session.
9 In short, to use this, run development/keytest/lyx_make.sh
11 It requires the following packages to run
12   xvkbd wmctrl
13 the following are also useful:
14    lyx libqt4-dbg subversion automake
16 It is run by running ./autolyx in one xterm, and ./test.py in another.
17 I wrote lyx_make.sh as a easy way of updating lyx and running these two
18 programs together.
20 CONTENTS:
22 README: this readme file
23 report.sh: A quick way of generating bug reports and an overview from the logs.
24 autolyx: A script to continually restart lyx and collect the bug reports
25 lyx_make.sh: should updates, compiles, and everything needed to generated logs.
26 maketar.sh: Makes this tar file :)
27 test.py: Sends LT100 randomly generated keypresses per second to the LyX window.
28 killtest: stop the testing
29 stock_text: The stock test to add to each bug report.
31 OUTPUTS:
33 autolyx: Outputs out/GDB, a log of all output, including backtraces.
34 test.py: Outputs out/KEYCODES, a list of all keycodes sent to LyX
36 reports.sh: Outputs
37   out/overview: an overview of all the frequency of each error
38   out/overview_sort: as above but sorted
39   out/report_*: A collection of autogenerated bug reports.
41 AUTHOR:
42 Copyright (C) 2009 John McCabe-Dansted, gmatht at gmail dot com.
43 Published under the Gnu General Public Licence, version 2 or later.