annotate tests/automated/README @ 5158:9e0b43d3095c

more cleanups to object-memory-usage stuff -------------------- ChangeLog entries follow: -------------------- lisp/ChangeLog addition: 2010-03-19 Ben Wing <ben@xemacs.org> * diagnose.el (show-object-memory-usage-stats): Rewrite to take into account non-lisp-storage statistics returned by garbage-collect-1 and friends. src/ChangeLog addition: 2010-03-19 Ben Wing <ben@xemacs.org> * alloc.c: * alloc.c (struct): * alloc.c (tick_lrecord_stats): * alloc.c (gc_sweep_1): * alloc.c (finish_object_memory_usage_stats): * alloc.c (object_memory_usage_stats): * alloc.c (compute_memusage_stats_length): Call new memory-usage mechanism at sweep time to compute extra memory utilization for all objects. Add up the values element-by- element to get an aggregrate set of statistics, where each is the sum of the values of a single statistic across different objects of the same type. At end of sweep time, call finish_object_memory_usage_stats() to add up all the aggreggrate stats that are related to non-Lisp memory storage to compute a single value, and add it to the list of values returned by `garbage-collect' and `object-memory-usage-stats'. * buffer.c (compute_buffer_text_usage): Don't crash on buffers without text (killed buffers?) and don't double-count indirect buffers. * elhash.c: * elhash.c (hash_table_objects_create): * elhash.c (vars_of_elhash): * symsinit.h: Add memory-usage method to count the size of `hentries'. * emacs.c (main_1): Call new functions in elhash.c, frame.c at init. * frame.c: * frame.c (compute_frame_usage): * frame.c (frame_memory_usage): * frame.c (frame_objects_create): * symsinit.h: Add memory-usage method to count gutter display structures, subwindow exposures. * gc.c (gc_finish): * lisp.h: Declare finish_object_memory_usage_stats(), call it in gc_finish(). * lrecord.h (struct lrecord_implementation): * lrecord.h (INIT_MEMORY_USAGE_STATS): New value in implementation struct to track number of non-Lisp-memory statistics. Computed in alloc.c.
author Ben Wing <ben@xemacs.org>
date Fri, 19 Mar 2010 14:47:44 -0500
parents 74fd4e045ea6
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
1 This directory contains XEmacs' automated test suite. The usual way
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
2 of running all the tests is running `make check' from the top-level
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
3 source directory.
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
4
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
5 The test suite is unfinished and it's still lacking some essential
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
6 features. It is nevertheless recommended that you run the tests to
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
7 confirm that XEmacs behaves correctly.
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
8
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
9 If you want to run a specific test case, you can do it from the
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
10 command-line like this:
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
11
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
12 $ xemacs -batch -l test-harness.elc -f batch-test-emacs TEST-FILE
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
13
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
14 If something goes wrong, you can run the test suite interactively by
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
15 loading `test-harness.el' into a running XEmacs and typing
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
16 `M-x test-emacs-test-file RET <filename> RET'. You will see a log of
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
17 passed and failed tests, which should allow you to investigate the
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
18 source of the error and ultimately fix the bug.
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
19
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
20 Adding a new test file is trivial: just create a new file here and it
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
21 will be run. There is no need to byte-compile any of the files in
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
22 this directory -- the test-harness will take care of any necessary
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
23 byte-compilation.
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
24
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
25 Look at the existing test cases for the examples of coding test cases.
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
26 It all boils down to your imagination and judicious use of the macros
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
27 `Assert', `Check-Error', `Check-Error-Message', and `Check-Message'.