annotate nt/installer/Wise/README @ 4695:fee33ab25966

Add arglist info for autoloaded functions and macros. lisp/ChangeLog addition: 2009-09-20 Aidan Kehoe <kehoea@parhasard.net> Add arglist information to docstrings for autoloaded functions and macros. * hyper-apropos.el (hyper-apropos-get-doc): Treat autoload docstrings like subr docstrings; correct the regexp used. * help.el (describe-function-show-arglist): This no longer treats autoloads specially. (function-arglist): Treat autoload docstrings like subr docstrings. (function-documentation): Treat documentation strings that are zero-length after the arglist has been removed as indicating a lack of documentation. * cl-macs.el (case): (ecase): (typecase): (etypecase): (block): (return): (return-from): (progv): (lexical-let): (lexical-let*): (remf): (callf): (callf2): (define-modify-macro): (deftype): (define-compiler-macro): Rely on the autoload code to always show an arglist for these functions, don't supply an ad-hoc one in the docstring. These changes are for the most obvious functions; there are some missed that would require changing argument names in the docstring or in the function bodies. * autoload.el (make-autoload): Add arg list information to the doc string, using the same approach as for subrs.
author Aidan Kehoe <kehoea@parhasard.net>
date Sun, 20 Sep 2009 23:50:05 +0100
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 To use:
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
2
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
3 You need to build and install the XEmacs distribution. Also you need
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
4 the xemacs packages in both source and installed versions.
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
5
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
6 Edit "dirs.py" to reflect the locations of the above components.
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
7
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
8 Edit "version.py" to reflect the current version, as well as the
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
9 welcome message.
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
10
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
11 Run
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
12 python pre_wise.py > xemacs-XXX.wse
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 (for XXX use a version or date code of your choosing)
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
15
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
16 Run
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
17 cmd /c xemacs-XXX.wse
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
18
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
19 to produce xemacs-XXX.exe
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
20
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
21
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
22 "pre_wise.py" is a preprocessor for the Wise installer maker. It
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
23 reads "xemacs.tmpl" which is a Wise input file, except that certain
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
24 portions are enclosed in triple angle brackets <<<like this>>>
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
25
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
26 These portions are evaluated as Python expressions and replaced by the
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
27 string representations of the resulting value. This allows for
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
28 things to change from release to release without having to re-do the
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
29 Wise installation each time. Also it keeps you from having to
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
30 manually drag-n-drop all the package files, which is rather tedious!
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
31