annotate 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
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
134
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
1 -*- mode:outline; minor-mode:outl-mouse -*-
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
2
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
3 * Introduction
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
4 ==============
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
5
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
6 You are running an experimental version of XEmacs. Please do not
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
7 report problems with Beta XEmacs to comp.emacs.xemacs. Report them to
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
8 xemacs-beta@xemacs.org.
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
9
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
10 ** XEmacs Beta Mailing List
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
11 ===========================
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
12
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
13 *** Subscribing
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
14 ---------------
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
15
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
16 If you are not subscribed to the XEmacs beta list you should be. Send
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
17 an email message with a subject of `subscribe' (without the quotes) to
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
18 xemacs-beta-request@xemacs.org and follow the directions. You do not
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
19 have to fill out the survey if you don't want to.
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
20
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
21 *** Unsubscribing
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
22 -----------------
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
23
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
24 To unsubscribe from the list send an email message with a subject of
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
25 `unsubscribe' (without the quotes) to xemacs-beta-request@xemacs.org.
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
26
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
27 *** Administrivia
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
28 -----------------
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
29
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
30 The XEmacs beta list is managed by the SmartList mailing list package,
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
31 and the usual SmartList commands work. Do not send mailing list
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
32 requests to the main address (xemacs-beta@xemacs.org), always send
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
33 them to xemacs-beta-request@xemacs.org. If you have problems with the
203
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
34 list itself, they should be brought to the attention of the XEmacs
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
35 Mailing List manager Steve Baur <steve@xemacs.org>.
134
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
36
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
37
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
38 ** Beta Release Schedule
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
39 ========================
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
40
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
41 The URL ftp://ftp.xemacs.org/pub/beta/README always contains the best
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
42 estimate of when the next beta XEmacs will be released. For weekend
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
43 betas the release time is generally in the vicinity of 2PM to 5PM US
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
44 Pacific Time (Universal Time minus 8 hours). For weekday betas, the
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
45 release time is generally in the vicinity of 8PM to Midnight US
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
46 Pacific Time on the listed day.
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
47
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
48 Betas are nominally a week apart, scheduled on every Saturday.
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
49 Midweek releases are made when a serious enough problem warrants it.
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
50
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
51
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
52 ** Reporting Problems
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
53 =====================
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
54
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
55 The best way to get problems fixed in XEmacs is to submit good problem
203
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
56 reports. Since this is beta software, problems are certain to exist.
134
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
57 Please read through all of part II of the XEmacs FAQ for an overview
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
58 of problem reporting. Other items which are most important are:
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
59
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
60 1. Do not submit C stack backtraces without line numbers. Since it
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
61 is possible to compile optimized with debug information with GCC
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
62 it is never a good idea to compile XEmacs without the -g flag.
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
63 XEmacs runs on a variety of platforms, and often it is not
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
64 possible to recreate problems which afflict a specific platform.
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
65 The line numbers in the C stack backtrace help isolate where the
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
66 problem is actually occurring.
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
67
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
68 2. Attempt to recreate the problem starting with an invocation of
203
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
69 XEmacs with `xemacs -q -no-site-file'. Quite often, problems are
134
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
70 due to package interdependencies, and the like. An actual bug in
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
71 XEmacs should be reproducible in a default configuration without
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
72 loading any special packages (or the one or two specific packages
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
73 that cause the bug to appear).
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
74
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
75 3. A picture can be worth a thousand words. When reporting an
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
76 unusual display, it is generally best to capture the problem in a
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
77 screen dump and include that with the problem report. The easiest
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
78 way to get a screen dump is to use the xv program and its grab
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
79 function. Save the image as a GIF to keep bandwidth requirements
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
80 down without loss of information. MIME is the preferred method
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
81 for making the image attachments.
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
82
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
83 * Compiling Beta XEmacs
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
84 =======================
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
85
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
86 ** Building an XEmacs from patches
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
87 ==================================
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
88
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
89 All beta releases of XEmacs are included with patches from the
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
90 previous version in an attempt to keep bandwidth requirements down.
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
91 Patches should be applied with the GNU patch program in something like
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
92 the following. Let's say you're upgrading XEmacs 20.4-beta10 to
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
93 XEmacs 20.4-beta11 and you have a full unmodified XEmacs 20.4-beta10
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
94 source tree to work with. Cd to the top level directory and issue the
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
95 shell command:
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
96
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
97 $ gunzip -c /tmp/xemacs-20.4-b10-20.4-b11.patch.gz | patch -p1
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
98
203
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
99 After patching, check to see that no patches were missed by doing
134
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
100 $ find . -name \*.rej -print
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
101
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
102 Any rejections should be treated as serious problems to be resolved
203
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
103 before building XEmacs.
134
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
104
179
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents: 136
diff changeset
105 After seeing that there were no rejections, issue the commands
134
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
106
179
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents: 136
diff changeset
107 $ ./config.status --recheck
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents: 136
diff changeset
108 $ make beta
134
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
109
203
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
110 and go play minesweep for a while on an older XEmacs while the binary
134
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
111 is rebuilt.
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
112
203
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
113 ** Building XEmacs from a full distribution
134
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
114 ==============================================
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
115
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
116 Locate a convenient place where you have at least 100MB of free space
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
117 and issue the command
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
118
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
119 $ gunzip -c /tmp/xemacs-20.4-b11.tar.gz | tar xvf -
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
120
203
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
121 (or simply `tar zxvf /tmp/xemacs-20.4-b11.tar.gz' if you use GNU tar).
134
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
122
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
123 cd to the top level directory and issue an appropriate configure
203
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
124 command. One maintainer uses the following at the time of this
134
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
125 writing:
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
126
203
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
127 ./configure \
134
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
128 --cflags="-m486 -g -O4 -fno-strength-reduce -malign-loops=2 \
203
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
129 -malign-jumps=2 -malign-functions=2" \
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
130 --with-sound=no --with=offix \
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
131 --error-checking=all --debug=yes \
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
132 --with-scrollbars=athena3d --with-dialogs=athena3d \
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
133 --with-mule --with-canna --with-wnn
134
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
134
203
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
135 Part of the configure output is a summary that looks something like:
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
136
134
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
137 Configured for `i586-unknown-linux2.0.28'.
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
138
203
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
139 Where should the build process find the source code? /usr/src/xemacs-20.4
134
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
140 What installation prefix should install use? /usr/local
203
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
141 Where should XEmacs look for packages? ~/.xemacs:/usr/local/lib/xemacs/packages
134
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
142 What operating system and machine description files should XEmacs use?
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
143 `s/linux.h' and `m/intel386.h'
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
144 What compiler should XEmacs be built with? gcc -m486 -g -O4 -fno-strength-reduce -malign-loops=2 -malign-jumps=2 -malign-functions=2
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
145 Should XEmacs use the GNU version of malloc? yes
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
146 Should XEmacs use the relocating allocator for buffers? yes
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
147 What window system should XEmacs use? x11
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
148 Where do we find X Windows header files? /usr/X11R6/include
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
149 Where do we find X Windows libraries? /usr/X11R6/lib
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
150 Compiling in support for XAUTH.
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
151 Compiling in support for GIF image conversion.
203
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
152 Compiling in support for XPM images.
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
153 Compiling in support for X-Face message headers.
134
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
154 Compiling in support for JPEG image conversion.
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
155 Compiling in support for PNG image conversion.
203
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
156 Compiling in support for TIFF image conversion (not implemented).
134
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
157 Compiling in support for Berkeley DB.
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
158 Compiling in support for GNU DBM.
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
159 Compiling in Mule (multi-lingual) support.
203
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
160 Compiling in support for the WNN input method on Mule.
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
161 Using WNN version 6.
134
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
162 Compiling in support for OffiX.
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
163 Using the Lucid menubar.
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
164 Using the Athena-3d scrollbar.
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
165 Using the Athena-3d dialog boxes.
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
166
197
acd284d43ca1 Import from CVS: tag r20-3b25
cvs
parents: 195
diff changeset
167 Then type `make; make finder' and you should have a working XEmacs.
134
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
168
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
169 After you have verified that you have a functional editor, fire up
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
170 your favorite mail program and send a build report to
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
171 xemacs-beta@xemacs.org. The build report should include
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
172
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
173 1. Your hardware configuration (OS version, etc.)
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
174
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
175 2. Version numbers of software in use (X11 version, system library
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
176 versions if appropriate, graphics library versions if appropriate).
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
177 If you're on a system like Linux, include all the version numbers
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
178 you can because chances are it makes a difference.
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
179
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
180 3. The options given to configure
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
181
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
182 4. The configuration report illustrated above
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
183
197
acd284d43ca1 Import from CVS: tag r20-3b25
cvs
parents: 195
diff changeset
184 For convenience all of the above items are placed in a file called
203
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
185 `Installation' in the top level build directory.
197
acd284d43ca1 Import from CVS: tag r20-3b25
cvs
parents: 195
diff changeset
186
134
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
187 5. Any other unusual items you feel should be brought to the attention
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents:
diff changeset
188 of the developers.
136
b980b6286996 Import from CVS: tag r20-2b2
cvs
parents: 134
diff changeset
189
b980b6286996 Import from CVS: tag r20-2b2
cvs
parents: 134
diff changeset
190 ** Creating patches for submission
b980b6286996 Import from CVS: tag r20-2b2
cvs
parents: 134
diff changeset
191 ==================================
b980b6286996 Import from CVS: tag r20-2b2
cvs
parents: 134
diff changeset
192
203
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
193 When making patches you should use the `-c' option, or preferably, if
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
194 your diff supports it, `-u'. Using ordinary (context-free) diffs are
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
195 notoriously prone to error, since line numbers tend to change when
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
196 others make changes to the same source file.
136
b980b6286996 Import from CVS: tag r20-2b2
cvs
parents: 134
diff changeset
197
b980b6286996 Import from CVS: tag r20-2b2
cvs
parents: 134
diff changeset
198 $ diff -u old-file.c new-file.c
b980b6286996 Import from CVS: tag r20-2b2
cvs
parents: 134
diff changeset
199
b980b6286996 Import from CVS: tag r20-2b2
cvs
parents: 134
diff changeset
200 -or-
b980b6286996 Import from CVS: tag r20-2b2
cvs
parents: 134
diff changeset
201
b980b6286996 Import from CVS: tag r20-2b2
cvs
parents: 134
diff changeset
202 $ diff -c old-file.c new-file.c
b980b6286996 Import from CVS: tag r20-2b2
cvs
parents: 134
diff changeset
203
203
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
204 Also, it is helpful if you create the patch in the top level of the
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
205 XEmacs source directory:
136
b980b6286996 Import from CVS: tag r20-2b2
cvs
parents: 134
diff changeset
206
203
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
207 $ cp -p lwlib/xlwmenu.c lwlib/xlwmenu.c.orig
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
208 hack, hack, hack....
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
209 $ diff -u lwlib/xlwmenu.c.orig lwlib/xlwmenu.c
136
b980b6286996 Import from CVS: tag r20-2b2
cvs
parents: 134
diff changeset
210
203
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
211 It is preferrable for patches to be accompanied by an update (raw
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
212 entry preferred) to the appropriate ChangeLog file.
136
b980b6286996 Import from CVS: tag r20-2b2
cvs
parents: 134
diff changeset
213
b980b6286996 Import from CVS: tag r20-2b2
cvs
parents: 134
diff changeset
214 Also note that if you cut & paste from an xterm to an XEmacs mail buffer
203
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
215 you will probably lose due to tab expansion. The best thing to do is
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
216 to use an XEmacs shell buffer to run the diff commands, or ...
136
b980b6286996 Import from CVS: tag r20-2b2
cvs
parents: 134
diff changeset
217 M-x cd to the appropriate directory, and issue the command `C-u M-!' from
b980b6286996 Import from CVS: tag r20-2b2
cvs
parents: 134
diff changeset
218 within XEmacs.
195
a2f645c6b9f8 Import from CVS: tag r20-3b24
cvs
parents: 179
diff changeset
219
a2f645c6b9f8 Import from CVS: tag r20-3b24
cvs
parents: 179
diff changeset
220 * XEmacs 20.3 packages
a2f645c6b9f8 Import from CVS: tag r20-3b24
cvs
parents: 179
diff changeset
221
a2f645c6b9f8 Import from CVS: tag r20-3b24
cvs
parents: 179
diff changeset
222 XEmacs 20.3 has added the concept of installable packages searched prior
a2f645c6b9f8 Import from CVS: tag r20-3b24
cvs
parents: 179
diff changeset
223 to dump time when building.
a2f645c6b9f8 Import from CVS: tag r20-3b24
cvs
parents: 179
diff changeset
224
a2f645c6b9f8 Import from CVS: tag r20-3b24
cvs
parents: 179
diff changeset
225 Packages are searched by default under /usr/local/lib/xemacs/packages/.
a2f645c6b9f8 Import from CVS: tag r20-3b24
cvs
parents: 179
diff changeset
226 The summary message in configure will tell you where XEmacs is looking
a2f645c6b9f8 Import from CVS: tag r20-3b24
cvs
parents: 179
diff changeset
227 for them. The packages hierarchy differs from site-lisp in that you
203
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
228 do not have to install XEmacs to use it. Indeed, the package path is
195
a2f645c6b9f8 Import from CVS: tag r20-3b24
cvs
parents: 179
diff changeset
229 searched prior to dump time so that installed packages have the same
203
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
230 status as lisp distributed in the xemacs core tarball.
195
a2f645c6b9f8 Import from CVS: tag r20-3b24
cvs
parents: 179
diff changeset
231
a2f645c6b9f8 Import from CVS: tag r20-3b24
cvs
parents: 179
diff changeset
232 The structure of each directory in the package search path should look
a2f645c6b9f8 Import from CVS: tag r20-3b24
cvs
parents: 179
diff changeset
233 like the base installed directory (ie. have etc/, info/, and lisp/,).
a2f645c6b9f8 Import from CVS: tag r20-3b24
cvs
parents: 179
diff changeset
234 Lisp is searched recursively. It and all subdirectories are added to
a2f645c6b9f8 Import from CVS: tag r20-3b24
cvs
parents: 179
diff changeset
235 the `load-path'. Each etc directory is added to `data-directory-list',
a2f645c6b9f8 Import from CVS: tag r20-3b24
cvs
parents: 179
diff changeset
236 and each info directory is added to `Info-default-directory-list'.
a2f645c6b9f8 Import from CVS: tag r20-3b24
cvs
parents: 179
diff changeset
237
a2f645c6b9f8 Import from CVS: tag r20-3b24
cvs
parents: 179
diff changeset
238 A `find . -type d -print' in my top-level package directory reveals:
a2f645c6b9f8 Import from CVS: tag r20-3b24
cvs
parents: 179
diff changeset
239 ./etc
a2f645c6b9f8 Import from CVS: tag r20-3b24
cvs
parents: 179
diff changeset
240 ./etc/auctex
a2f645c6b9f8 Import from CVS: tag r20-3b24
cvs
parents: 179
diff changeset
241 ./etc/auctex/style
a2f645c6b9f8 Import from CVS: tag r20-3b24
cvs
parents: 179
diff changeset
242 ./etc/gnus
a2f645c6b9f8 Import from CVS: tag r20-3b24
cvs
parents: 179
diff changeset
243 ./etc/skk
a2f645c6b9f8 Import from CVS: tag r20-3b24
cvs
parents: 179
diff changeset
244 ./etc/gnusrefcard
a2f645c6b9f8 Import from CVS: tag r20-3b24
cvs
parents: 179
diff changeset
245 ./etc/smilies
a2f645c6b9f8 Import from CVS: tag r20-3b24
cvs
parents: 179
diff changeset
246 ./etc/message
a2f645c6b9f8 Import from CVS: tag r20-3b24
cvs
parents: 179
diff changeset
247 ./info
a2f645c6b9f8 Import from CVS: tag r20-3b24
cvs
parents: 179
diff changeset
248 ./lisp
a2f645c6b9f8 Import from CVS: tag r20-3b24
cvs
parents: 179
diff changeset
249 ./lisp/gnus
a2f645c6b9f8 Import from CVS: tag r20-3b24
cvs
parents: 179
diff changeset
250 ./lisp/auctex
a2f645c6b9f8 Import from CVS: tag r20-3b24
cvs
parents: 179
diff changeset
251 ./lisp/auctex/man
a2f645c6b9f8 Import from CVS: tag r20-3b24
cvs
parents: 179
diff changeset
252 ./lisp/footnote
a2f645c6b9f8 Import from CVS: tag r20-3b24
cvs
parents: 179
diff changeset
253 ./lisp/skk
a2f645c6b9f8 Import from CVS: tag r20-3b24
cvs
parents: 179
diff changeset
254
a2f645c6b9f8 Import from CVS: tag r20-3b24
cvs
parents: 179
diff changeset
255
a2f645c6b9f8 Import from CVS: tag r20-3b24
cvs
parents: 179
diff changeset
256 AUCTeX and Gnus have package tarballs in
a2f645c6b9f8 Import from CVS: tag r20-3b24
cvs
parents: 179
diff changeset
257 ftp://ftp.xemacs.org/pub/beta/packages-20.3/
a2f645c6b9f8 Import from CVS: tag r20-3b24
cvs
parents: 179
diff changeset
258 that you can simply untar in a package directory to install.
a2f645c6b9f8 Import from CVS: tag r20-3b24
cvs
parents: 179
diff changeset
259
a2f645c6b9f8 Import from CVS: tag r20-3b24
cvs
parents: 179
diff changeset
260 Karl Hegbloom has a set of packages in
203
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
261 [sorry - reference has been lost]
195
a2f645c6b9f8 Import from CVS: tag r20-3b24
cvs
parents: 179
diff changeset
262 that work the same way.
a2f645c6b9f8 Import from CVS: tag r20-3b24
cvs
parents: 179
diff changeset
263
203
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
264 ** Packages directory on the FTP Site
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
265 =====================================
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
266
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
267 The packages directory
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
268 ftp://ftp.xemacs.org/pub/xemacs/beta/packages-20.3/
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
269
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
270 is divided into subdirectory by the major type of package.
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
271
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
272 drwxr-xr-x 2 beta-f beta-f 1024 Oct 10 00:43 binary-packages
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
273 drwxr-xr-x 2 beta-f beta-f 512 Oct 10 00:44 package-sources
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
274 drwxr-xr-x 2 beta-f beta-f 512 Oct 9 23:08 single-file-packages
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
275 drwxr-xr-x 2 beta-f beta-f 512 Oct 10 00:44 utils
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
276
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
277 ** Support Utilities (utils)
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
278 ============================
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
279
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
280 The utils directory contains tools to deal with current Lisp sources that
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
281 have not had yet gotten XEmacs package integration. The script `xpackage.sh'
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
282 is used with Quassia Gnus. Edit the appropriate variables at the top of
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
283 the script to reflect the local configuration and run it in the top level
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
284 directory of a Quassia Gnus source tree to install an update to Quassia Gnus.
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
285
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
286 ** Source Installable Packages (package-sources)
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
287 ================================================
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
288
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
289 This directory contains tarballs of Lisp packages that contain full support
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
290 for installing as an XEmacs package. To install them, one should untar
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
291 them to someplace convenient (like /var/tmp), and issue the appropriate make
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
292 command to install.
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
293
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
294 ** Binary package installation (binary-packages)
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
295 ================================================
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
296
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
297 Prerequisite: XEmacs 20.3-beta28.
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
298
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
299 Binary packages are complete entities that can be untarred at the top
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
300 level of an XEmacs package hierarchy and work at runtime. To install files
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
301 in this directory, run the command `M-x package-admin-add-binary-package'
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
302 and fill in appropriate values to the prompts.
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
303
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
304 ** Single file package installation
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
305 ===================================
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
306
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
307 Prerequisite: XEmacs 20.3-beta28.
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
308
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
309 These are single file, self-contained lisp packages that don't need a
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
310 separate directory. To install something from this directory, run
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
311 the command `M-x package-admin-add-single-file-package' and fill in the
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 197
diff changeset
312 prompts.