Mercurial > hg > xemacs-beta
view modules/README @ 5070:b0f4adffca7d
fix so that CL docstrings (with &key, etc.) handled properly
-------------------- ChangeLog entries follow: --------------------
lisp/ChangeLog addition:
2010-02-23 Ben Wing <ben@xemacs.org>
* autoload.el:
* autoload.el (make-autoload):
* cl-macs.el (cl-function-arglist):
* cl-macs.el (cl-transform-lambda):
Don't add argument list with the tag "Common Lisp lambda list:";
instead add in "standard" form using "arguments:" and omitting the
function name. Add an arg to `cl-function-arglist' to omit the
name and use it in autoload.el instead of just hacking it off.
* help.el:
* help.el (function-arglist):
* help.el (function-documentation-1): New.
Extract out common code to recognize and/or strip the arglist from
documentation into `function-documentation-1'. Use in
`function-arglist' and `function-documentation'. Modify
`function-arglist' so it looks for the `arguments: ' stuff in all
doc strings, not just subrs/autoloads, so that CL functions get
recognized properly. Change the regexp used to match "arguments: "
specs to allow nested parens inside the arg list (happens when you
have a default value specified in a CL arglist).
author | Ben Wing <ben@xemacs.org> |
---|---|
date | Tue, 23 Feb 2010 01:12:13 -0600 |
parents | 25e260cb7994 |
children | da1365dd3f07 |
line wrap: on
line source
This directory contains a number of XEmacs dynamic modules. These modules can be loaded directly with the command 'M-x load-module'. However, the preferred method of loading a module is to issue a "(require 'module-name)" command to the Lisp interpreter. This will store information so that a later "(unload-feature 'module-name)" can succeed. To compile one of these modules, simply enter the desired directory, type 'configure', and then 'make'. If you are building the module for an installed XEmacs, then 'make install' will place the module in the appropriate directory for XEmacs to find it later (assuming you have permission to write to that directory). A subsequent 'load-module' or 'require' will then load the module, as described above. Each of these demonstrates different features and limitations of the XEmacs module loading technology. For a complete discussion on XEmacs dynamic modules, please consult the XEmacs Module Writers Guide, which can be found in the ../info directory. For those wanting to get started with module writing, please see the 'sample' directory. It contains two subdirectories: internal and external. The 'internal' subdirectory contains the framework needed to migrate some core piece of XEmacs functionality into code that can either be compiled into the core or built as a separate module. The 'external' subdirectory contains the somewhat simpler framework needed to build a module separately from XEmacs. These should be considered starting places for module writing.