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