Mercurial > hg > xemacs-beta
annotate modules/README @ 5219:2d0937dc83cf
Tidying of CL files; make docstrings read better, remove commented-out code
2010-05-30 Aidan Kehoe <kehoea@parhasard.net>
* cl.el: Remove extraneous empty lines.
Remove the commented-out Lisp implementation of #'last,
#'copy-list.
Remove #'cl-maclisp-member.
(acons, pairlis): Have the argument list reflect the docstring for
these functions.
* cl-macs.el (defun*): Have the argument list reflect the
docstring.
Document the syntax of keywords in ARGLIST.
(defmacro*): Have the argument list reflect the docstring.
Document &body, &whole and &environment.
(function*): Have the argument list reflect the docstring.
(loop): Have the argument list reflect the docstring.
(eval-when, dolist, dotimes, do-symbols, flet, labels, macrolet,
symbol-macrolet):
Specify the argument list using the arguments: (...) syntax.
(define-setf-method, rotatef, defsubst*): Have the argument list
reflect the docstring.
(letf, letf*):
Specify the argument list using the arguments: (...) syntax.
(svref, acons, pairlis): Add compiler macros for these functions.
* cl-extra.el: Remove the commented-out Lisp implementation of
#'equalp. If we want to look at it, it's in version control.
(cl-expt): Remove this. The subr #'expt is always available.
Call #'cl-float-limits at dump time.
Remove the commented-out Lisp implementation of #'subseq.
(concatenate): Use (error 'invalid-argument ...) here, if TYPE is
not understood.
(list-length): Don't manually get the length of a list, call
#'length and return nil if the list is circular.
* byte-optimize.el (equalp): This needs
byte-optimize-binary-predicate as its optimizer, as do the other
equality predicates.
| author | Aidan Kehoe <kehoea@parhasard.net> |
|---|---|
| date | Sun, 30 May 2010 13:27:36 +0100 |
| parents | 25e260cb7994 |
| children | da1365dd3f07 |
| rev | line source |
|---|---|
| 996 | 1 This directory contains a number of XEmacs dynamic modules. These |
| 2 modules can be loaded directly with the command 'M-x load-module'. | |
| 3 However, the preferred method of loading a module is to issue a | |
| 4 "(require 'module-name)" command to the Lisp interpreter. This will | |
| 5 store information so that a later "(unload-feature 'module-name)" can | |
| 6 succeed. | |
| 388 | 7 |
| 996 | 8 To compile one of these modules, simply enter the desired directory, |
| 9 type 'configure', and then 'make'. If you are building the module for | |
| 10 an installed XEmacs, then 'make install' will place the module in the | |
| 11 appropriate directory for XEmacs to find it later (assuming you have | |
| 12 permission to write to that directory). A subsequent 'load-module' or | |
| 13 'require' will then load the module, as described above. | |
| 388 | 14 |
| 996 | 15 Each of these demonstrates different features and limitations of the |
| 16 XEmacs module loading technology. For a complete discussion on XEmacs | |
| 17 dynamic modules, please consult the XEmacs Module Writers Guide, which | |
| 18 can be found in the ../info directory. | |
| 388 | 19 |
| 996 | 20 For those wanting to get started with module writing, please see the |
| 21 'sample' directory. It contains two subdirectories: internal and | |
| 22 external. The 'internal' subdirectory contains the framework needed to | |
| 23 migrate some core piece of XEmacs functionality into code that can | |
| 24 either be compiled into the core or built as a separate module. The | |
| 25 'external' subdirectory contains the somewhat simpler framework needed | |
| 26 to build a module separately from XEmacs. These should be considered | |
| 27 starting places for module writing. |
