comparison man/beta.texi @ 3388:e7fb0df1caea

[xemacs-hg @ 2006-05-09 05:15:15 by stephent] Improve beta Info. <87ody7n5k6.fsf@tleepslib.sk.tsukuba.ac.jp>
author stephent
date Tue, 09 May 2006 05:15:15 +0000
parents 89e2f8e3f660
children 1094d6d400fb
comparison
equal deleted inserted replaced
3387:f5d8dba84d4f 3388:e7fb0df1caea
55 @author XEmacs Development Team 55 @author XEmacs Development Team
56 @page 56 @page
57 @vskip 0pt plus 1fill 57 @vskip 0pt plus 1fill
58 58
59 @noindent 59 @noindent
60 Copyright @copyright{} 2006 Free Software Foundation. @*
60 Copyright @copyright{} 2005 Ben Wing. @* 61 Copyright @copyright{} 2005 Ben Wing. @*
61 62
62 This file is part of XEmacs. 63 This file is part of XEmacs.
63 64
64 XEmacs is free software; you can redistribute it and/or modify it 65 XEmacs is free software; you can redistribute it and/or modify it
81 @ifinfo 82 @ifinfo
82 @node Top, Introduction, (dir), (dir) 83 @node Top, Introduction, (dir), (dir)
83 This Info file describes info relevant to beta versions of XEmacs. 84 This Info file describes info relevant to beta versions of XEmacs.
84 @menu 85 @menu
85 * Introduction:: 86 * Introduction::
86 * Compiling Beta XEmacs:: 87 * Building Beta XEmacs::
87 * Packages:: 88 * Packages::
89 * Reporting Problems::
88 * Improving XEmacs:: 90 * Improving XEmacs::
89 * Index:: 91 * Index::
90 92
91 @detailmenu 93 @detailmenu
92 --- The Detailed Node Listing --- 94 --- The Detailed Node Listing ---
93 95
94 Introduction 96 Introduction
95 97
96 * Mailing Lists:: 98 * Mailing Lists::
97 * Beta Release Schedule:: 99 * Beta Release Schedule::
98 * Reporting Problems::
99 * Getting the Source::
100 100
101 Mailing Lists 101 Mailing Lists
102 102
103 * XEmacs Beta Mailing List:: 103 * XEmacs Beta Mailing List::
104 * XEmacs Patches Mailing List:: 104 * XEmacs Patches Mailing List::
106 * List Administrivia:: 106 * List Administrivia::
107 * Managing your subscription via the Web:: 107 * Managing your subscription via the Web::
108 * Subscribing by e-mail:: 108 * Subscribing by e-mail::
109 * Unsubscribing by e-mail:: 109 * Unsubscribing by e-mail::
110 110
111 Compiling Beta XEmacs 111 Building Beta XEmacs
112 112
113 * Getting the Source::
113 * Building an XEmacs from patches:: 114 * Building an XEmacs from patches::
114 * Building XEmacs from a full distribution:: 115 * Building XEmacs from a full distribution::
115 116
116 Packages 117 Packages
117 118
137 @end detailmenu 138 @end detailmenu
138 @end menu 139 @end menu
139 140
140 @end ifinfo 141 @end ifinfo
141 142
142 @node Introduction, Compiling Beta XEmacs, Top, Top 143
144 @node Introduction, Building Beta XEmacs, Top, Top
143 @chapter Introduction 145 @chapter Introduction
144 146
145 You are running a potentially unstable version of XEmacs. Please do 147 You are running a potentially unstable version of XEmacs. Please do
146 not report problems with Beta XEmacs to comp.emacs.xemacs. Report 148 not report problems with Beta XEmacs to comp.emacs.xemacs. Report
147 them to @uref{mailto:xemacs-beta@@xemacs.org}, preferably with 149 them to @uref{mailto:xemacs-beta@@xemacs.org}, preferably with
148 @kbd{M-x report-xemacs-bug RET}. 150 @kbd{M-x report-xemacs-bug RET}.
149 151
150 @menu 152 @menu
151 * Mailing Lists:: 153 * Mailing Lists::
152 * Beta Release Schedule:: 154 * Beta Release Schedule::
153 * Reporting Problems::
154 * Getting the Source::
155 @end menu 155 @end menu
156
156 157
157 @node Mailing Lists, Beta Release Schedule, Introduction, Introduction 158 @node Mailing Lists, Beta Release Schedule, Introduction, Introduction
158 @section Mailing Lists 159 @section Mailing Lists
159 160
160 @menu 161 @menu
165 * Managing your subscription via the Web:: 166 * Managing your subscription via the Web::
166 * Subscribing by e-mail:: 167 * Subscribing by e-mail::
167 * Unsubscribing by e-mail:: 168 * Unsubscribing by e-mail::
168 @end menu 169 @end menu
169 170
171
170 @node XEmacs Beta Mailing List, XEmacs Patches Mailing List, Mailing Lists, Mailing Lists 172 @node XEmacs Beta Mailing List, XEmacs Patches Mailing List, Mailing Lists, Mailing Lists
171 @subsection XEmacs Beta Mailing List 173 @subsection XEmacs Beta Mailing List
172 174
173 If you are not subscribed to the XEmacs beta list you should be. 175 If you are not subscribed to the XEmacs beta list you should be.
174 Currently all discussion of development issues, including bug reports 176 Currently all discussion of development issues, including bug reports
175 and coding discussion, takes place on the XEmacs Beta mailing list. 177 and coding discussion, takes place on the XEmacs Beta mailing list.
176 Only patches and administrative actions regarding patches are sent 178 Only patches and administrative actions regarding patches are sent
177 elsewhere (to the XEmacs Patches list). 179 elsewhere (to the XEmacs Patches list).
178 180
181
179 @node XEmacs Patches Mailing List, XEmacs Design Mailing List, XEmacs Beta Mailing List, Mailing Lists 182 @node XEmacs Patches Mailing List, XEmacs Design Mailing List, XEmacs Beta Mailing List, Mailing Lists
180 @subsection XEmacs Patches Mailing List 183 @subsection XEmacs Patches Mailing List
181 184
182 XEmacs Patches records proposed changes to XEmacs, and their 185 XEmacs Patches records proposed changes to XEmacs, and their
183 disposition. It is open subscription, and all patches that are 186 disposition. It is open subscription, and all patches that are
186 or in the archives. 189 or in the archives.
187 190
188 Besides patches, only actions by members of the XEmacs Review Board 191 Besides patches, only actions by members of the XEmacs Review Board
189 should be posted to this list. All discussion should be redirected to 192 should be posted to this list. All discussion should be redirected to
190 XEmacs Beta or XEmacs Design. 193 XEmacs Beta or XEmacs Design.
194
191 195
192 @node XEmacs Design Mailing List, List Administrivia, XEmacs Patches Mailing List, Mailing Lists 196 @node XEmacs Design Mailing List, List Administrivia, XEmacs Patches Mailing List, Mailing Lists
193 @subsection XEmacs Design Mailing List 197 @subsection XEmacs Design Mailing List
194 198
195 XEmacs Design is for design discussions such as adding major features 199 XEmacs Design is for design discussions such as adding major features
215 @uref{http://list-archive.xemacs.org/xemacs-LIST} 219 @uref{http://list-archive.xemacs.org/xemacs-LIST}
216 220
217 Note that the xemacs-LIST-admin address is used internally by the 221 Note that the xemacs-LIST-admin address is used internally by the
218 Mailman software; it is NOT a synonym for xemacs-LIST-request. 222 Mailman software; it is NOT a synonym for xemacs-LIST-request.
219 223
224
220 @node Managing your subscription via the Web, Subscribing by e-mail, List Administrivia, Mailing Lists 225 @node Managing your subscription via the Web, Subscribing by e-mail, List Administrivia, Mailing Lists
221 @subsection Managing your subscription via the Web 226 @subsection Managing your subscription via the Web
222 227
223 Subscription, unsubscription, and options (such as digests and 228 Subscription, unsubscription, and options (such as digests and
224 temporarily suspending delivery) can be accomplished via the web 229 temporarily suspending delivery) can be accomplished via the web
225 interface at @uref{http://www.xemacs.org/Lists/#xemacs-LIST}. 230 interface at @uref{http://www.xemacs.org/Lists/#xemacs-LIST}.
226 231
232
227 @node Subscribing by e-mail, Unsubscribing by e-mail, Managing your subscription via the Web, Mailing Lists 233 @node Subscribing by e-mail, Unsubscribing by e-mail, Managing your subscription via the Web, Mailing Lists
228 @subsection Subscribing by e-mail 234 @subsection Subscribing by e-mail
229 235
230 Send an email message to @uref{mailto:xemacs-LIST-request@@xemacs.org} with 236 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. 237 @samp{subscribe} (without the quotes) as the BODY of the message.
232 238
239
233 @node Unsubscribing by e-mail, , Subscribing by e-mail, Mailing Lists 240 @node Unsubscribing by e-mail, , Subscribing by e-mail, Mailing Lists
234 @subsection Unsubscribing by e-mail 241 @subsection Unsubscribing by e-mail
235 242
236 Send an email message to @uref{mailto:xemacs-LIST-request@@xemacs.org} with 243 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. 244 @samp{unsubscribe} (without the quotes) as the BODY of the message.
238 245
239 @node Beta Release Schedule, Reporting Problems, Mailing Lists, Introduction 246
247 @node Beta Release Schedule, , Mailing Lists, Introduction
240 @section Beta Release Schedule 248 @section Beta Release Schedule
241 249
242 We would like to achieve a weekly or fortnightly release cycle (you 250 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 251 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 252 perfect world that would indeed be the case. There are at least three
253 CVS (see @uref{http://www.xemacs.org/Develop/cvsaccess.html}). If you 261 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. 262 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. 263 it will make it more likely that we release betas more often.
256 264
257 265
258 @node Reporting Problems, Getting the Source, Beta Release Schedule, Introduction 266 @node Building Beta XEmacs, Packages, Introduction, Top
259 @section Reporting Problems 267 @chapter Building Beta XEmacs
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 268
312 @menu 269 @menu
270 * Getting the Source::
313 * Building an XEmacs from patches:: 271 * Building an XEmacs from patches::
314 * Building XEmacs from a full distribution:: 272 * Building XEmacs from a full distribution::
315 @end menu 273 @end menu
316 274
317 @node Building an XEmacs from patches, Building XEmacs from a full distribution, Compiling Beta XEmacs, Compiling Beta XEmacs 275
276 @node Getting the Source, Building an XEmacs from patches, Building Beta XEmacs, Building Beta XEmacs
277 @section Getting the Source
278
279 We provide the traditional tarballs and release-to-release patchkits for
280 each beta release. @xref{Beta Release Schedule}. These are available
281 at
282
283 @uref{ftp://ftp.xemacs.org/pub/xemacs/beta/}
284
285 In addition to the normal tar distribution, XEmacs source is now
286 available via CVS. Please see
287
288 @uref{http://www.xemacs.org/Develop/cvsaccess.html}
289
290 You can also browse the repository via ViewCVS
291
292 @uref{http://cvs.xemacs.org/}
293
294
295 @node Building an XEmacs from patches, Building XEmacs from a full distribution, Getting the Source, Building Beta XEmacs
318 @section Building an XEmacs from patches 296 @section Building an XEmacs from patches
319 297
320 All beta releases of XEmacs are included with patches from the previous 298 All beta releases of XEmacs provide patches from the previous version as
321 version in an attempt to keep bandwidth requirements down. Patches 299 an alternative to keep bandwidth requirements down. These patches are
322 should be applied with the GNU patch program in something like the 300 actually scripts generated by the @file{makepatch} program, and can be
323 following. Let's say you're upgrading XEmacs 21.5-beta9 to XEmacs 301 run if you have the @file{applypatch} program. Patches may also be
324 21.5-beta10 and you have a full unmodified XEmacs 21.5-beta9 source 302 applied with the GNU patch program in something like the following.
325 tree to work with. Change to the top level directory and issue the 303 Let's say you're upgrading XEmacs 21.5-beta9 to XEmacs 21.5-beta10 and
326 shell command: 304 you have a full unmodified XEmacs 21.5-beta9 source tree to work with.
305 Change to the top level directory and issue the shell command:
327 306
328 @example 307 @example
329 $ gunzip -c /tmp/xemacs-21.5.9-21.5.10.patch.gz | patch -p1 308 $ gunzip -c /tmp/xemacs-21.5.9-21.5.10.patch.gz | patch -p1
330 @end example 309 @end example
331 310
347 @end example 326 @end example
348 327
349 Redirect the output from make to those files because you'll use them 328 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} 329 later when you send off a build report with @kbd{M-x build-report RET}
351 330
352 @node Building XEmacs from a full distribution, , Building an XEmacs from patches, Compiling Beta XEmacs 331
332 @node Building XEmacs from a full distribution, , Building an XEmacs from patches, Building Beta XEmacs
353 @section Building XEmacs from a full distribution 333 @section Building XEmacs from a full distribution
354 334
355 @enumerate 335 @enumerate
356 @item 336 @item
357 Locate a convenient place where you have at least 100MB of free space 337 Locate a convenient place where you have at least 200MB of free space
358 and issue the command 338 (approximately 100MB for sources and compiled Lisp, and 100MB for
339 objects and other generated files) and issue the command
359 340
360 @example 341 @example
361 $ gunzip -c /tmp/xemacs-21.5.10.tar.gz | tar xvf - 342 $ gunzip -c /tmp/xemacs-21.5.10.tar.gz | tar xvf -
362 @end example 343 @end example
363 344
407 @example 388 @example
408 --with-compiler=gcc 389 --with-compiler=gcc
409 --with-xemacs-compiler=g++ 390 --with-xemacs-compiler=g++
410 @end example 391 @end example
411 392
412 This will compile XEmacs using g++, which will turn on a lot of additional 393 This will compile XEmacs using g++, which is generally much stricter
413 error-checking. 394 about type-checking than C compilers like gcc.
414 395
415 @item 396 @item
416 If your packages are not installed under /usr/local, you should add a 397 If your packages are not installed under /usr/local, you should add a
417 line like 398 line like
418 399
590 Any other unusual items you feel should be brought to the attention 571 Any other unusual items you feel should be brought to the attention
591 of the developers. 572 of the developers.
592 @end enumerate 573 @end enumerate
593 @end enumerate 574 @end enumerate
594 575
595 @node Packages, Improving XEmacs, Compiling Beta XEmacs, Top 576
577 @node Packages, Reporting Problems, Building Beta XEmacs, Top
596 @chapter Packages 578 @chapter Packages
597 579
598 [Note: these instructions have been partly updated, but not carefully 580 [Note: these instructions have been partly updated, but not carefully
599 reviewed in some time. Caveat tester.] 581 reviewed in some time. Caveat tester.]
600 582
611 * Binary package installation:: 593 * Binary package installation::
612 * Manual procedures for package management:: 594 * Manual procedures for package management::
613 * Building XEmacs and XEmacs packages from scratch:: 595 * Building XEmacs and XEmacs packages from scratch::
614 @end menu 596 @end menu
615 597
598
616 @node Binary package installation, Manual procedures for package management, Packages, Packages 599 @node Binary package installation, Manual procedures for package management, Packages, Packages
617 @section Binary package installation 600 @section Binary package installation
618 601
619 Prerequisite: XEmacs 21.0-b1. 602 Prerequisite: XEmacs 21.0-b1.
620 603
621 Binary packages are complete entities that can be untarred at the top 604 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 605 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} 606 in this directory, run the command @kbd{M-x package-admin-add-binary-package}
624 and fill in appropriate values to the prompts. 607 and fill in appropriate values to the prompts.
608
625 609
626 @node Manual procedures for package management, Building XEmacs and XEmacs packages from scratch, Binary package installation, Packages 610 @node Manual procedures for package management, Building XEmacs and XEmacs packages from scratch, Binary package installation, Packages
627 @section Manual procedures for package management 611 @section Manual procedures for package management
628 612
629 Prerequisite: XEmacs 21.0 613 Prerequisite: XEmacs 21.0
654 @end example 638 @end example
655 639
656 Of course, being a beta tester, you'd be aware that it is much easier 640 Of course, being a beta tester, you'd be aware that it is much easier
657 to manage your XEmacs packages with PUI. 641 to manage your XEmacs packages with PUI.
658 642
659 @node Building XEmacs and XEmacs packages from scratch, , Manual procedures for package management, Packages 643
644 @node Building XEmacs and XEmacs packages from scratch, , Manual procedures for package management, Packages
660 @section Building XEmacs and XEmacs packages from scratch 645 @section Building XEmacs and XEmacs packages from scratch
661 646
662 To build everything completely from scratch isn't hard, just time 647 To build everything completely from scratch isn't hard, just time
663 consuming. 648 consuming.
664 649
703 688
704 @example 689 @example
705 $ make install 690 $ make install
706 @end example 691 @end example
707 692
708 @node Improving XEmacs, Index, Packages, Top 693
694 @node Reporting Problems, Improving XEmacs, Packages, Top
695 @section Reporting Problems
696
697 The best way to get problems fixed in XEmacs is to submit good problem
698 reports, @kbd{M-x report-xemacs-bug RET} will help you do this (assuming
699 you have a usable XEmacs). Since this is beta software, problems are
700 certain to exist. Please read through all of part II of the XEmacs
701 FAQ for an overview of problem reporting.
702 @xref{Installation, Installation and Troubleshooting, , xemacs-faq}.
703 The most relevant parts are in section 2.4, General Troubleshooting.
704 @c #### Why doesn't this link work?
705 @c @ref{Q2.4.1, General Troubleshooting, , xemacs-faq}.
706 Other items which are most important are:
707
708 @enumerate
709 @item
710 Do not submit C stack backtraces without line numbers. Since it
711 is possible to compile optimized with debug information with GCC
712 it is never a good idea to compile XEmacs without the -g flag.
713 XEmacs runs on a variety of platforms, and often it is not
714 possible to recreate problems which afflict a specific platform.
715 The line numbers in the C stack backtrace help isolate where the
716 problem is actually occurring.
717
718 @item
719 Attempt to recreate the problem starting with an invocation of
720 XEmacs with @code{xemacs -no-autoloads}. Quite often, problems are
721 due to package interdependencies, and the like. An actual bug
722 in XEmacs should be reproducible in a default configuration
723 without loading any special packages (or the one or two specific
724 packages that cause the bug to appear). If you have trouble
725 getting anything to work at all with the above invocation, use
726 @code{xemacs -vanilla} instead. If you need to load your user init
727 file or the site file to get the problem to occur, then it has
728 something to do with them, and you should try to isolate the
729 issue in those files.
730
731 @item
732 A picture can be worth a thousand words. When reporting an
733 unusual display, it is generally best to capture the problem in a
734 screen dump and include that with the problem report. The easiest
735 way to get a screen dump is to use the xv program and its grab
736 function. Save the image as a GIF to keep bandwidth requirements
737 down without loss of information. MIME is the preferred method
738 for making the image attachments.
739 @end enumerate
740
741
742 @node Improving XEmacs, Index, Reporting Problems, Top
709 @chapter Improving XEmacs 743 @chapter Improving XEmacs
710 744
711 @menu 745 @menu
712 * Creating patches for submission:: 746 * Creating patches for submission::
713 * Large contributions:: 747 * Large contributions::
897 @uref{mailto:xemacs-beta@@xemacs.org} and the XEmacs Package Release 931 @uref{mailto:xemacs-beta@@xemacs.org} and the XEmacs Package Release
898 Engineer are the most likely sources of advice. See 932 Engineer are the most likely sources of advice. See
899 @uref{http://www.xemacs.org/Develop/jobs.html#package,jobs.html} for 933 @uref{http://www.xemacs.org/Develop/jobs.html#package,jobs.html} for
900 current information about package release engineers. 934 current information about package release engineers.
901 935
936
902 @node Syncing with GNU Emacs, , New packages, Large contributions 937 @node Syncing with GNU Emacs, , New packages, Large contributions
903 @subsection Syncing with GNU Emacs 938 @subsection Syncing with GNU Emacs
904 939
905 Syncing with GNU Emacs is an important activity. Although each 940 Syncing with GNU Emacs is an important activity. Although each
906 version has its advantages and areas of concentration, it is very 941 version has its advantages and areas of concentration, it is very
955 990
956 @c Print the tables of contents 991 @c Print the tables of contents
957 @contents 992 @contents
958 @c That's all 993 @c That's all
959 994
995
960 @node Index, , Improving XEmacs, Top 996 @node Index, , Improving XEmacs, Top
961 @unnumbered Index 997 @unnumbered Index
962 998
963 @printindex cp 999 @printindex cp
964 1000