|
428
|
1 -*- mode:outline -*-
|
|
|
2
|
|
|
3 * Introduction
|
|
|
4 ==============
|
|
|
5
|
|
743
|
6 You are running a potentially unstable version of XEmacs. Please do
|
|
|
7 not report problems with Beta XEmacs to comp.emacs.xemacs. Report
|
|
1250
|
8 them to <xemacs-beta@xemacs.org>, preferably with
|
|
|
9 'M-x report-xemacs-bug RET'.
|
|
428
|
10
|
|
743
|
11 ** Mailing Lists
|
|
|
12 ================
|
|
|
13
|
|
|
14 *** XEmacs Beta Mailing List
|
|
|
15 ----------------------------
|
|
428
|
16
|
|
743
|
17 If you are not subscribed to the XEmacs beta list you should be.
|
|
|
18 Currently all discussion of development issues, including bug reports
|
|
|
19 and coding discussion, takes place on the XEmacs Beta mailing list.
|
|
|
20 Only patches and administrative actions regarding patches are sent
|
|
|
21 elsewhere (to the XEmacs Patches list).
|
|
|
22
|
|
1044
|
23 *** XEmacs Patches Mailing List
|
|
|
24 -------------------------------
|
|
428
|
25
|
|
743
|
26 XEmacs Patches records proposed changes to XEmacs, and their
|
|
1044
|
27 disposition. It is open subscription, and all patches that are
|
|
|
28 seriously proposed for inclusion in XEmacs should be posted here. You
|
|
743
|
29 can follow progress of your patch by subscribing to the mailing list
|
|
|
30 or in the archives.
|
|
|
31
|
|
1044
|
32 Besides patches, only actions by members of the XEmacs Review Board
|
|
|
33 should be posted to this list. All discussion should be redirected to
|
|
|
34 XEmacs Beta or XEmacs Design.
|
|
|
35
|
|
|
36 *** XEmacs Design Mailing List
|
|
|
37 ------------------------------
|
|
|
38
|
|
|
39 XEmacs Design is for design discussions such as adding major features
|
|
|
40 or whole modules, or reimplementation of existing functions, to XEmacs.
|
|
|
41
|
|
|
42 *** List Administrivia
|
|
|
43 ----------------------
|
|
428
|
44
|
|
743
|
45 In the descriptions below, the word LIST (all uppercase) is a
|
|
1044
|
46 variable. Substitute "beta", "design", or "patches" as appropriate
|
|
|
47 (to get "xemacs-beta" as the mailbox for the XEmacs Beta mailing list,
|
|
1301
|
48 or <http://www.xemacs.org/Lists/#xemacs-beta> for its URL).
|
|
428
|
49
|
|
743
|
50 The XEmacs mailing lists are managed by the Mailman mailing list
|
|
|
51 package, and the usual Mailman commands work. Do not send mailing
|
|
1301
|
52 list requests to the main address (<xemacs-LIST@xemacs.org>), always
|
|
|
53 send them to <xemacs-LIST-request@xemacs.org>. If you have problems
|
|
743
|
54 with the list itself, they should be brought to the attention of the
|
|
|
55 XEmacs Mailing List manager <list-manager@xemacs.org> (the same
|
|
|
56 mailbox, "list-manager", for all lists). All public mailing lists
|
|
|
57 have searchable archives. The URL is
|
|
|
58
|
|
|
59 http://list-archive.xemacs.org/xemacs-LIST
|
|
428
|
60
|
|
1044
|
61 Note that the xemacs-LIST-admin address is used internally by the
|
|
|
62 Mailman software; it is NOT a synonym for xemacs-LIST-request.
|
|
|
63
|
|
743
|
64 *** Managing your subscription via the Web
|
|
|
65 ------------------------------------------
|
|
|
66
|
|
|
67 Subscription, unsubscription, and options (such as digests and
|
|
|
68 temporarily suspending delivery) can be accomplished via the web
|
|
1301
|
69 interface at <http://www.xemacs.org/Lists/#xemacs-LIST>.
|
|
428
|
70
|
|
743
|
71 *** Subscribing by e-mail
|
|
|
72 -------------------------
|
|
|
73
|
|
1301
|
74 Send an email message to <xemacs-LIST-request@xemacs.org> with
|
|
743
|
75 `subscribe' (without the quotes) as the BODY of the message.
|
|
428
|
76
|
|
743
|
77 *** Unsubscribing by e-mail
|
|
|
78 ---------------------------
|
|
|
79
|
|
1301
|
80 Send an email message to <xemacs-LIST-request@xemacs.org> with
|
|
743
|
81 `unsubscribe' (without the quotes) as the BODY of the message.
|
|
428
|
82
|
|
|
83 ** Beta Release Schedule
|
|
|
84 ========================
|
|
|
85
|
|
1250
|
86 We would like to achieve a weekly or fortnightly release cycle (you
|
|
|
87 know the Open Source model: release early, release often), and in a
|
|
|
88 perfect world that would indeed be the case. There are at least three
|
|
|
89 things that often get in the way of that goal: 1) The Release Manager
|
|
|
90 has a life outside of XEmacs (hard to believe, I know, but true),
|
|
|
91 2) we like to make releases that will build (at least on the Release
|
|
|
92 Manager's box), and 3) Murphy likes to throw a spanner in the works
|
|
|
93 right when you least expect it (Murphy's Law: Whatever can go wrong,
|
|
|
94 will go wrong).
|
|
|
95
|
|
|
96 If you'd like to keep right up to date and ride the bleeding edge, use
|
|
|
97 CVS (see <http://www.xemacs.org/Develop/cvsaccess.html>). If you
|
|
|
98 can't use CVS for some reason and must use FTP, please let us know.
|
|
|
99 it will make it more likely that we release betas more often.
|
|
|
100
|
|
428
|
101
|
|
|
102 ** Reporting Problems
|
|
|
103 =====================
|
|
|
104
|
|
|
105 The best way to get problems fixed in XEmacs is to submit good problem
|
|
1250
|
106 reports, 'M-x report-xemacs-bug RET' will help you do this (assuming
|
|
|
107 you have a usable XEmacs). Since this is beta software, problems are
|
|
|
108 certain to exist. Please read through all of part II of the XEmacs
|
|
|
109 FAQ for an overview of problem reporting. Other items which are most
|
|
|
110 important are:
|
|
428
|
111
|
|
|
112 1. Do not submit C stack backtraces without line numbers. Since it
|
|
|
113 is possible to compile optimized with debug information with GCC
|
|
|
114 it is never a good idea to compile XEmacs without the -g flag.
|
|
|
115 XEmacs runs on a variety of platforms, and often it is not
|
|
|
116 possible to recreate problems which afflict a specific platform.
|
|
|
117 The line numbers in the C stack backtrace help isolate where the
|
|
|
118 problem is actually occurring.
|
|
|
119
|
|
|
120 2. Attempt to recreate the problem starting with an invocation of
|
|
1255
|
121 XEmacs with `xemacs -no-autoloads'. Quite often, problems are
|
|
|
122 due to package interdependencies, and the like. An actual bug
|
|
|
123 in XEmacs should be reproducible in a default configuration
|
|
|
124 without loading any special packages (or the one or two specific
|
|
|
125 packages that cause the bug to appear). If you have trouble
|
|
|
126 getting anything to work at all with the above invocation, use
|
|
|
127 `xemacs -vanilla' instead. If you need to load your user init
|
|
|
128 file or the site file to get the problem to occur, then it has
|
|
|
129 something to do with them, and you should try to isolate the
|
|
|
130 issue in those files.
|
|
428
|
131
|
|
|
132 3. A picture can be worth a thousand words. When reporting an
|
|
|
133 unusual display, it is generally best to capture the problem in a
|
|
|
134 screen dump and include that with the problem report. The easiest
|
|
|
135 way to get a screen dump is to use the xv program and its grab
|
|
|
136 function. Save the image as a GIF to keep bandwidth requirements
|
|
|
137 down without loss of information. MIME is the preferred method
|
|
|
138 for making the image attachments.
|
|
|
139
|
|
|
140 ** Getting the Source
|
|
|
141 =====================
|
|
|
142
|
|
|
143 In addition to the normal tar distribution, XEmacs source is now
|
|
743
|
144 available via CVS. Please see
|
|
|
145
|
|
|
146 http://www.xemacs.org/Develop/cvsaccess.html
|
|
428
|
147
|
|
|
148 * Compiling Beta XEmacs
|
|
|
149 =======================
|
|
|
150
|
|
|
151 ** Building an XEmacs from patches
|
|
|
152 ==================================
|
|
|
153
|
|
1250
|
154 All beta releases of XEmacs are included with patches from the previous
|
|
|
155 version in an attempt to keep bandwidth requirements down. Patches
|
|
|
156 should be applied with the GNU patch program in something like the
|
|
|
157 following. Let's say you're upgrading XEmacs 21.5-beta9 to XEmacs
|
|
|
158 21.5-beta10 and you have a full unmodified XEmacs 21.5-beta9 source
|
|
|
159 tree to work with. Change to the top level directory and issue the
|
|
428
|
160 shell command:
|
|
|
161
|
|
1250
|
162 $ gunzip -c /tmp/xemacs-21.5.9-21.5.10.patch.gz | patch -p1
|
|
428
|
163
|
|
|
164 After patching, check to see that no patches were missed by doing
|
|
|
165 $ find . -name \*.rej -print
|
|
|
166
|
|
|
167 Any rejections should be treated as serious problems to be resolved
|
|
|
168 before building XEmacs.
|
|
|
169
|
|
|
170 After seeing that there were no rejections, issue the commands
|
|
|
171
|
|
|
172 $ ./config.status --recheck
|
|
1250
|
173 $ make beta > ./beta.err 2>&1
|
|
|
174 $ make check > ./xemacs-make-check.err 2>&1
|
|
428
|
175
|
|
1250
|
176 Redirect the output from make to those files because you'll use them
|
|
|
177 later when you send off a build report with 'M-x build-report RET'
|
|
428
|
178
|
|
|
179 ** Building XEmacs from a full distribution
|
|
1024
|
180 ===========================================
|
|
428
|
181
|
|
2367
|
182 [1] Locate a convenient place where you have at least 100MB of free space
|
|
428
|
183 and issue the command
|
|
|
184
|
|
1250
|
185 $ gunzip -c /tmp/xemacs-21.5.10.tar.gz | tar xvf -
|
|
428
|
186
|
|
1250
|
187 (or simply `tar zxvf /tmp/xemacs-21.5.10.tar.gz' if you use GNU tar).
|
|
428
|
188
|
|
2367
|
189 [2] cd to the top level directory and issue an appropriate configure
|
|
|
190 command.
|
|
|
191
|
|
|
192 [3] Run `configure'. If you are new, just consider running it with no
|
|
|
193 options, to see if you can get a succesful build. When you are more
|
|
|
194 experienced, you should put various flags in. Here is what we suggest:
|
|
|
195
|
|
|
196 [a] It's a good idea to use
|
|
|
197
|
|
|
198 --extra-verbose
|
|
|
199 --debug
|
|
|
200 --memory-usage-stats
|
|
|
201 --error-checking=all
|
|
|
202
|
|
|
203 These turn on extra debugging info and checks. The last one in particular
|
|
|
204 will add a great deal of extra error-checking -- which will slow your XEmacs
|
|
|
205 down somewhat but is likely to catch bugs much sooner and make your bug
|
|
|
206 reports much more useful.
|
|
|
207
|
|
|
208 [b] You should also strongly consider
|
|
|
209
|
|
|
210 --with-mule
|
|
|
211 --use-pkcc
|
|
|
212 --pdump
|
|
|
213 --with-clash-detection
|
|
|
214 --with-wmcommand
|
|
|
215 --with-xfs
|
|
|
216
|
|
|
217 These turn on optional features, which can always use testing.
|
|
428
|
218
|
|
2367
|
219 [c] If you have gcc, consider using
|
|
|
220
|
|
|
221 --compiler=gcc
|
|
|
222 --xemacs-compiler=g++
|
|
|
223
|
|
|
224 This will compile XEmacs using g++, which will turn on a lot of additional
|
|
|
225 error-checking.
|
|
|
226
|
|
|
227 [d] If your packages are not installed under /usr/local, you should add a
|
|
|
228 line like
|
|
|
229
|
|
|
230 --package-path=~/.xemacs::/xemacs/site-packages:/xemacs/xemacs-packages:/xemacs/mule-packages
|
|
|
231
|
|
|
232 [e] If you want to build multiple configurations from the same source tree,
|
|
|
233 make separate build directories for each configuration, run `configure' from
|
|
|
234 the top level of these (currently empty) directories and use an option like
|
|
|
235
|
|
|
236 --srcdir=/xemacs/source-tree
|
|
|
237
|
|
|
238 (or wherever your source tree is). This will magically create symlinks and
|
|
|
239 populate your build directory.
|
|
|
240
|
|
|
241 [f] Use --site-prefixes (or --site-includes and --site-libraries) if you have
|
|
|
242 some packages that XEmacs can compile with that are located in an unusual
|
|
|
243 place. For example:
|
|
|
244
|
|
|
245 --site-prefixes=/usr/local/pgsql:/usr/local/BerkeleyDB.4.1
|
|
|
246
|
|
|
247 [g] Depending on your build environment, consuder setting or not setting
|
|
|
248 options for menubars, scrollbars, window systems, native sound, etc. If
|
|
|
249 you're not sure, leave them out and let configure do the auto-detection.
|
|
|
250 (If you get bugs compiling GTK, use `--with-gtk=no --with-gnome=no'.)
|
|
428
|
251
|
|
1250
|
252 Part of the configure output is a summary that looks something
|
|
|
253 like the following. (this summary is also available as the file
|
|
|
254 'Installation' in the top directory of your build tree, and via
|
|
|
255 the command 'M-x describe-installation RET').
|
|
428
|
256
|
|
1250
|
257 uname -a: Linux eicq 2.4.20 #1 Wed Dec 18 02:14:29 EST 2002 i586 unknown
|
|
428
|
258
|
|
1250
|
259 ./configure '--extra-verbose' '--site-prefixes=/usr/local/pgsql:/usr/local/BerkeleyDB.4.1' '--dynamic=yes' '--with-gtk=no' '--with-gnome=no' '--with-toolbars' '--with-wmcommand' '--with-athena=next' '--with-menubars=lucid' '--with-scrollbars=athena' '--with-dialogs=athena' '--with-widgets=athena' '--with-gif' '--with-sound=native,noesd' '--with-site-lisp=no' '--with-site-modules' '--pdump' '--with-mule' '--with-xfs' '--debug' '--error-checking=all' '--memory-usage-stats' '--use-kkcc' '--with-clash-detection'
|
|
|
260
|
|
|
261
|
|
|
262 XEmacs 21.5-b10 "burdock" (+CVS-20030131) configured for `i586-pc-linux'.
|
|
428
|
263
|
|
|
264
|
|
1250
|
265 Compilation / Installation:
|
|
|
266 Source code location: /usr/local/src/xemacs
|
|
|
267 Installation prefix: /usr/local
|
|
|
268 Additional prefixes: /usr/local/pgsql /usr/local/BerkeleyDB.4.1
|
|
|
269 Operating system description file: `s/linux.h'
|
|
|
270 Machine description file: `m/intel386.h'
|
|
|
271 Compiler: gcc -Wall -Wno-switch -Winline -Wmissing-prototypes -Wsign-compare -Wundef -Wstrict-prototypes -Wshadow -Wmissing-declarations -O1 -ggdb3 -Wall -Wchar-subscripts -Wunused -Wundef -Wshadow -Wsign-compare -Wmissing-declarations -march=k6
|
|
|
272 Relocating allocator for buffers: no
|
|
|
273 GNU version of malloc: yes
|
|
|
274 - Using Doug Lea's new malloc from the GNU C Library.
|
|
428
|
275
|
|
1250
|
276 Window System:
|
|
|
277 Compiling in support for the X window system:
|
|
|
278 - X Windows headers location: /usr/X11/include
|
|
|
279 - X Windows libraries location: /usr/X11/lib
|
|
|
280 - Handling WM_COMMAND properly.
|
|
|
281 Compiling in support for the Athena widget set:
|
|
|
282 - Athena headers location: X11/neXtaw
|
|
|
283 - Athena library to link: neXtaw
|
|
|
284 Using Lucid menubars.
|
|
|
285 Using Athena scrollbars.
|
|
|
286 Using Athena dialog boxes.
|
|
|
287 Using Athena native widgets.
|
|
|
288
|
|
|
289 TTY:
|
|
428
|
290 Compiling in support for ncurses.
|
|
|
291 Compiling in support for GPM (General Purpose Mouse).
|
|
1250
|
292
|
|
|
293 Images:
|
|
|
294 Compiling in support for GIF images (builtin).
|
|
|
295 Compiling in support for XPM images.
|
|
|
296 Compiling in support for PNG images.
|
|
|
297 Compiling in support for JPEG images.
|
|
|
298 Compiling in support for TIFF images.
|
|
|
299 Compiling in support for X-Face message headers.
|
|
|
300
|
|
|
301 Sound:
|
|
|
302 Compiling in support for sound (native).
|
|
|
303
|
|
|
304 Databases:
|
|
|
305 Compiling in support for Berkeley database.
|
|
|
306 Compiling in support for PostgreSQL.
|
|
|
307 - Using PostgreSQL header file: libpq-fe.h
|
|
|
308 - Using PostgreSQL V7 bindings.
|
|
|
309
|
|
|
310 Internationalization:
|
|
|
311 Compiling in support for Mule (multi-lingual Emacs).
|
|
|
312 Compiling in support for XIM (X11R5+ I18N input method).
|
|
|
313 - Using raw Xlib to provide XIM support.
|
|
|
314 - Using XFontSet to provide bilingual menubar.
|
|
|
315
|
|
|
316 Mail:
|
|
|
317 Compiling in support for "dot-locking" mail spool file locking method.
|
|
|
318
|
|
|
319 Other Features:
|
|
|
320 Inhibiting IPv6 canonicalization at startup.
|
|
|
321 Compiling in support for dynamic shared object modules.
|
|
|
322 Using the new GC algorithms.
|
|
|
323 Using the new portable dumper.
|
|
|
324 Compiling in support for extra debugging code.
|
|
428
|
325 WARNING: ---------------------------------------------------------
|
|
|
326 WARNING: Compiling in support for runtime error checking.
|
|
|
327 WARNING: XEmacs will run noticeably more slowly as a result.
|
|
|
328 WARNING: Error checking is on by default for XEmacs beta releases.
|
|
|
329 WARNING: ---------------------------------------------------------
|
|
|
330
|
|
|
331
|
|
|
332
|
|
2367
|
333 [4] Then...
|
|
1250
|
334
|
|
|
335 $ make > ./beta.err 2>&1
|
|
|
336 $ make check > ./xemacs-make-check.err 2>&1
|
|
|
337
|
|
|
338 ...and you should have a working XEmacs.
|
|
428
|
339
|
|
2367
|
340 [5] After you have verified that you have a functional editor, fire up
|
|
428
|
341 your favorite mail program and send a build report to
|
|
1250
|
342 <xemacs-buildreports@xemacs.org>.
|
|
649
|
343
|
|
1250
|
344 Preferably this is best done from XEmacs, following these simple steps:
|
|
649
|
345
|
|
|
346 M-x customize-group RET build-report RET
|
|
|
347 M-x build-report RET
|
|
|
348
|
|
|
349 See also
|
|
1253
|
350 <http://www.xemacs.org/Releases/Public-21.2/tester.html#reporting>
|
|
649
|
351
|
|
|
352 If you create the report manually by other means, here is what the
|
|
|
353 build report should include:
|
|
428
|
354
|
|
|
355 1. Your hardware configuration (OS version, etc.)
|
|
|
356
|
|
|
357 2. Version numbers of software in use (X11 version, system library
|
|
|
358 versions if appropriate, graphics library versions if appropriate).
|
|
|
359 If you're on a system like Linux, include all the version numbers
|
|
|
360 you can because chances are it makes a difference.
|
|
|
361
|
|
|
362 3. The options given to configure
|
|
|
363
|
|
|
364 4. The configuration report illustrated above
|
|
|
365
|
|
|
366 For convenience all of the above items are placed in a file called
|
|
|
367 `Installation' in the top level build directory. They are also
|
|
|
368 available by performing M-x describe-installation inside XEmacs.
|
|
|
369
|
|
|
370 5. Any other unusual items you feel should be brought to the attention
|
|
|
371 of the developers.
|
|
|
372
|
|
743
|
373
|
|
1024
|
374 * Packages
|
|
|
375 ==========
|
|
|
376
|
|
|
377 [Note: these instructions have been partly updated, but not carefully
|
|
|
378 reviewed in some time. Caveat tester.]
|
|
|
379
|
|
|
380 Starting with XEmacs 21.1, much of the functionality of XEmacs has
|
|
|
381 been unbundled into "the packages." For more information about the
|
|
|
382 package system, see the Info nodes on Packages (in the XEmacs User
|
|
|
383 Manual) and on Packaging (in the Lisp Reference).
|
|
|
384
|
|
|
385 When bootstrapping XEmacs, you may need to manually install some
|
|
|
386 packages (at least xemacs-base and efs). These packages are available
|
|
1250
|
387 by FTP at <ftp://ftp.xemacs.org/pub/xemacs/packages/>.
|
|
1024
|
388
|
|
|
389 ** Binary package installation
|
|
|
390 ==============================
|
|
|
391
|
|
|
392 Prerequisite: XEmacs 21.0-b1.
|
|
|
393
|
|
|
394 Binary packages are complete entities that can be untarred at the top
|
|
|
395 level of an XEmacs package hierarchy and work at runtime. To install files
|
|
|
396 in this directory, run the command `M-x package-admin-add-binary-package'
|
|
|
397 and fill in appropriate values to the prompts.
|
|
|
398
|
|
|
399 ** Manual procedures for package management
|
|
|
400 ===========================================
|
|
|
401
|
|
|
402 Prerequisite: XEmacs 21.0
|
|
|
403
|
|
|
404 When adding and deleting files from a lisp directory the
|
|
|
405 auto-autoloads.el (global symbols) and custom-load.el (Customization
|
|
|
406 groups) must be kept in synch. Assuming one is manipulating a
|
|
|
407 directory called `lisp-utils', the command to rebuild the
|
|
|
408 auto-autoloads.el file is:
|
|
|
409
|
|
1250
|
410 xemacs -vanilla -batch \
|
|
|
411 -eval \("setq autoload-package-name \"lisp-utils\""\) \
|
|
|
412 -f batch-update-directory lisp-utils
|
|
1024
|
413
|
|
|
414 The command to rebuild the custom-load.el file is:
|
|
|
415
|
|
1250
|
416 xemacs -vanilla -batch -f Custom-make-dependencies lisp-utils
|
|
1024
|
417
|
|
1250
|
418 To byte-compile both of these files the command is:
|
|
1024
|
419
|
|
|
420 xemacs -vanilla -batch -f batch-byte-compile \
|
|
|
421 lisp-utils/auto-autoloads.el lisp-utils/custom-load.el
|
|
|
422
|
|
1250
|
423 Of course, being a beta tester, you'd be aware that it is much easier
|
|
|
424 to manage your XEmacs packages with PUI.
|
|
|
425
|
|
1024
|
426 ** Building XEmacs and XEmacs packages from scratch
|
|
|
427 ===================================================
|
|
|
428
|
|
1250
|
429 To build everything completely from scratch isn't hard, just time
|
|
|
430 consuming.
|
|
1024
|
431
|
|
1250
|
432 *** Step 1 - grab the sources (core and packages)
|
|
1024
|
433
|
|
1250
|
434 $ cvs -d :pserver:cvs@cvs.xemacs.org:/pack/xemacscvs login
|
|
|
435 [password: "cvs" (sans quotes)]
|
|
1024
|
436
|
|
1301
|
437 $ cvs -d :pserver:cvs@cvs.xemacs.org:/pack/xemacscvs co -d xemacs-21.5 xemacs
|
|
1024
|
438
|
|
1250
|
439 $ cvs -d :pserver:cvs@cvs.xemacs.org:/pack/xemacscvs co packages
|
|
|
440
|
|
|
441 *** Step 2 - build XEmacs
|
|
1024
|
442
|
|
1250
|
443 $ cd xemacs-21.5
|
|
|
444 $ ./configure [options...]
|
|
|
445 $ make > ./beta.err 2>&1
|
|
|
446 $ make check > ./xemacs-make-check.err 2>&1
|
|
1024
|
447
|
|
1250
|
448 And optionally:
|
|
1024
|
449
|
|
1250
|
450 $ make install > ./xemacs-make-install.err 2>&1
|
|
|
451
|
|
|
452 *** Step 3 - build and install the packages
|
|
1024
|
453
|
|
1250
|
454 $ cd packages
|
|
|
455 $ cp Local.rules.template Local.rules
|
|
1024
|
456
|
|
1250
|
457 Then edit Local.rules to suit your needs/environment
|
|
|
458 see: (Info-goto-node "(xemacs)Local.rules file") for details about
|
|
|
459 this file.
|
|
1024
|
460
|
|
1250
|
461 And then:
|
|
1024
|
462
|
|
1250
|
463 $ make install
|
|
1024
|
464
|
|
|
465 * Improving XEmacs
|
|
743
|
466 =================
|
|
|
467
|
|
428
|
468 ** Creating patches for submission
|
|
|
469 ==================================
|
|
|
470
|
|
1044
|
471 All patches to XEmacs that are seriously proposed for inclusion (eg,
|
|
|
472 bug fixes) should be mailed to <xemacs-patches@xemacs.org>. Each
|
|
|
473 patch will be reviewed by the patches review board, and will be
|
|
743
|
474 acknowledged and added to the distribution, or rejected with an
|
|
|
475 explanation. Progress of the patch is tracked on the XEmacs Patches
|
|
1044
|
476 mailing list, which is open subscription. (If a patch is simply
|
|
|
477 intended to facilitate discussion, "I mean something that works like
|
|
1250
|
478 this but this is really rough", a Cc to XEmacs Patches is optional,
|
|
1044
|
479 but doesn't hurt.)
|
|
428
|
480
|
|
|
481 Patches to XEmacs Lisp packages should be sent to the maintainer of
|
|
|
482 the package. If the maintainer is listed as `XEmacs Development Team'
|
|
|
483 patches should be sent to <xemacs-patches@xemacs.org>.
|
|
|
484
|
|
|
485 Emailed patches should preferably be sent in MIME format and quoted
|
|
|
486 printable encoding (if necessary).
|
|
|
487
|
|
743
|
488 The simplest way to create well-formed patches is to use CVS and
|
|
|
489 Didier Verna's Patcher library (available as patcher.el in the
|
|
|
490 xemacs-devel package). Patcher is new and requires some setup, but
|
|
|
491 most of the core developers are now using it for their own patches.
|
|
|
492 Patcher also can be configured to create patches for several projects,
|
|
|
493 and recognize the project from the directory it is invoked in. This
|
|
|
494 makes it a useful general tool (as long as XEmacs-style patches are
|
|
|
495 accepted at your other projects, which is likely since they conform to
|
|
|
496 the GNU standards).
|
|
|
497
|
|
|
498 When making patches by hand, please use the `-u' option, or if your
|
|
|
499 diff doesn't support it, `-c'. Using ordinary (context-free) diffs
|
|
|
500 are notoriously prone to error, since line numbers tend to change when
|
|
428
|
501 others make changes to the same source file.
|
|
|
502
|
|
|
503 An example of the `diff' usage:
|
|
|
504
|
|
|
505 $ diff -u OLDFILE NEWFILE
|
|
|
506
|
|
|
507 -or-
|
|
|
508
|
|
|
509 $ diff -c OLDFILE NEWFILE
|
|
|
510
|
|
|
511 Also, it is helpful if you create the patch in the top level of the
|
|
|
512 XEmacs source directory:
|
|
|
513
|
|
|
514 $ cp -p lwlib/xlwmenu.c lwlib/xlwmenu.c.orig
|
|
|
515 hack, hack, hack....
|
|
|
516 $ diff -u lwlib/xlwmenu.c.orig lwlib/xlwmenu.c
|
|
|
517
|
|
|
518 Also note that if you cut & paste from an xterm to an XEmacs mail buffer
|
|
|
519 you will probably lose due to tab expansion. The best thing to do is
|
|
|
520 to use an XEmacs shell buffer to run the diff commands, or ...
|
|
|
521 M-x cd to the appropriate directory, and issue the command `C-u M-!' from
|
|
|
522 within XEmacs.
|
|
|
523
|
|
|
524 Patches should be as single-minded as possible. Mammoth patches can
|
|
|
525 be very difficult to place into the right slot. They are much easier
|
|
|
526 to deal with when broken down into functional or conceptual chunks.
|
|
|
527 The patches submitted by Kyle Jones and Hrvoje Niksic are stellar
|
|
1250
|
528 examples of how to "Do The Right Thing".
|
|
428
|
529
|
|
743
|
530 Each patch should be accompanied by an update to the appropriate
|
|
|
531 ChangeLog file. Guidelines for writing ChangeLog entries is governed
|
|
|
532 by the GNU coding standards. Please see
|
|
1250
|
533 <http://www.gnu.org/prep/standards_toc.html> [Change Logs section]
|
|
743
|
534 for details.
|
|
|
535
|
|
|
536 Do not submit context diffs (either -c or -u) of ChangeLogs. Because
|
|
|
537 of the "stack" nature of ChangeLogs (new entries are always pushed on
|
|
|
538 the top), context diffs will fail to apply more often than they
|
|
|
539 succeed. Simply cutting and pasting the entry from an Emacs buffer to
|
|
|
540 the mail buffer (beware of tab expansion!) is probably easiest. The
|
|
|
541 Patcher library also will set up your ChangeLogs for you, and copy
|
|
1250
|
542 them to the mail. Context-less unified diffs (-U 0) are also
|
|
|
543 acceptable.
|
|
428
|
544
|
|
743
|
545 *** Patch discussion etiquette
|
|
|
546 -------------------------------
|
|
428
|
547
|
|
743
|
548 If you intend a patch for _application_ to the sources as is, _always_
|
|
|
549 post it to xemacs-patches, even if there are minor points you would
|
|
|
550 like to have discussed by others. Not doing so will resulting in
|
|
|
551 patches getting "lost". If you expect that the patch will not be
|
|
|
552 acceptable, but are using it to stimulate discussion, then don't post
|
|
1250
|
553 to xemacs-patches. Intermediate cases are up to your judgment;
|
|
743
|
554 unless you're sure you'll follow up with a "real" patch, better to err
|
|
|
555 on the side of posting to xemacs-patches.
|
|
|
556
|
|
|
557 Discussion of the _content_ of the patch (ie responses to reviewer
|
|
|
558 comments beyond "that's right, ok, I'll do it your way") should _always_
|
|
1044
|
559 be posted to xemacs-beta or to xemacs-design. If you're not sure
|
|
|
560 which is more appropriate, send it to xemacs-beta. That is the most
|
|
|
561 widely read channel.
|
|
428
|
562
|
|
743
|
563 If discussion results in a bright idea and you come up with a new
|
|
|
564 patch, normally you should post it to both mailing lists. The people
|
|
|
565 discussing on XEmacs Beta will want to know the outcome of the thread,
|
|
|
566 and you need to submit to XEmacs Patches as the "list of record."
|
|
428
|
567
|
|
743
|
568 If the old patch has been applied to CVS, then just submit the new one
|
|
|
569 as usual. If it has not been applied, then it is best to submit a new
|
|
|
570 patch against CVS. If possible do this as a reply to the original
|
|
|
571 patch post, or something following it in the thread. (The point is to
|
|
|
572 get the original patch post's Message-ID in your References header.)
|
|
1044
|
573 In this case, also use the keyword SUPERSEDES in the Subject header to
|
|
743
|
574 indicate that the old patch is no longer valid, and that this one
|
|
|
575 replaces it.
|
|
|
576
|
|
|
577 These rules will result in a fair number of cross posts, but we don't
|
|
|
578 yet have a better way to handle that.
|
|
|
579
|
|
|
580 Note: Developers should never post to xemacs-patches unless there is a
|
|
|
581 patch in the post. We plan to enforce this with an automatic filter.
|
|
428
|
582
|
|
743
|
583 The exceptions are administrative. If you have commit authorization,
|
|
|
584 then post a short COMMIT notice to xemacs-patches when you commit to
|
|
|
585 CVS. Members of the Review Board will also post short notices of
|
|
|
586 administrative action (APPROVE, VETO, QUERY, etc) to xemacs-patches.
|
|
|
587
|
|
1024
|
588 ** Large contributions
|
|
|
589 ======================
|
|
743
|
590
|
|
1024
|
591 Perhaps you have a whole new mode, or a major synchronization with
|
|
|
592 upstream for a neglected package, or a synchronization with GNU Emacs
|
|
|
593 you would like to contribute. We welcome such contributions, but they
|
|
|
594 are likely to be relatively controversial, generate more comments and
|
|
|
595 requests for revision, and take longer to integrate. Please be
|
|
|
596 patient with the process.
|
|
428
|
597
|
|
1024
|
598 *** Updates to existing packages
|
|
|
599 --------------------------------
|
|
743
|
600
|
|
1024
|
601 If a package has gotten a bit out of date, or even started to bitrot,
|
|
|
602 we welcome patches to synchronize it with upstream/GNU Emacs versions.
|
|
|
603 Most packages end up varying somewhat from their GNU origins. See
|
|
|
604 "Syncing with GNU Emacs" for hints. Note that if you do a reasonably
|
|
|
605 large amount of syncing with GNU Emacs, you should log this in the
|
|
|
606 file itself as well as in the ChangeLog.
|
|
428
|
607
|
|
1024
|
608 If the package is important to you, please consider becoming the
|
|
|
609 maintainer. (See "New packages", below.)
|
|
428
|
610
|
|
1024
|
611 *** New packages
|
|
|
612 ----------------
|
|
428
|
613
|
|
1024
|
614 If you have a new mode or other large addition that does not require
|
|
|
615 changes to the core, please consider submitting it as a package, and
|
|
|
616 becoming the maintainer. You get direct commit privileges to the
|
|
|
617 repository for your package, "approval" privileges for your own
|
|
|
618 patches as well as third party patches to your package, and some
|
|
|
619 degree of veto power over patches you don't like. In return, you are
|
|
|
620 expected to maintain friendly liaison with the upstream developer (if
|
|
|
621 you aren't the upstream developer), keep watch on the XEmacs Patches
|
|
|
622 list for relevant patches, and be available by email to other
|
|
|
623 developers for discussion of changes that impact your package. It's
|
|
|
624 also a pretty standard route to the "core" development group, where we
|
|
|
625 have plenty of extra work waiting for volunteers.
|
|
428
|
626
|
|
1024
|
627 You don't have to become the maintainer, but it virtually ensures
|
|
|
628 rapid acceptance of the package.
|
|
428
|
629
|
|
1024
|
630 For help in creating new packages, see the (rather sparse) discussions
|
|
|
631 in the XEmacs User's Guide and the Lisp Reference Manual. The XEmacs
|
|
1301
|
632 Package Release Engineer (Ville Skyttä <scop@xemacs.org> is currently
|
|
1335
|
633 serving with Norbert Koch <viteno@xemacs.org> assisting; Steve
|
|
1301
|
634 Youngs <youngs@xemacs.org> and Stephen Turnbull <stephen@xemacs.org>
|
|
|
635 also can help) are the most likely sources of advice.
|
|
428
|
636
|
|
1024
|
637 *** Syncing with GNU Emacs
|
|
|
638 --------------------------
|
|
428
|
639
|
|
1024
|
640 Syncing with GNU Emacs is an important activity. Although each
|
|
|
641 version has its advantages and areas of concentration, it is very
|
|
|
642 desirable that common functionality share specifications and APIs.
|
|
|
643 When porting GNU code to XEmacs, the following points should be given
|
|
|
644 special attention:
|
|
428
|
645
|
|
1024
|
646 o Recent GNU Emacsen cannot be built without Mule, but XEmacs can.
|
|
|
647 Make sure your changes do not assume the presence of Mule.
|
|
428
|
648
|
|
1024
|
649 o GNU Emacs nomenclature often differs from that of XEmacs.
|
|
|
650 Sometimes syncing the names is desirable, other times not.
|
|
428
|
651
|
|
1024
|
652 o GNU Emacs functionality often differs from that of XEmacs.
|
|
|
653 Syncing functionality is often controversial.
|
|
428
|
654
|
|
1024
|
655 It is important that you let other developers know that
|
|
|
656 synchronization has taken place, to what degree, and when. For this
|
|
|
657 purpose, we use comments of the form
|
|
428
|
658
|
|
1024
|
659 /* Synched up with: FSF 21.3 by Stephen Turnbull */
|
|
428
|
660
|
|
1024
|
661 in the source file itself, as the last element of the prefatory
|
|
|
662 material (copyright notice and commentary). Obviously the comment
|
|
1301
|
663 marker needs to be changed to leading semicolons for Lisp, but
|
|
1024
|
664 otherwise the format is the same.
|
|
428
|
665
|
|
1024
|
666 Of course you should note syncing as the purpose in the ChangeLog,
|
|
|
667 too. But entries get buried deep in the ChangeLog file, and may even
|
|
|
668 get moved to a separate ChangeLog.OLD file for rarely synched files.
|
|
428
|
669
|
|
1024
|
670 Rather than dates we use the version of GNU Emacs to sync to. If the
|
|
|
671 synchronization is partial, add a new comment describing what has
|
|
|
672 actually been synched, leaving the description of the last full sync
|
|
|
673 in place. At each full sync, remove all previous synchronization
|
|
|
674 comments.
|
|
428
|
675
|
|
1024
|
676 This applies to Lisp that we have broken out into packages, but
|
|
|
677 remains in the GNU Emacs core, as well to core Lisp in XEmacs.
|
