annotate tests/automated/README @ 4905:755ae5b97edb

Change "special form" to "special operator" in our sources. Add a compatible function alias, and the relevant manual index entries. src/ChangeLog addition: 2010-01-31 Aidan Kehoe <kehoea@parhasard.net> * symbols.c (Fspecial_operator_p, syms_of_symbols): * eval.c (print_subr, Finteractive_p, Ffuncall) (Ffunction_min_args, Ffunction_max_args, vars_of_eval): * editfns.c: * data.c (Fsubr_max_args): * doc.c (Fbuilt_in_symbol_file): Change "special form" to "special operator" in our sources. man/ChangeLog addition: 2010-01-31 Aidan Kehoe <kehoea@parhasard.net> * xemacs/programs.texi (Defuns): * lispref/variables.texi (Local Variables, Defining Variables) (Setting Variables, Default Value): * lispref/symbols.texi (Definitions): * lispref/searching.texi (Saving Match Data): * lispref/positions.texi (Excursions, Narrowing): * lispref/objects.texi (Primitive Function Type): * lispref/macros.texi (Defining Macros, Backquote): * lispref/lispref.texi (Top): * lispref/intro.texi (A Sample Function Description): * lispref/help.texi (Help Functions): * lispref/functions.texi (What Is a Function, Simple Lambda) (Defining Functions, Calling Functions, Anonymous Functions): * lispref/frames.texi (Input Focus): * lispref/eval.texi (Forms, Function Indirection) (Special Operators, Quoting): * lispref/edebug-inc.texi (Instrumenting) (Specification Examples): * lispref/debugging.texi (Internals of Debugger): * lispref/control.texi (Control Structures, Sequencing): (Conditionals, Combining Conditions, Iteration): (Catch and Throw, Handling Errors): * lispref/commands.texi (Defining Commands, Using Interactive): Terminology change; special operator -> special form. Don't attempt to change this in texinfo.texi or cl.texi, which use macros I don't understand. * lispref/macros.texi (Defining Macros): Give an anonymous macro example here. * lispref/positions.texi (Excursions): Correct some documentation that called a couple of macros special forms. * lispref/searching.texi (Saving Match Data): Drop some documentation of how to write code that works with Emacs 18. * lispref/specifiers.texi (Adding Specifications): Correct this; #'let-specifier is a macro, not a special operator. * lispref/windows.texi (Window Configurations) (Selecting Windows): Correct this, #'save-selected-window and #'save-window-excursion are macros, not special operators. lisp/ChangeLog addition: 2010-01-31 Aidan Kehoe <kehoea@parhasard.net> * obsolete.el: * loadhist.el (symbol-file): * help.el (describe-function-1): * bytecomp.el: (byte-compile-save-current-buffer): * byte-optimize.el (byte-optimize-form-code-walker): * subr.el (subr-arity): Change "special form" to "special operator" in these files, it's the more logical term. * subr.el (special-form-p): Provide this alias for #'special-operator-p.
author Aidan Kehoe <kehoea@parhasard.net>
date Sun, 31 Jan 2010 20:28:01 +0000
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'.