annotate tests/automated/README @ 4502:8748a3f7ceb4

Handle varalias chains, custom variables in #'user-variable-p. src/ChangeLog addition: 2008-08-23 Aidan Kehoe <kehoea@parhasard.net> * eval.c (Fuser_variable_p): Moved to symbols.c * symbols.c (Fcustom_variable_p): Moved here from custom.el. (user_variable_alias_check_fun): Mapper function used in `user-variable-p'. (Fuser_variable_p): Moved here from eval.c, to allow it to examine the variable alias chain. Expanded to check each entry in the variable alias chain for signs of being a user variable; documentation updated, noting the differences between GNU's behaviour and ours (ours is a little more sensible) (map_varalias_chain): New. Given a C function, call it at least once for each symbol in a symbol's varalias chain, signalling an error if there's a cycle, and returning immediately if the function returns something other than Qzero. (Fdefvaralias): Correct the use of the word "alias" in the docstring and in the argument name. Motivate this in a comment. Add support for a DOCSTRING argument, something GNU has too, and document this * gc.c (vars_of_gc): Start the docstring of `garbage-collection-messages' with an asterisk, to indicate that it's a user variable. lisp/ChangeLog addition: 2008-08-23 Aidan Kehoe <kehoea@parhasard.net> * custom.el: Move #'custom-variable-p to C, since it's now called from #'user-variable-p.
author Aidan Kehoe <kehoea@parhasard.net>
date Sat, 23 Aug 2008 16:38:51 +0200
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'.