Mercurial > hg > xemacs-beta
annotate man/beta.texi @ 5585:86d6adeb1cf4
Refactor check for Xaw3d.
author | Stephen J. Turnbull <stephen@xemacs.org> |
---|---|
date | Fri, 14 Oct 2011 03:54:46 +0900 |
parents | 308d34e9f07d |
children | d11efddf3617 |
rev | line source |
---|---|
2537 | 1 \input texinfo @c -*-texinfo-*- |
2 | |
2547 | 3 @c This file is in Texinfo format. |
4 @c If for some reason you do not have the formatted version available, | |
5 @c this file is more or less readable as plain text. | |
6 @c Skip to the line beginning "@node Introduction". | |
7 | |
2537 | 8 @c %**start of header |
9 @setfilename ../info/beta.info | |
10 @settitle Info on beta versions of XEmacs | |
11 @direntry | |
12 * Beta: (beta). Info on beta versions of XEmacs. | |
13 @end direntry | |
14 @c footnotestyle separate | |
15 @c paragraphindent 2 | |
16 @c %**end of header | |
17 | |
18 @ifinfo | |
19 This file describes info relevant to beta versions of XEmacs. | |
20 | |
21 Copyright @copyright{} 2005 Ben Wing. | |
2547 | 22 Copyright @copyright{} 2005 Free Software Foundation, Inc. |
2537 | 23 |
24 This file is part of XEmacs. | |
25 | |
5402
308d34e9f07d
Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents:
4708
diff
changeset
|
26 XEmacs is free software: you can redistribute it and/or modify it |
2537 | 27 under the terms of the GNU General Public License as published by the |
5402
308d34e9f07d
Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents:
4708
diff
changeset
|
28 Free Software Foundation, either version 3 of the License, or (at your |
308d34e9f07d
Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents:
4708
diff
changeset
|
29 option) any later version. |
2537 | 30 |
31 XEmacs is distributed in the hope that it will be useful, but WITHOUT | |
32 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
33 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
34 for more details. | |
35 | |
36 You should have received a copy of the GNU General Public License | |
5402
308d34e9f07d
Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents:
4708
diff
changeset
|
37 along with XEmacs. If not, see <http://www.gnu.org/licenses/>.@end ifinfo |
2537 | 38 |
39 @c Combine indices. | |
40 @syncodeindex fn cp | |
41 @syncodeindex vr cp | |
42 @syncodeindex ky cp | |
43 @syncodeindex pg cp | |
44 @syncodeindex tp cp | |
45 | |
46 @setchapternewpage odd | |
47 @finalout | |
48 | |
49 @titlepage | |
50 @title Info on beta versions of XEmacs | |
51 | |
52 @author XEmacs Development Team | |
53 @page | |
54 @vskip 0pt plus 1fill | |
55 | |
56 @noindent | |
3388 | 57 Copyright @copyright{} 2006 Free Software Foundation. @* |
2537 | 58 Copyright @copyright{} 2005 Ben Wing. @* |
59 | |
60 This file is part of XEmacs. | |
61 | |
62 XEmacs is free software; you can redistribute it and/or modify it | |
63 under the terms of the GNU General Public License as published by the | |
64 Free Software Foundation; either version 2, or (at your option) any | |
65 later version. | |
66 | |
67 XEmacs is distributed in the hope that it will be useful, but WITHOUT | |
68 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
69 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
70 for more details. | |
71 | |
72 You should have received a copy of the GNU General Public License | |
73 along with XEmacs; see the file COPYING. If not, write to | |
74 the Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
75 Boston, MA 02111-1307, USA. | |
76 @end titlepage | |
77 @page | |
78 | |
79 @ifinfo | |
80 @node Top, Introduction, (dir), (dir) | |
81 This Info file describes info relevant to beta versions of XEmacs. | |
82 @menu | |
83 * Introduction:: | |
3388 | 84 * Building Beta XEmacs:: |
2537 | 85 * Packages:: |
3388 | 86 * Reporting Problems:: |
2537 | 87 * Improving XEmacs:: |
3388 | 88 * Index:: |
2537 | 89 |
90 @detailmenu | |
91 --- The Detailed Node Listing --- | |
92 | |
93 Introduction | |
94 | |
95 * Mailing Lists:: | |
96 * Beta Release Schedule:: | |
97 | |
98 Mailing Lists | |
99 | |
100 * XEmacs Beta Mailing List:: | |
101 * XEmacs Patches Mailing List:: | |
102 * XEmacs Design Mailing List:: | |
103 * List Administrivia:: | |
104 * Managing your subscription via the Web:: | |
105 * Subscribing by e-mail:: | |
106 * Unsubscribing by e-mail:: | |
107 | |
3388 | 108 Building Beta XEmacs |
2537 | 109 |
3388 | 110 * Getting the Source:: |
2537 | 111 * Building an XEmacs from patches:: |
112 * Building XEmacs from a full distribution:: | |
113 | |
114 Packages | |
115 | |
116 * Binary package installation:: | |
117 * Manual procedures for package management:: | |
118 * Building XEmacs and XEmacs packages from scratch:: | |
119 | |
120 Improving XEmacs | |
121 | |
122 * Creating patches for submission:: | |
123 * Large contributions:: | |
124 | |
125 Creating patches for submission | |
126 | |
127 * Patch discussion etiquette:: | |
128 | |
129 Large contributions | |
130 | |
131 * Updates to existing packages:: | |
132 * New packages:: | |
133 * Syncing with GNU Emacs:: | |
134 | |
135 @end detailmenu | |
136 @end menu | |
137 | |
138 @end ifinfo | |
139 | |
3388 | 140 |
141 @node Introduction, Building Beta XEmacs, Top, Top | |
2537 | 142 @chapter Introduction |
143 | |
144 You are running a potentially unstable version of XEmacs. Please do | |
145 not report problems with Beta XEmacs to comp.emacs.xemacs. Report | |
146 them to @uref{mailto:xemacs-beta@@xemacs.org}, preferably with | |
147 @kbd{M-x report-xemacs-bug RET}. | |
148 | |
149 @menu | |
150 * Mailing Lists:: | |
151 * Beta Release Schedule:: | |
152 @end menu | |
153 | |
3388 | 154 |
2537 | 155 @node Mailing Lists, Beta Release Schedule, Introduction, Introduction |
156 @section Mailing Lists | |
157 | |
158 @menu | |
159 * XEmacs Beta Mailing List:: | |
160 * XEmacs Patches Mailing List:: | |
161 * XEmacs Design Mailing List:: | |
162 * List Administrivia:: | |
163 * Managing your subscription via the Web:: | |
164 * Subscribing by e-mail:: | |
165 * Unsubscribing by e-mail:: | |
166 @end menu | |
167 | |
3388 | 168 |
2537 | 169 @node XEmacs Beta Mailing List, XEmacs Patches Mailing List, Mailing Lists, Mailing Lists |
170 @subsection XEmacs Beta Mailing List | |
171 | |
172 If you are not subscribed to the XEmacs beta list you should be. | |
173 Currently all discussion of development issues, including bug reports | |
174 and coding discussion, takes place on the XEmacs Beta mailing list. | |
175 Only patches and administrative actions regarding patches are sent | |
176 elsewhere (to the XEmacs Patches list). | |
177 | |
3388 | 178 |
2537 | 179 @node XEmacs Patches Mailing List, XEmacs Design Mailing List, XEmacs Beta Mailing List, Mailing Lists |
180 @subsection XEmacs Patches Mailing List | |
181 | |
182 XEmacs Patches records proposed changes to XEmacs, and their | |
183 disposition. It is open subscription, and all patches that are | |
184 seriously proposed for inclusion in XEmacs should be posted here. You | |
185 can follow progress of your patch by subscribing to the mailing list | |
186 or in the archives. | |
187 | |
188 Besides patches, only actions by members of the XEmacs Review Board | |
189 should be posted to this list. All discussion should be redirected to | |
190 XEmacs Beta or XEmacs Design. | |
191 | |
3388 | 192 |
2537 | 193 @node XEmacs Design Mailing List, List Administrivia, XEmacs Patches Mailing List, Mailing Lists |
194 @subsection XEmacs Design Mailing List | |
195 | |
196 XEmacs Design is for design discussions such as adding major features | |
197 or whole modules, or reimplementation of existing functions, to XEmacs. | |
198 | |
199 @node List Administrivia, Managing your subscription via the Web, XEmacs Design Mailing List, Mailing Lists | |
200 @subsection List Administrivia | |
201 | |
202 In the descriptions below, the word LIST (all uppercase) is a | |
203 variable. Substitute "beta", "design", or "patches" as appropriate | |
204 (to get "xemacs-beta" as the mailbox for the XEmacs Beta mailing list, | |
205 or @uref{http://www.xemacs.org/Lists/#xemacs-beta} for its URL). | |
206 | |
207 The XEmacs mailing lists are managed by the Mailman mailing list package, | |
208 and the usual Mailman commands work. Do not send mailing list requests to | |
209 the main address (@uref{mailto:xemacs-LIST@@xemacs.org}), always send them | |
210 to @uref{mailto:xemacs-LIST-request@@xemacs.org}. If you have problems with | |
211 the list itself, they should be brought to the attention of the XEmacs | |
212 Mailing List manager @uref{mailto:list-manager@@xemacs.org} (the same | |
213 mailbox, "list-manager", for all lists). All public mailing lists have | |
214 searchable archives. The URL is | |
215 | |
216 @uref{http://list-archive.xemacs.org/xemacs-LIST} | |
217 | |
218 Note that the xemacs-LIST-admin address is used internally by the | |
219 Mailman software; it is NOT a synonym for xemacs-LIST-request. | |
220 | |
3388 | 221 |
2537 | 222 @node Managing your subscription via the Web, Subscribing by e-mail, List Administrivia, Mailing Lists |
223 @subsection Managing your subscription via the Web | |
224 | |
225 Subscription, unsubscription, and options (such as digests and | |
226 temporarily suspending delivery) can be accomplished via the web | |
227 interface at @uref{http://www.xemacs.org/Lists/#xemacs-LIST}. | |
228 | |
3388 | 229 |
2537 | 230 @node Subscribing by e-mail, Unsubscribing by e-mail, Managing your subscription via the Web, Mailing Lists |
231 @subsection Subscribing by e-mail | |
232 | |
233 Send an email message to @uref{mailto:xemacs-LIST-request@@xemacs.org} with | |
234 @samp{subscribe} (without the quotes) as the BODY of the message. | |
235 | |
3388 | 236 |
2537 | 237 @node Unsubscribing by e-mail, , Subscribing by e-mail, Mailing Lists |
238 @subsection Unsubscribing by e-mail | |
239 | |
240 Send an email message to @uref{mailto:xemacs-LIST-request@@xemacs.org} with | |
241 @samp{unsubscribe} (without the quotes) as the BODY of the message. | |
242 | |
3388 | 243 |
244 @node Beta Release Schedule, , Mailing Lists, Introduction | |
2537 | 245 @section Beta Release Schedule |
246 | |
247 We would like to achieve a weekly or fortnightly release cycle (you | |
248 know the Open Source model: release early, release often), and in a | |
249 perfect world that would indeed be the case. There are at least three | |
250 things that often get in the way of that goal: 1) The Release Manager | |
251 has a life outside of XEmacs (hard to believe, I know, but true), | |
252 2) we like to make releases that will build (at least on the Release | |
253 Manager's box), and 3) Murphy likes to throw a spanner in the works | |
254 right when you least expect it (Murphy's Law: Whatever can go wrong, | |
255 will go wrong). | |
256 | |
257 If you'd like to keep right up to date and ride the bleeding edge, use | |
258 CVS (see @uref{http://www.xemacs.org/Develop/cvsaccess.html}). If you | |
259 can't use CVS for some reason and must use FTP, please let us know. | |
260 it will make it more likely that we release betas more often. | |
261 | |
262 | |
3388 | 263 @node Building Beta XEmacs, Packages, Introduction, Top |
264 @chapter Building Beta XEmacs | |
2537 | 265 |
3388 | 266 @menu |
267 * Getting the Source:: | |
268 * Building an XEmacs from patches:: | |
269 * Building XEmacs from a full distribution:: | |
270 @end menu | |
2537 | 271 |
3388 | 272 |
273 @node Getting the Source, Building an XEmacs from patches, Building Beta XEmacs, Building Beta XEmacs | |
274 @section Getting the Source | |
2537 | 275 |
3388 | 276 We provide the traditional tarballs and release-to-release patchkits for |
277 each beta release. @xref{Beta Release Schedule}. These are available | |
278 at | |
2537 | 279 |
3388 | 280 @uref{ftp://ftp.xemacs.org/pub/xemacs/beta/} |
2537 | 281 |
282 In addition to the normal tar distribution, XEmacs source is now | |
283 available via CVS. Please see | |
284 | |
285 @uref{http://www.xemacs.org/Develop/cvsaccess.html} | |
286 | |
3388 | 287 You can also browse the repository via ViewCVS |
2537 | 288 |
3388 | 289 @uref{http://cvs.xemacs.org/} |
2537 | 290 |
3388 | 291 |
292 @node Building an XEmacs from patches, Building XEmacs from a full distribution, Getting the Source, Building Beta XEmacs | |
2537 | 293 @section Building an XEmacs from patches |
294 | |
3388 | 295 All beta releases of XEmacs provide patches from the previous version as |
296 an alternative to keep bandwidth requirements down. These patches are | |
297 actually scripts generated by the @file{makepatch} program, and can be | |
298 run if you have the @file{applypatch} program. Patches may also be | |
299 applied with the GNU patch program in something like the following. | |
300 Let's say you're upgrading XEmacs 21.5-beta9 to XEmacs 21.5-beta10 and | |
301 you have a full unmodified XEmacs 21.5-beta9 source tree to work with. | |
302 Change to the top level directory and issue the shell command: | |
2537 | 303 |
304 @example | |
305 $ gunzip -c /tmp/xemacs-21.5.9-21.5.10.patch.gz | patch -p1 | |
306 @end example | |
307 | |
308 After patching, check to see that no patches were missed by doing | |
309 | |
310 @example | |
311 $ find . -name \*.rej -print | |
312 @end example | |
313 | |
314 Any rejections should be treated as serious problems to be resolved | |
315 before building XEmacs. | |
316 | |
317 After seeing that there were no rejections, issue the commands | |
318 | |
319 @example | |
320 $ ./config.status --recheck | |
321 $ make beta > ./beta.err 2>&1 | |
322 $ make check > ./xemacs-make-check.err 2>&1 | |
323 @end example | |
324 | |
325 Redirect the output from make to those files because you'll use them | |
326 later when you send off a build report with @kbd{M-x build-report RET} | |
327 | |
3388 | 328 |
329 @node Building XEmacs from a full distribution, , Building an XEmacs from patches, Building Beta XEmacs | |
2537 | 330 @section Building XEmacs from a full distribution |
331 | |
332 @enumerate | |
333 @item | |
3388 | 334 Locate a convenient place where you have at least 200MB of free space |
335 (approximately 100MB for sources and compiled Lisp, and 100MB for | |
336 objects and other generated files) and issue the command | |
2537 | 337 |
338 @example | |
339 $ gunzip -c /tmp/xemacs-21.5.10.tar.gz | tar xvf - | |
340 @end example | |
341 | |
342 (or simply @code{tar zxvf /tmp/xemacs-21.5.10.tar.gz} if you use GNU tar). | |
343 | |
344 @item | |
345 cd to the top level directory and issue an appropriate configure | |
346 command. | |
347 | |
348 @item | |
349 Run @code{configure}. If you are new, just consider running it with no | |
4312 | 350 options, to see if you can get a successful build. When you are more |
2537 | 351 experienced, you should put various flags in. Here is what we suggest: |
352 | |
353 @enumerate | |
354 @item | |
355 It's a good idea to use | |
356 | |
357 @example | |
2647 | 358 --enable-debug |
359 --enable-memory-usage-stats | |
360 --enable-error-checking=all | |
2537 | 361 @end example |
362 | |
363 These turn on extra debugging info and checks. The last one in particular | |
364 will add a great deal of extra error-checking -- which will slow your XEmacs | |
365 down somewhat but is likely to catch bugs much sooner and make your bug | |
366 reports much more useful. | |
367 | |
368 @item | |
369 You should also strongly consider | |
370 | |
371 @example | |
2647 | 372 --enable-mule |
373 --enable-kkcc | |
374 --enable-pdump | |
375 --enable-clash-detection | |
2537 | 376 --with-wmcommand |
377 --with-xfs | |
378 @end example | |
379 | |
380 These turn on optional features, which can always use testing. | |
381 | |
382 @item | |
383 If you have gcc, consider using | |
384 | |
385 @example | |
2647 | 386 --with-compiler=gcc |
387 --with-xemacs-compiler=g++ | |
2537 | 388 @end example |
389 | |
3388 | 390 This will compile XEmacs using g++, which is generally much stricter |
391 about type-checking than C compilers like gcc. | |
2537 | 392 |
393 @item | |
394 If your packages are not installed under /usr/local, you should add a | |
395 line like | |
396 | |
397 @example | |
2647 | 398 --with-package-path=~/.xemacs::/xemacs/site-packages:/xemacs/xemacs-packages:/xemacs/mule-packages |
2537 | 399 @end example |
400 | |
401 @item | |
402 If you want to build multiple configurations from the same source | |
403 tree, make separate build directories for each configuration, run | |
404 @code{configure} from the top level of these (currently empty) | |
405 directories and use an option like | |
406 | |
407 @example | |
408 --srcdir=/xemacs/source-tree | |
409 @end example | |
410 | |
411 (or wherever your source tree is). This will magically create symlinks and | |
412 populate your build directory. | |
413 | |
414 @item | |
2647 | 415 Use --with-site-prefixes (or --with-site-includes and |
416 ---with-site-libraries) if you have some packages that XEmacs can | |
417 compile with that are located in an unusual place. For example: | |
2537 | 418 |
419 @example | |
2647 | 420 --with-site-prefixes=/usr/local/pgsql:/usr/local/BerkeleyDB.4.1 |
2537 | 421 @end example |
422 | |
423 @item | |
4312 | 424 Depending on your build environment, consider setting or not setting |
2537 | 425 options for menubars, scrollbars, window systems, native sound, etc. If |
426 you're not sure, leave them out and let configure do the auto-detection. | |
427 (If you get bugs compiling GTK, use @code{--with-gtk=no --with-gnome=no}.) | |
428 | |
429 Part of the configure output is a summary that looks something | |
430 like the following. (this summary is also available as the file | |
431 'Installation' in the top directory of your build tree, and via | |
432 the command @kbd{M-x describe-installation RET}). | |
433 | |
434 @example | |
2647 | 435 uname -a: Darwin laptop.local 7.7.0 Darwin Kernel Version 7.7.0: Sun Nov 7 16:06:51 PST 2004; root:xnu/xnu-517.9.5.obj~1/RELEASE_PPC Power Macintosh powerpc |
2537 | 436 |
2647 | 437 ./configure '--with-site-prefixes=/sw' '--without-ldap' '--with-dynamic=yes' '--with-gtk=no' '--with-gnome=no' '--enable-toolbars' '--with-wmcommand' '--with-athena=3d' '--enable-menubars=lucid' '--enable-scrollbars=athena' '--enable-dialogs=athena' '--enable-widgets=athena' '--with-gif' '--enable-sound=native,noesd' '--with-site-lisp=no' '--with-site-modules' '--enable-pdump' '--enable-mule' '--with-xfs' '--enable-debug' '--enable-error-checking=all' '--enable-memory-usage-stats' '--enable-kkcc' '--enable-clash-detection' |
2537 | 438 |
439 | |
2647 | 440 XEmacs 21.5-b19 "chives" (+CVS-20050226) configured for `powerpc-apple-darwin7.7.0'. |
441 | |
442 WARNING: -------------------------------------------------------------- | |
443 WARNING: This was produced from a new autoconf-2.5 based configuration. | |
444 WARNING: If this configuration seems buggy then copy etc/configure-2.13 | |
445 WARNING: to configure and try again. Also please report the bug. | |
446 WARNING: -------------------------------------------------------------- | |
447 | |
448 Compilation Environment and Installation Defaults: | |
2537 | 449 Source code location: /usr/local/src/xemacs |
450 Installation prefix: /usr/local | |
2647 | 451 Additional prefixes: /sw |
452 Operating system description file: `s/darwin.h' | |
453 Machine description file: `m/powerpc.h' | |
454 Compiler version: gcc (GCC) 3.3 20030304 (Apple Computer, Inc. build 1671) | |
455 - GCC specs file: /usr/libexec/gcc/darwin/ppc/3.3/specs | |
456 - Compiler command: gcc -Wall -Wno-switch -Wundef -Wsign-compare -Wno-char-subscripts -Wpacked -Wpointer-arith -Wunused-parameter -g | |
457 libc version: | |
2537 | 458 Relocating allocator for buffers: no |
2647 | 459 GNU version of malloc: no |
460 - The GNU allocators don't work with this system configuration. | |
2537 | 461 |
462 Window System: | |
463 Compiling in support for the X window system: | |
2647 | 464 - X Windows headers location: /usr/X11R6/include |
465 - X Windows libraries location: /usr/X11R6/lib | |
2537 | 466 - Handling WM_COMMAND properly. |
467 Compiling in support for the Athena widget set: | |
2647 | 468 - Athena headers location: X11/Xaw3d |
469 - Athena library to link: Xaw3d | |
2537 | 470 Using Lucid menubars. |
471 Using Athena scrollbars. | |
472 Using Athena dialog boxes. | |
473 Using Athena native widgets. | |
474 | |
475 TTY: | |
476 Compiling in support for ncurses. | |
477 | |
478 Images: | |
4708
1cecc3e9f0a0
Use giflib or libungif to provide GIF support, instead of using internal
Jerry James <james@xemacs.org>
parents:
4312
diff
changeset
|
479 Compiling in support for GIF images. |
2537 | 480 Compiling in support for XPM images. |
481 Compiling in support for PNG images. | |
482 Compiling in support for JPEG images. | |
483 Compiling in support for TIFF images. | |
484 Compiling in support for X-Face message headers. | |
485 | |
486 Sound: | |
487 | |
488 Databases: | |
489 Compiling in support for Berkeley database. | |
2647 | 490 Compiling in support for GNU DBM. |
2537 | 491 Compiling in support for PostgreSQL. |
2647 | 492 - Using PostgreSQL header file: postgresql/libpq-fe.h |
2537 | 493 - Using PostgreSQL V7 bindings. |
494 | |
495 Internationalization: | |
496 Compiling in support for Mule (multi-lingual Emacs). | |
497 Compiling in support for XIM (X11R5+ I18N input method). | |
498 - Using raw Xlib to provide XIM support. | |
499 - Using XFontSet to provide bilingual menubar. | |
500 | |
501 Mail: | |
2647 | 502 Compiling in support for "file" mail spool file locking method. |
2537 | 503 |
504 Other Features: | |
505 Inhibiting IPv6 canonicalization at startup. | |
506 Compiling in support for dynamic shared object modules. | |
507 Using the new GC algorithms. | |
508 Using the new portable dumper. | |
509 Compiling in support for extra debugging code. | |
2647 | 510 Compiling in support for runtime error checking. |
511 WARNING: --------------------------------------------------------- | |
2537 | 512 WARNING: XEmacs will run noticeably more slowly as a result. |
513 WARNING: Error checking is on by default for XEmacs beta releases. | |
2647 | 514 WARNING: --------------------------------------------------------- |
2537 | 515 @end example |
516 @end enumerate | |
517 | |
518 | |
519 @item | |
520 Then... | |
521 | |
522 @example | |
523 $ make > ./beta.err 2>&1 | |
524 $ make check > ./xemacs-make-check.err 2>&1 | |
525 @end example | |
526 | |
527 ...and you should have a working XEmacs. | |
528 | |
529 @item | |
530 After you have verified that you have a functional editor, fire up | |
531 your favorite mail program and send a build report to | |
532 @uref{mailto:xemacs-buildreports@@xemacs.org}. | |
533 | |
534 Preferably this is best done from XEmacs, following these simple steps: | |
535 | |
536 @enumerate | |
537 @kbd{M-x customize-group RET build-report RET} | |
538 @kbd{M-x build-report RET} | |
539 @end enumerate | |
540 | |
541 See also | |
542 @uref{http://www.xemacs.org/Releases/Public-21.2/tester.html#reporting} | |
543 | |
544 If you create the report manually by other means, here is what the | |
545 build report should include: | |
546 | |
547 @enumerate | |
548 @item | |
549 Your hardware configuration (OS version, etc.) | |
550 | |
551 @item | |
552 Version numbers of software in use (X11 version, system library | |
553 versions if appropriate, graphics library versions if appropriate). | |
554 If you're on a system like Linux, include all the version numbers | |
555 you can because chances are it makes a difference. | |
556 | |
557 @item | |
558 The options given to configure | |
559 | |
560 @item | |
561 The configuration report illustrated above | |
562 | |
563 For convenience all of the above items are placed in a file called | |
564 `Installation' in the top level build directory. They are also | |
565 available by performing @kbd{M-x describe-installation} inside XEmacs. | |
566 | |
567 @item | |
568 Any other unusual items you feel should be brought to the attention | |
569 of the developers. | |
570 @end enumerate | |
571 @end enumerate | |
572 | |
3388 | 573 |
574 @node Packages, Reporting Problems, Building Beta XEmacs, Top | |
2537 | 575 @chapter Packages |
576 | |
577 [Note: these instructions have been partly updated, but not carefully | |
578 reviewed in some time. Caveat tester.] | |
579 | |
580 Starting with XEmacs 21.1, much of the functionality of XEmacs has | |
581 been unbundled into "the packages." For more information about the | |
582 package system, see the Info nodes on Packages (in the XEmacs User | |
583 Manual) and on Packaging (in the Lisp Reference). | |
584 | |
585 When bootstrapping XEmacs, you may need to manually install some | |
586 packages (at least xemacs-base and efs). These packages are available | |
587 by FTP at @uref{ftp://ftp.xemacs.org/pub/xemacs/packages/}. | |
588 | |
589 @menu | |
590 * Binary package installation:: | |
591 * Manual procedures for package management:: | |
592 * Building XEmacs and XEmacs packages from scratch:: | |
593 @end menu | |
594 | |
3388 | 595 |
2537 | 596 @node Binary package installation, Manual procedures for package management, Packages, Packages |
597 @section Binary package installation | |
598 | |
599 Prerequisite: XEmacs 21.0-b1. | |
600 | |
601 Binary packages are complete entities that can be untarred at the top | |
602 level of an XEmacs package hierarchy and work at runtime. To install files | |
603 in this directory, run the command @kbd{M-x package-admin-add-binary-package} | |
604 and fill in appropriate values to the prompts. | |
605 | |
3388 | 606 |
2537 | 607 @node Manual procedures for package management, Building XEmacs and XEmacs packages from scratch, Binary package installation, Packages |
608 @section Manual procedures for package management | |
609 | |
610 Prerequisite: XEmacs 21.0 | |
611 | |
612 When adding and deleting files from a lisp directory the | |
613 auto-autoloads.el (global symbols) and custom-load.el (Customization | |
614 groups) must be kept in synch. Assuming one is manipulating a | |
615 directory called `lisp-utils', the command to rebuild the | |
616 auto-autoloads.el file is: | |
617 | |
618 @example | |
619 xemacs -vanilla -batch \ | |
620 -eval \("setq autoload-package-name \"lisp-utils\""\) \ | |
621 -f batch-update-directory lisp-utils | |
622 @end example | |
623 | |
624 The command to rebuild the custom-load.el file is: | |
625 | |
626 @example | |
627 xemacs -vanilla -batch -f Custom-make-dependencies lisp-utils | |
628 @end example | |
629 | |
630 To byte-compile both of these files the command is: | |
631 | |
632 @example | |
633 xemacs -vanilla -batch -f batch-byte-compile \ | |
634 lisp-utils/auto-autoloads.el lisp-utils/custom-load.el | |
635 @end example | |
636 | |
637 Of course, being a beta tester, you'd be aware that it is much easier | |
638 to manage your XEmacs packages with PUI. | |
639 | |
3388 | 640 |
641 @node Building XEmacs and XEmacs packages from scratch, , Manual procedures for package management, Packages | |
2537 | 642 @section Building XEmacs and XEmacs packages from scratch |
643 | |
644 To build everything completely from scratch isn't hard, just time | |
645 consuming. | |
646 | |
647 @subheading Step 1 - grab the sources (core and packages) | |
648 | |
649 @example | |
650 $ cvs -d :pserver:cvs@@cvs.xemacs.org:/pack/xemacscvs login | |
651 [password: "cvs" (sans quotes)] | |
652 | |
653 $ cvs -d :pserver:cvs@@cvs.xemacs.org:/pack/xemacscvs co -d xemacs-21.5 xemacs | |
654 | |
655 $ cvs -d :pserver:cvs@@cvs.xemacs.org:/pack/xemacscvs co packages | |
656 @end example | |
657 | |
658 @subheading Step 2 - build XEmacs | |
659 | |
660 @example | |
661 $ cd xemacs-21.5 | |
662 $ ./configure [options...] | |
663 $ make > ./beta.err 2>&1 | |
664 $ make check > ./xemacs-make-check.err 2>&1 | |
665 @end example | |
666 | |
667 And optionally: | |
668 | |
669 @example | |
670 $ make install > ./xemacs-make-install.err 2>&1 | |
671 @end example | |
672 | |
673 @subheading Step 3 - build and install the packages | |
674 | |
675 @example | |
676 $ cd packages | |
677 $ cp Local.rules.template Local.rules | |
678 @end example | |
679 | |
680 Then edit Local.rules to suit your needs/environment | |
681 (@pxref{Local.rules file,,, xemacs, XEmacs User's Manual}) for details | |
682 about this file. | |
683 | |
684 And then: | |
685 | |
686 @example | |
687 $ make install | |
688 @end example | |
689 | |
3388 | 690 |
691 @node Reporting Problems, Improving XEmacs, Packages, Top | |
692 @section Reporting Problems | |
693 | |
694 The best way to get problems fixed in XEmacs is to submit good problem | |
695 reports, @kbd{M-x report-xemacs-bug RET} will help you do this (assuming | |
696 you have a usable XEmacs). Since this is beta software, problems are | |
697 certain to exist. Please read through all of part II of the XEmacs | |
698 FAQ for an overview of problem reporting. | |
699 @xref{Installation, Installation and Troubleshooting, , xemacs-faq}. | |
700 The most relevant parts are in section 2.4, General Troubleshooting. | |
701 @c #### Why doesn't this link work? | |
702 @c @ref{Q2.4.1, General Troubleshooting, , xemacs-faq}. | |
703 Other items which are most important are: | |
704 | |
705 @enumerate | |
706 @item | |
707 Do not submit C stack backtraces without line numbers. Since it | |
708 is possible to compile optimized with debug information with GCC | |
709 it is never a good idea to compile XEmacs without the -g flag. | |
710 XEmacs runs on a variety of platforms, and often it is not | |
711 possible to recreate problems which afflict a specific platform. | |
712 The line numbers in the C stack backtrace help isolate where the | |
713 problem is actually occurring. | |
714 | |
715 @item | |
716 Attempt to recreate the problem starting with an invocation of | |
717 XEmacs with @code{xemacs -no-autoloads}. Quite often, problems are | |
718 due to package interdependencies, and the like. An actual bug | |
719 in XEmacs should be reproducible in a default configuration | |
720 without loading any special packages (or the one or two specific | |
721 packages that cause the bug to appear). If you have trouble | |
722 getting anything to work at all with the above invocation, use | |
723 @code{xemacs -vanilla} instead. If you need to load your user init | |
724 file or the site file to get the problem to occur, then it has | |
725 something to do with them, and you should try to isolate the | |
726 issue in those files. | |
727 | |
728 @item | |
729 A picture can be worth a thousand words. When reporting an | |
730 unusual display, it is generally best to capture the problem in a | |
731 screen dump and include that with the problem report. The easiest | |
732 way to get a screen dump is to use the xv program and its grab | |
4708
1cecc3e9f0a0
Use giflib or libungif to provide GIF support, instead of using internal
Jerry James <james@xemacs.org>
parents:
4312
diff
changeset
|
733 function. Save the image as a PNG to keep bandwidth requirements |
3388 | 734 down without loss of information. MIME is the preferred method |
735 for making the image attachments. | |
736 @end enumerate | |
737 | |
738 | |
739 @node Improving XEmacs, Index, Reporting Problems, Top | |
2537 | 740 @chapter Improving XEmacs |
741 | |
742 @menu | |
743 * Creating patches for submission:: | |
744 * Large contributions:: | |
745 @end menu | |
746 | |
747 @node Creating patches for submission, Large contributions, Improving XEmacs, Improving XEmacs | |
748 @section Creating patches for submission | |
749 | |
750 All patches to XEmacs that are seriously proposed for inclusion (eg, | |
751 bug fixes) should be mailed to @uref{mailto:xemacs-patches@@xemacs.org}. Each | |
752 patch will be reviewed by the patches review board, and will be | |
753 acknowledged and added to the distribution, or rejected with an | |
754 explanation. Progress of the patch is tracked on the XEmacs Patches | |
755 mailing list, which is open subscription. (If a patch is simply | |
756 intended to facilitate discussion, "I mean something that works like | |
757 this but this is really rough", a Cc to XEmacs Patches is optional, | |
758 but doesn't hurt.) | |
759 | |
760 Patches to XEmacs Lisp packages should be sent to the maintainer of | |
761 the package. If the maintainer is listed as `XEmacs Development Team' | |
762 patches should be sent to @uref{mailto:xemacs-patches@@xemacs.org}. | |
763 | |
764 Emailed patches should preferably be sent in MIME format and quoted | |
765 printable encoding (if necessary). | |
766 | |
767 The simplest way to create well-formed patches is to use CVS and | |
768 Didier Verna's Patcher library (available as patcher.el in the | |
769 xemacs-devel package). Patcher is new and requires some setup, but | |
770 most of the core developers are now using it for their own patches. | |
771 Patcher also can be configured to create patches for several projects, | |
772 and recognize the project from the directory it is invoked in. This | |
773 makes it a useful general tool (as long as XEmacs-style patches are | |
774 accepted at your other projects, which is likely since they conform to | |
775 the GNU standards). | |
776 | |
777 When making patches by hand, please use the `-u' option, or if your | |
778 diff doesn't support it, `-c'. Using ordinary (context-free) diffs | |
779 are notoriously prone to error, since line numbers tend to change when | |
780 others make changes to the same source file. | |
781 | |
782 An example of the `diff' usage: | |
783 | |
784 @example | |
785 $ diff -u OLDFILE NEWFILE | |
786 @end example | |
787 | |
788 -or- | |
789 | |
790 @example | |
791 $ diff -c OLDFILE NEWFILE | |
792 @end example | |
793 | |
794 Also, it is helpful if you create the patch in the top level of the | |
795 XEmacs source directory: | |
796 | |
797 @example | |
798 $ cp -p lwlib/xlwmenu.c lwlib/xlwmenu.c.orig | |
799 hack, hack, hack.... | |
800 $ diff -u lwlib/xlwmenu.c.orig lwlib/xlwmenu.c | |
801 @end example | |
802 | |
803 Also note that if you cut & paste from an xterm to an XEmacs mail | |
804 buffer you will probably lose due to tab expansion. The best thing to | |
805 do is to use an XEmacs shell buffer to run the diff commands, or ... | |
806 @kbd{M-x cd} to the appropriate directory, and issue the command | |
807 @kbd{C-u M-!} from within XEmacs. | |
808 | |
809 Patches should be as single-minded as possible. Mammoth patches can | |
810 be very difficult to place into the right slot. They are much easier | |
811 to deal with when broken down into functional or conceptual chunks. | |
812 The patches submitted by Kyle Jones and Hrvoje Niksic are stellar | |
813 examples of how to "Do The Right Thing". | |
814 | |
815 Each patch should be accompanied by an update to the appropriate | |
816 ChangeLog file. Guidelines for writing ChangeLog entries is governed | |
817 by the GNU coding standards. Please see | |
818 @uref{http://www.gnu.org/prep/standards_toc.html} [Change Logs section] | |
819 for details. | |
820 | |
821 Do not submit context diffs (either -c or -u) of ChangeLogs. Because | |
822 of the "stack" nature of ChangeLogs (new entries are always pushed on | |
823 the top), context diffs will fail to apply more often than they | |
824 succeed. Simply cutting and pasting the entry from an Emacs buffer to | |
825 the mail buffer (beware of tab expansion!) is probably easiest. The | |
826 Patcher library also will set up your ChangeLogs for you, and copy | |
827 them to the mail. Context-less unified diffs (-U 0) are also | |
828 acceptable. | |
829 | |
830 @menu | |
831 * Patch discussion etiquette:: | |
832 @end menu | |
833 | |
834 @node Patch discussion etiquette, , Creating patches for submission, Creating patches for submission | |
835 @subsection Patch discussion etiquette | |
836 | |
837 If you intend a patch for _application_ to the sources as is, _always_ | |
838 post it to xemacs-patches, even if there are minor points you would | |
839 like to have discussed by others. Not doing so will resulting in | |
840 patches getting "lost". If you expect that the patch will not be | |
841 acceptable, but are using it to stimulate discussion, then don't post | |
842 to xemacs-patches. Intermediate cases are up to your judgment; | |
843 unless you're sure you'll follow up with a "real" patch, better to err | |
844 on the side of posting to xemacs-patches. | |
845 | |
846 Discussion of the _content_ of the patch (ie responses to reviewer | |
847 comments beyond "that's right, ok, I'll do it your way") should _always_ | |
848 be posted to xemacs-beta or to xemacs-design. If you're not sure | |
849 which is more appropriate, send it to xemacs-beta. That is the most | |
850 widely read channel. | |
851 | |
852 If discussion results in a bright idea and you come up with a new | |
853 patch, normally you should post it to both mailing lists. The people | |
854 discussing on XEmacs Beta will want to know the outcome of the thread, | |
855 and you need to submit to XEmacs Patches as the "list of record." | |
856 | |
857 If the old patch has been applied to CVS, then just submit the new one | |
858 as usual. If it has not been applied, then it is best to submit a new | |
859 patch against CVS. If possible do this as a reply to the original | |
860 patch post, or something following it in the thread. (The point is to | |
861 get the original patch post's Message-ID in your References header.) | |
862 In this case, also use the keyword SUPERSEDES in the Subject header to | |
863 indicate that the old patch is no longer valid, and that this one | |
864 replaces it. | |
865 | |
866 These rules will result in a fair number of cross posts, but we don't | |
867 yet have a better way to handle that. | |
868 | |
869 Note: Developers should never post to xemacs-patches unless there is a | |
870 patch in the post. We plan to enforce this with an automatic filter. | |
871 | |
872 The exceptions are administrative. If you have commit authorization, | |
873 then post a short COMMIT notice to xemacs-patches when you commit to | |
874 CVS. Members of the Review Board will also post short notices of | |
875 administrative action (APPROVE, VETO, QUERY, etc) to xemacs-patches. | |
876 | |
877 @node Large contributions, , Creating patches for submission, Improving XEmacs | |
878 @section Large contributions | |
879 | |
880 Perhaps you have a whole new mode, or a major synchronization with | |
881 upstream for a neglected package, or a synchronization with GNU Emacs | |
882 you would like to contribute. We welcome such contributions, but they | |
883 are likely to be relatively controversial, generate more comments and | |
884 requests for revision, and take longer to integrate. Please be | |
885 patient with the process. | |
886 | |
887 @menu | |
888 * Updates to existing packages:: | |
889 * New packages:: | |
890 * Syncing with GNU Emacs:: | |
891 @end menu | |
892 | |
893 @node Updates to existing packages, New packages, Large contributions, Large contributions | |
894 @subsection Updates to existing packages | |
895 | |
896 If a package has gotten a bit out of date, or even started to bitrot, | |
897 we welcome patches to synchronize it with upstream/GNU Emacs versions. | |
898 Most packages end up varying somewhat from their GNU origins. See | |
899 "Syncing with GNU Emacs" for hints. Note that if you do a reasonably | |
900 large amount of syncing with GNU Emacs, you should log this in the | |
901 file itself as well as in the ChangeLog. | |
902 | |
903 If the package is important to you, please consider becoming the | |
904 maintainer. (See "New packages", below.) | |
905 | |
906 @node New packages, Syncing with GNU Emacs, Updates to existing packages, Large contributions | |
907 @subsection New packages | |
908 | |
909 If you have a new mode or other large addition that does not require | |
910 changes to the core, please consider submitting it as a package, and | |
911 becoming the maintainer. You get direct commit privileges to the | |
912 repository for your package, "approval" privileges for your own | |
913 patches as well as third party patches to your package, and some | |
914 degree of veto power over patches you don't like. In return, you are | |
915 expected to maintain friendly liaison with the upstream developer (if | |
916 you aren't the upstream developer), keep watch on the XEmacs Patches | |
917 list for relevant patches, and be available by email to other | |
918 developers for discussion of changes that impact your package. It's | |
919 also a pretty standard route to the "core" development group, where we | |
920 have plenty of extra work waiting for volunteers. | |
921 | |
922 You don't have to become the maintainer, but it virtually ensures | |
923 rapid acceptance of the package. | |
924 | |
925 For help in creating new packages, see the (rather sparse) discussions | |
2547 | 926 in the XEmacs User's Guide and the Lisp Reference Manual. The |
927 participants in the XEmacs Beta mailing list | |
928 @uref{mailto:xemacs-beta@@xemacs.org} and the XEmacs Package Release | |
929 Engineer are the most likely sources of advice. See | |
930 @uref{http://www.xemacs.org/Develop/jobs.html#package,jobs.html} for | |
931 current information about package release engineers. | |
2537 | 932 |
3388 | 933 |
2537 | 934 @node Syncing with GNU Emacs, , New packages, Large contributions |
935 @subsection Syncing with GNU Emacs | |
936 | |
937 Syncing with GNU Emacs is an important activity. Although each | |
938 version has its advantages and areas of concentration, it is very | |
939 desirable that common functionality share specifications and APIs. | |
940 When porting GNU code to XEmacs, the following points should be given | |
941 special attention: | |
942 | |
943 @itemize @bullet | |
944 @item | |
945 Recent GNU Emacsen cannot be built without Mule, but XEmacs can. | |
2547 | 946 Make sure that changes that depend on the presence of Mule are |
947 appropriately conditionalized, with @samp{#ifdef MULE} in C code and | |
948 with @samp{(featurep 'mule)} in Lisp. | |
2537 | 949 |
950 @item | |
951 GNU Emacs nomenclature often differs from that of XEmacs. | |
952 Sometimes syncing the names is desirable, other times not. | |
953 | |
954 @item | |
955 GNU Emacs functionality often differs from that of XEmacs. | |
956 Syncing functionality is often controversial. | |
957 @end itemize | |
958 | |
959 It is important that you let other developers know that | |
960 synchronization has taken place, to what degree, and when. For this | |
961 purpose, we use comments of the form | |
962 | |
963 @example | |
2547 | 964 /* Synched up with: GNU 21.3 by Stephen Turnbull */ |
2537 | 965 @end example |
966 | |
967 in the source file itself, as the last element of the prefatory | |
968 material (copyright notice and commentary). Obviously the comment | |
969 marker needs to be changed to leading semicolons for Lisp, but | |
2547 | 970 otherwise the format is the same. (Older sync comments may have ``FSF'' |
971 in place of ``GNU''. They're equally accurate in our opinion, but | |
972 Richard Stallman and other GNU developers consider the term ``FSF | |
973 Emacs'' ``insulting''. Please use ``GNU'' in new sync comments.) | |
2537 | 974 |
975 Of course you should note syncing as the purpose in the ChangeLog, | |
976 too. But entries get buried deep in the ChangeLog file, and may even | |
977 get moved to a separate ChangeLog.OLD file for rarely synched files. | |
978 | |
979 Rather than dates we use the version of GNU Emacs to sync to. If the | |
980 synchronization is partial, add a new comment describing what has | |
981 actually been synched, leaving the description of the last full sync | |
982 in place. At each full sync, remove all previous synchronization | |
983 comments. | |
984 | |
985 This applies to Lisp that we have broken out into packages, but | |
986 remains in the GNU Emacs core, as well to core Lisp in XEmacs. | |
987 | |
988 @c Print the tables of contents | |
989 @contents | |
990 @c That's all | |
991 | |
3388 | 992 |
2547 | 993 @node Index, , Improving XEmacs, Top |
2537 | 994 @unnumbered Index |
995 | |
996 @printindex cp | |
997 | |
998 @bye |