comparison etc/BETA @ 203:850242ba4a81 r20-3b28

Import from CVS: tag r20-3b28
author cvs
date Mon, 13 Aug 2007 10:02:21 +0200
parents acd284d43ca1
children 41ff10fd062f
comparison
equal deleted inserted replaced
202:61eefc8fc970 203:850242ba4a81
29 29
30 The XEmacs beta list is managed by the SmartList mailing list package, 30 The XEmacs beta list is managed by the SmartList mailing list package,
31 and the usual SmartList commands work. Do not send mailing list 31 and the usual SmartList commands work. Do not send mailing list
32 requests to the main address (xemacs-beta@xemacs.org), always send 32 requests to the main address (xemacs-beta@xemacs.org), always send
33 them to xemacs-beta-request@xemacs.org. If you have problems with the 33 them to xemacs-beta-request@xemacs.org. If you have problems with the
34 list itself, they should be brought to the attention of the Mailing 34 list itself, they should be brought to the attention of the XEmacs
35 List manager Chuck Thompson <cthomp@xemacs.org>. 35 Mailing List manager Steve Baur <steve@xemacs.org>.
36 36
37 37
38 ** Beta Release Schedule 38 ** Beta Release Schedule
39 ======================== 39 ========================
40 40
43 betas the release time is generally in the vicinity of 2PM to 5PM US 43 betas the release time is generally in the vicinity of 2PM to 5PM US
44 Pacific Time (Universal Time minus 8 hours). For weekday betas, the 44 Pacific Time (Universal Time minus 8 hours). For weekday betas, the
45 release time is generally in the vicinity of 8PM to Midnight US 45 release time is generally in the vicinity of 8PM to Midnight US
46 Pacific Time on the listed day. 46 Pacific Time on the listed day.
47 47
48 While 19.15 and 20.x are in parallel development, a simultaneous
49 release day implies a release of 20.x first, followed a few hours
50 later by 19.15.
51
52 Betas are nominally a week apart, scheduled on every Saturday. 48 Betas are nominally a week apart, scheduled on every Saturday.
53 Midweek releases are made when a serious enough problem warrants it. 49 Midweek releases are made when a serious enough problem warrants it.
54 50
55 51
56 ** Reporting Problems 52 ** Reporting Problems
57 ===================== 53 =====================
58 54
59 The best way to get problems fixed in XEmacs is to submit good problem 55 The best way to get problems fixed in XEmacs is to submit good problem
60 reports. Since this is beta software problems are certain to exist. 56 reports. Since this is beta software, problems are certain to exist.
61 Please read through all of part II of the XEmacs FAQ for an overview 57 Please read through all of part II of the XEmacs FAQ for an overview
62 of problem reporting. Other items which are most important are: 58 of problem reporting. Other items which are most important are:
63 59
64 1. Do not submit C stack backtraces without line numbers. Since it 60 1. Do not submit C stack backtraces without line numbers. Since it
65 is possible to compile optimized with debug information with GCC 61 is possible to compile optimized with debug information with GCC
68 possible to recreate problems which afflict a specific platform. 64 possible to recreate problems which afflict a specific platform.
69 The line numbers in the C stack backtrace help isolate where the 65 The line numbers in the C stack backtrace help isolate where the
70 problem is actually occurring. 66 problem is actually occurring.
71 67
72 2. Attempt to recreate the problem starting with an invocation of 68 2. Attempt to recreate the problem starting with an invocation of
73 XEmacs with `xemacs -q -no-site-file'. Quite often problems are 69 XEmacs with `xemacs -q -no-site-file'. Quite often, problems are
74 due to package interdependencies, and the like. An actual bug in 70 due to package interdependencies, and the like. An actual bug in
75 XEmacs should be reproducible in a default configuration without 71 XEmacs should be reproducible in a default configuration without
76 loading any special packages (or the one or two specific packages 72 loading any special packages (or the one or two specific packages
77 that cause the bug to appear). 73 that cause the bug to appear).
78 74
98 source tree to work with. Cd to the top level directory and issue the 94 source tree to work with. Cd to the top level directory and issue the
99 shell command: 95 shell command:
100 96
101 $ gunzip -c /tmp/xemacs-20.4-b10-20.4-b11.patch.gz | patch -p1 97 $ gunzip -c /tmp/xemacs-20.4-b10-20.4-b11.patch.gz | patch -p1
102 98
103 After patching check to see that no patches were missed by doing 99 After patching, check to see that no patches were missed by doing
104 $ find . -name \*.rej -print 100 $ find . -name \*.rej -print
105 101
106 Any rejections should be treated as serious problems to be resolved 102 Any rejections should be treated as serious problems to be resolved
107 before starting compilation. 103 before building XEmacs.
108 104
109 After seeing that there were no rejections, issue the commands 105 After seeing that there were no rejections, issue the commands
110 106
111 $ ./config.status --recheck 107 $ ./config.status --recheck
112 $ make beta 108 $ make beta
113 109
114 and go play minesweep for awhile on an older XEmacs while the binary 110 and go play minesweep for a while on an older XEmacs while the binary
115 is rebuilt. 111 is rebuilt.
116 112
117 ** Building an XEmacs from a full distribution 113 ** Building XEmacs from a full distribution
118 ============================================== 114 ==============================================
119 115
120 Locate a convenient place where you have at least 100MB of free space 116 Locate a convenient place where you have at least 100MB of free space
121 and issue the command 117 and issue the command
122 118
123 $ gunzip -c /tmp/xemacs-20.4-b11.tar.gz | tar xvf - 119 $ gunzip -c /tmp/xemacs-20.4-b11.tar.gz | tar xvf -
124 120
125 (or the simpler `tar zxvf /tmp/xemacs-20.4-b11.tar.gz' if you use GNU 121 (or simply `tar zxvf /tmp/xemacs-20.4-b11.tar.gz' if you use GNU tar).
126 tar).
127 122
128 cd to the top level directory and issue an appropriate configure 123 cd to the top level directory and issue an appropriate configure
129 command. The maintainer uses the following at the time of this 124 command. One maintainer uses the following at the time of this
130 writing: 125 writing:
131 126
132 ./configure --with-offix --with-mule=yes --with-dialogs=athena3d \ 127 ./configure \
133 --cflags="-m486 -g -O4 -fno-strength-reduce -malign-loops=2 \ 128 --cflags="-m486 -g -O4 -fno-strength-reduce -malign-loops=2 \
134 -malign-jumps=2 -malign-functions=2" --with-sound=no \ 129 -malign-jumps=2 -malign-functions=2" \
135 --with-xface=yes --error-checking=all --debug=yes \ 130 --with-sound=no --with=offix \
136 --with-scrollbars=athena3d \ 131 --error-checking=all --debug=yes \
137 --with-canna=yes --with-wnn=yes --wnn-includes=/usr/X11R6/include/wnn 132 --with-scrollbars=athena3d --with-dialogs=athena3d \
138 133 --with-mule --with-canna --with-wnn
139 Save the output from configure that looks something like: 134
135 Part of the configure output is a summary that looks something like:
136
140 Configured for `i586-unknown-linux2.0.28'. 137 Configured for `i586-unknown-linux2.0.28'.
141 138
142 Where should the build process find the source code? /usr/src/xemacs-20.0 139 Where should the build process find the source code? /usr/src/xemacs-20.4
143 What installation prefix should install use? /usr/local 140 What installation prefix should install use? /usr/local
141 Where should XEmacs look for packages? ~/.xemacs:/usr/local/lib/xemacs/packages
144 What operating system and machine description files should XEmacs use? 142 What operating system and machine description files should XEmacs use?
145 `s/linux.h' and `m/intel386.h' 143 `s/linux.h' and `m/intel386.h'
146 What compiler should XEmacs be built with? gcc -m486 -g -O4 -fno-strength-reduce -malign-loops=2 -malign-jumps=2 -malign-functions=2 144 What compiler should XEmacs be built with? gcc -m486 -g -O4 -fno-strength-reduce -malign-loops=2 -malign-jumps=2 -malign-functions=2
147 Should XEmacs use the GNU version of malloc? yes 145 Should XEmacs use the GNU version of malloc? yes
148 Should XEmacs use the relocating allocator for buffers? yes 146 Should XEmacs use the relocating allocator for buffers? yes
149 What window system should XEmacs use? x11 147 What window system should XEmacs use? x11
150 Where do we find X Windows header files? /usr/X11R6/include 148 Where do we find X Windows header files? /usr/X11R6/include
151 Where do we find X Windows libraries? /usr/X11R6/lib 149 Where do we find X Windows libraries? /usr/X11R6/lib
152 Compiling in support for XAUTH. 150 Compiling in support for XAUTH.
153 Compiling in support for XPM.
154 Compiling in support for X-Face headers.
155 Compiling in support for GIF image conversion. 151 Compiling in support for GIF image conversion.
152 Compiling in support for XPM images.
153 Compiling in support for X-Face message headers.
156 Compiling in support for JPEG image conversion. 154 Compiling in support for JPEG image conversion.
157 Compiling in support for PNG image conversion. 155 Compiling in support for PNG image conversion.
156 Compiling in support for TIFF image conversion (not implemented).
158 Compiling in support for Berkeley DB. 157 Compiling in support for Berkeley DB.
159 Compiling in support for GNU DBM. 158 Compiling in support for GNU DBM.
160 Compiling in Mule (multi-lingual) support. 159 Compiling in Mule (multi-lingual) support.
160 Compiling in support for the WNN input method on Mule.
161 Using WNN version 6.
161 Compiling in support for OffiX. 162 Compiling in support for OffiX.
162 Using the Lucid menubar. 163 Using the Lucid menubar.
163 Using the Athena-3d scrollbar. 164 Using the Athena-3d scrollbar.
164 Using the Athena-3d dialog boxes. 165 Using the Athena-3d dialog boxes.
165 166
179 3. The options given to configure 180 3. The options given to configure
180 181
181 4. The configuration report illustrated above 182 4. The configuration report illustrated above
182 183
183 For convenience all of the above items are placed in a file called 184 For convenience all of the above items are placed in a file called
184 `Installation' in the top level source directory. 185 `Installation' in the top level build directory.
185 186
186 5. Any other unusual items you feel should be brought to the attention 187 5. Any other unusual items you feel should be brought to the attention
187 of the developers. 188 of the developers.
188 189
189 ** Creating patches for submission 190 ** Creating patches for submission
190 ================================== 191 ==================================
191 192
192 When making patches you should use the `-c', or preferably if your 193 When making patches you should use the `-c' option, or preferably, if
193 diff supports it, `-u'. Using ordinary diffs like this are 194 your diff supports it, `-u'. Using ordinary (context-free) diffs are
194 notoriously prone to error (and this one won't in fact work, since 195 notoriously prone to error, since line numbers tend to change when
195 I've already applied a patch to this file so the line numbers probably 196 others make changes to the same source file.
196 don't match up any more).
197 197
198 $ diff -u old-file.c new-file.c 198 $ diff -u old-file.c new-file.c
199 199
200 -or- 200 -or-
201 201
202 $ diff -c old-file.c new-file.c 202 $ diff -c old-file.c new-file.c
203 203
204 Also, it is helpful for me if you create the patch in the top level of 204 Also, it is helpful if you create the patch in the top level of the
205 the XEmacs source directory: 205 XEmacs source directory:
206 206
207 $ diff -u lwlib/xlwmenu.c~ lwlib/xlwmenu.c 207 $ cp -p lwlib/xlwmenu.c lwlib/xlwmenu.c.orig
208 208 hack, hack, hack....
209 I prefer patches to be accompanied by an update (either a raw entry or 209 $ diff -u lwlib/xlwmenu.c.orig lwlib/xlwmenu.c
210 a patch) to the appropriate ChangeLog file, but it is not required. 210
211 It is preferrable for patches to be accompanied by an update (raw
212 entry preferred) to the appropriate ChangeLog file.
211 213
212 Also note that if you cut & paste from an xterm to an XEmacs mail buffer 214 Also note that if you cut & paste from an xterm to an XEmacs mail buffer
213 you will probably lose due to tab expansion. The best thing to do is to 215 you will probably lose due to tab expansion. The best thing to do is
216 to use an XEmacs shell buffer to run the diff commands, or ...
214 M-x cd to the appropriate directory, and issue the command `C-u M-!' from 217 M-x cd to the appropriate directory, and issue the command `C-u M-!' from
215 within XEmacs. 218 within XEmacs.
216 219
217 * XEmacs 20.3 packages 220 * XEmacs 20.3 packages
218 221
220 to dump time when building. 223 to dump time when building.
221 224
222 Packages are searched by default under /usr/local/lib/xemacs/packages/. 225 Packages are searched by default under /usr/local/lib/xemacs/packages/.
223 The summary message in configure will tell you where XEmacs is looking 226 The summary message in configure will tell you where XEmacs is looking
224 for them. The packages hierarchy differs from site-lisp in that you 227 for them. The packages hierarchy differs from site-lisp in that you
225 do not have install XEmacs to use it, indeed, the package path is 228 do not have to install XEmacs to use it. Indeed, the package path is
226 searched prior to dump time so that installed packages have the same 229 searched prior to dump time so that installed packages have the same
227 status as lisp distributed in the xemacs base tarball. 230 status as lisp distributed in the xemacs core tarball.
228 231
229 The structure of each directory in the package search path should look 232 The structure of each directory in the package search path should look
230 like the base installed directory (ie. have etc/, info/, and lisp/,). 233 like the base installed directory (ie. have etc/, info/, and lisp/,).
231 Lisp is searched recursively. It and all subdirectories are added to 234 Lisp is searched recursively. It and all subdirectories are added to
232 the `load-path'. Each etc directory is added to `data-directory-list', 235 the `load-path'. Each etc directory is added to `data-directory-list',
253 AUCTeX and Gnus have package tarballs in 256 AUCTeX and Gnus have package tarballs in
254 ftp://ftp.xemacs.org/pub/beta/packages-20.3/ 257 ftp://ftp.xemacs.org/pub/beta/packages-20.3/
255 that you can simply untar in a package directory to install. 258 that you can simply untar in a package directory to install.
256 259
257 Karl Hegbloom has a set of packages in 260 Karl Hegbloom has a set of packages in
258 [I lost the reference] 261 [sorry - reference has been lost]
259 that work the same way. 262 that work the same way.
260 263
261 This is not how package installation will work in released 20.3. 264 ** Packages directory on the FTP Site
265 =====================================
266
267 The packages directory
268 ftp://ftp.xemacs.org/pub/xemacs/beta/packages-20.3/
269
270 is divided into subdirectory by the major type of package.
271
272 drwxr-xr-x 2 beta-f beta-f 1024 Oct 10 00:43 binary-packages
273 drwxr-xr-x 2 beta-f beta-f 512 Oct 10 00:44 package-sources
274 drwxr-xr-x 2 beta-f beta-f 512 Oct 9 23:08 single-file-packages
275 drwxr-xr-x 2 beta-f beta-f 512 Oct 10 00:44 utils
276
277 ** Support Utilities (utils)
278 ============================
279
280 The utils directory contains tools to deal with current Lisp sources that
281 have not had yet gotten XEmacs package integration. The script `xpackage.sh'
282 is used with Quassia Gnus. Edit the appropriate variables at the top of
283 the script to reflect the local configuration and run it in the top level
284 directory of a Quassia Gnus source tree to install an update to Quassia Gnus.
285
286 ** Source Installable Packages (package-sources)
287 ================================================
288
289 This directory contains tarballs of Lisp packages that contain full support
290 for installing as an XEmacs package. To install them, one should untar
291 them to someplace convenient (like /var/tmp), and issue the appropriate make
292 command to install.
293
294 ** Binary package installation (binary-packages)
295 ================================================
296
297 Prerequisite: XEmacs 20.3-beta28.
298
299 Binary packages are complete entities that can be untarred at the top
300 level of an XEmacs package hierarchy and work at runtime. To install files
301 in this directory, run the command `M-x package-admin-add-binary-package'
302 and fill in appropriate values to the prompts.
303
304 ** Single file package installation
305 ===================================
306
307 Prerequisite: XEmacs 20.3-beta28.
308
309 These are single file, self-contained lisp packages that don't need a
310 separate directory. To install something from this directory, run
311 the command `M-x package-admin-add-single-file-package' and fill in the
312 prompts.