Mercurial > hg > xemacs-beta
annotate modules/README @ 5752:70a3f4ff8da8
Improve coding style, variable names, data.c, sequence.c
src/ChangeLog addition:
2013-08-05 Aidan Kehoe <kehoea@parhasard.net>
* data.c:
* data.c (Fcar):
* data.c (Fcdr):
* data.c (Fmake_weak_box):
* data.c (Fweak_box_ref):
* data.c (init_marking_ephemerons):
* data.c (continue_marking_ephemerons):
* data.c (finish_marking_ephemerons):
* data.c (prune_ephemerons):
* data.c (zap_finalize_list):
* data.c (ephemeron_equal):
* data.c (ephemeron_hash):
* data.c (Fmake_ephemeron):
* data.c (Fephemeron_ref):
* data.c (Fephemeronp):
* sequence.c:
* sequence.c (Fcopy_tree):
* sequence.c (Freplace):
Improve coding style here; #'car and #'cdr accept lists, not just
cons cells, update their argument names to reflect that.
Follow coding conventions in the weak box and ephemeron code.
Don't needlessly abbreviate in copy-tree, use argument names from
Common Lisp in #'merge and #'replace.
Document ALIST better in #'nsublis, #'sublis.
| author | Aidan Kehoe <kehoea@parhasard.net> |
|---|---|
| date | Mon, 05 Aug 2013 17:20:16 +0100 |
| parents | da1365dd3f07 |
| children |
| rev | line source |
|---|---|
|
5436
da1365dd3f07
Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents:
996
diff
changeset
|
1 This file is part of XEmacs. |
|
da1365dd3f07
Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents:
996
diff
changeset
|
2 |
|
da1365dd3f07
Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents:
996
diff
changeset
|
3 XEmacs is free software: you can redistribute it and/or modify it |
|
da1365dd3f07
Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents:
996
diff
changeset
|
4 under the terms of the GNU General Public License as published by the |
|
da1365dd3f07
Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents:
996
diff
changeset
|
5 Free Software Foundation, either version 3 of the License, or (at your |
|
da1365dd3f07
Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents:
996
diff
changeset
|
6 option) any later version. |
|
da1365dd3f07
Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents:
996
diff
changeset
|
7 |
|
da1365dd3f07
Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents:
996
diff
changeset
|
8 XEmacs is distributed in the hope that it will be useful, but WITHOUT |
|
da1365dd3f07
Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents:
996
diff
changeset
|
9 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
da1365dd3f07
Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents:
996
diff
changeset
|
10 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
da1365dd3f07
Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents:
996
diff
changeset
|
11 for more details. |
|
da1365dd3f07
Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents:
996
diff
changeset
|
12 |
|
da1365dd3f07
Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents:
996
diff
changeset
|
13 You should have received a copy of the GNU General Public License |
|
da1365dd3f07
Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents:
996
diff
changeset
|
14 along with XEmacs. If not, see <http://www.gnu.org/licenses/>. |
|
da1365dd3f07
Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents:
996
diff
changeset
|
15 |
|
da1365dd3f07
Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents:
996
diff
changeset
|
16 |
| 996 | 17 This directory contains a number of XEmacs dynamic modules. These |
| 18 modules can be loaded directly with the command 'M-x load-module'. | |
| 19 However, the preferred method of loading a module is to issue a | |
| 20 "(require 'module-name)" command to the Lisp interpreter. This will | |
| 21 store information so that a later "(unload-feature 'module-name)" can | |
| 22 succeed. | |
| 388 | 23 |
| 996 | 24 To compile one of these modules, simply enter the desired directory, |
| 25 type 'configure', and then 'make'. If you are building the module for | |
| 26 an installed XEmacs, then 'make install' will place the module in the | |
| 27 appropriate directory for XEmacs to find it later (assuming you have | |
| 28 permission to write to that directory). A subsequent 'load-module' or | |
| 29 'require' will then load the module, as described above. | |
| 388 | 30 |
| 996 | 31 Each of these demonstrates different features and limitations of the |
| 32 XEmacs module loading technology. For a complete discussion on XEmacs | |
| 33 dynamic modules, please consult the XEmacs Module Writers Guide, which | |
| 34 can be found in the ../info directory. | |
| 388 | 35 |
| 996 | 36 For those wanting to get started with module writing, please see the |
| 37 'sample' directory. It contains two subdirectories: internal and | |
| 38 external. The 'internal' subdirectory contains the framework needed to | |
| 39 migrate some core piece of XEmacs functionality into code that can | |
| 40 either be compiled into the core or built as a separate module. The | |
| 41 'external' subdirectory contains the somewhat simpler framework needed | |
| 42 to build a module separately from XEmacs. These should be considered | |
| 43 starting places for module writing. |