Mercurial > hg > xemacs-beta
annotate modules/README @ 5066:545ec923b4eb
add documentation on keywords to cl*.el
-------------------- ChangeLog entries follow: --------------------
lisp/ChangeLog addition:
2010-02-22 Ben Wing <ben@xemacs.org>
* cl-seq.el:
* cl-seq.el (reduce):
* cl-seq.el (fill):
* cl-seq.el (replace):
* cl-seq.el (remove*):
* cl-seq.el (remove-if):
* cl-seq.el (remove-if-not):
* cl-seq.el (delete*):
* cl-seq.el (delete-if):
* cl-seq.el (delete-if-not):
* cl-seq.el (remove-duplicates):
* cl-seq.el (delete-duplicates):
* cl-seq.el (substitute):
* cl-seq.el (substitute-if):
* cl-seq.el (substitute-if-not):
* cl-seq.el (nsubstitute):
* cl-seq.el (nsubstitute-if):
* cl-seq.el (nsubstitute-if-not):
* cl-seq.el (find):
* cl-seq.el (find-if):
* cl-seq.el (find-if-not):
* cl-seq.el (position):
* cl-seq.el (position-if):
* cl-seq.el (position-if-not):
* cl-seq.el (count):
* cl-seq.el (count-if):
* cl-seq.el (count-if-not):
* cl-seq.el (mismatch):
* cl-seq.el (search):
* cl-seq.el (sort*):
* cl-seq.el (stable-sort):
* cl-seq.el (merge):
* cl-seq.el (member*):
* cl-seq.el (member-if):
* cl-seq.el (member-if-not):
* cl-seq.el (assoc*):
* cl-seq.el (assoc-if):
* cl-seq.el (assoc-if-not):
* cl-seq.el (rassoc*):
* cl-seq.el (rassoc-if):
* cl-seq.el (rassoc-if-not):
* cl-seq.el (union):
* cl-seq.el (nunion):
* cl-seq.el (intersection):
* cl-seq.el (nintersection):
* cl-seq.el (set-difference):
* cl-seq.el (nset-difference):
* cl-seq.el (set-exclusive-or):
* cl-seq.el (nset-exclusive-or):
* cl-seq.el (subsetp):
* cl-seq.el (subst-if):
* cl-seq.el (subst-if-not):
* cl-seq.el (nsubst):
* cl-seq.el (nsubst-if):
* cl-seq.el (nsubst-if-not):
* cl-seq.el (sublis):
* cl-seq.el (nsublis):
* cl-seq.el (tree-equal):
* cl-seq.el (cl-tree-equal-rec):
* cl.el:
* cl.el (pushnew):
* cl.el (adjoin):
* cl.el (subst):
Document the keywords to the various sequence/list functions.
| author | Ben Wing <ben@xemacs.org> |
|---|---|
| date | Mon, 22 Feb 2010 21:17:47 -0600 |
| 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. |