Mercurial > emacs
annotate man/trouble.texi @ 36606:a72b3da04728
(which-func-modes): Add cperl-mode.
(which-func-mode-global): Use define-minor-mode.
author | Stefan Monnier <monnier@iro.umontreal.ca> |
---|---|
date | Tue, 06 Mar 2001 23:47:40 +0000 |
parents | 1ba3f8033b3a |
children | 639ad3d05eb6 |
rev | line source |
---|---|
25829 | 1 @c This is part of the Emacs manual. |
2 @c Copyright (C) 1985, 86, 87, 93, 94, 95, 1997 Free Software Foundation, Inc. | |
3 @c See file emacs.texi for copying conditions. | |
4 @iftex | |
5 @chapter Dealing with Common Problems | |
6 | |
7 If you type an Emacs command you did not intend, the results are often | |
8 mysterious. This chapter tells what you can do to cancel your mistake or | |
9 recover from a mysterious situation. Emacs bugs and system crashes are | |
10 also considered. | |
11 @end iftex | |
12 | |
13 @node Quitting, Lossage, Customization, Top | |
14 @section Quitting and Aborting | |
15 @cindex quitting | |
16 | |
17 @table @kbd | |
18 @item C-g | |
36180
252e21b04fb1
Suggest copying problematical manual text into the bug report.
Richard M. Stallman <rms@gnu.org>
parents:
35874
diff
changeset
|
19 @itemx C-@key{BREAK} @r{(MS-DOS only)} |
252e21b04fb1
Suggest copying problematical manual text into the bug report.
Richard M. Stallman <rms@gnu.org>
parents:
35874
diff
changeset
|
20 Quit: cancel running or partially typed command. |
25829 | 21 @item C-] |
22 Abort innermost recursive editing level and cancel the command which | |
23 invoked it (@code{abort-recursive-edit}). | |
24 @item @key{ESC} @key{ESC} @key{ESC} | |
25 Either quit or abort, whichever makes sense (@code{keyboard-escape-quit}). | |
26 @item M-x top-level | |
27 Abort all recursive editing levels that are currently executing. | |
28 @item C-x u | |
29 Cancel a previously made change in the buffer contents (@code{undo}). | |
30 @end table | |
31 | |
32 There are two ways of canceling commands which are not finished | |
33 executing: @dfn{quitting} with @kbd{C-g}, and @dfn{aborting} with | |
34 @kbd{C-]} or @kbd{M-x top-level}. Quitting cancels a partially typed | |
35 command or one which is already running. Aborting exits a recursive | |
36 editing level and cancels the command that invoked the recursive edit. | |
37 (@xref{Recursive Edit}.) | |
38 | |
39 @cindex quitting | |
40 @kindex C-g | |
41 Quitting with @kbd{C-g} is used for getting rid of a partially typed | |
42 command, or a numeric argument that you don't want. It also stops a | |
43 running command in the middle in a relatively safe way, so you can use | |
44 it if you accidentally give a command which takes a long time. In | |
45 particular, it is safe to quit out of killing; either your text will | |
46 @emph{all} still be in the buffer, or it will @emph{all} be in the kill | |
47 ring (or maybe both). Quitting an incremental search does special | |
48 things documented under searching; in general, it may take two | |
49 successive @kbd{C-g} characters to get out of a search | |
50 (@pxref{Incremental Search}). | |
51 | |
52 On MS-DOS, the character @kbd{C-@key{BREAK}} serves as a quit character | |
53 like @kbd{C-g}. The reason is that it is not feasible, on MS-DOS, to | |
54 recognize @kbd{C-g} while a command is running, between interactions | |
55 with the user. By contrast, it @emph{is} feasible to recognize | |
56 @kbd{C-@key{BREAK}} at all times. @xref{MS-DOS Input}. | |
57 | |
36180
252e21b04fb1
Suggest copying problematical manual text into the bug report.
Richard M. Stallman <rms@gnu.org>
parents:
35874
diff
changeset
|
58 @findex keyboard-quit |
25829 | 59 @kbd{C-g} works by setting the variable @code{quit-flag} to @code{t} |
60 the instant @kbd{C-g} is typed; Emacs Lisp checks this variable | |
61 frequently and quits if it is non-@code{nil}. @kbd{C-g} is only | |
62 actually executed as a command if you type it while Emacs is waiting for | |
36180
252e21b04fb1
Suggest copying problematical manual text into the bug report.
Richard M. Stallman <rms@gnu.org>
parents:
35874
diff
changeset
|
63 input. In that case, the command it runs is @code{keyboard-quit}. |
25829 | 64 |
65 If you quit with @kbd{C-g} a second time before the first @kbd{C-g} is | |
66 recognized, you activate the ``emergency escape'' feature and return to | |
67 the shell. @xref{Emergency Escape}. | |
68 | |
69 @cindex NFS and quitting | |
70 There may be times when you cannot quit. When Emacs is waiting for | |
71 the operating system to do something, quitting is impossible unless | |
72 special pains are taken for the particular system call within Emacs | |
73 where the waiting occurs. We have done this for the system calls that | |
74 users are likely to want to quit from, but it's possible you will find | |
75 another. In one very common case---waiting for file input or output | |
76 using NFS---Emacs itself knows how to quit, but most NFS implementations | |
77 simply do not allow user programs to stop waiting for NFS when the NFS | |
78 server is hung. | |
79 | |
80 @cindex aborting recursive edit | |
81 @findex abort-recursive-edit | |
82 @kindex C-] | |
83 Aborting with @kbd{C-]} (@code{abort-recursive-edit}) is used to get | |
84 out of a recursive editing level and cancel the command which invoked | |
85 it. Quitting with @kbd{C-g} does not do this, and could not do this, | |
86 because it is used to cancel a partially typed command @emph{within} the | |
87 recursive editing level. Both operations are useful. For example, if | |
88 you are in a recursive edit and type @kbd{C-u 8} to enter a numeric | |
89 argument, you can cancel that argument with @kbd{C-g} and remain in the | |
90 recursive edit. | |
91 | |
92 @findex keyboard-escape-quit | |
93 @kindex ESC ESC ESC | |
94 The command @kbd{@key{ESC} @key{ESC} @key{ESC}} | |
95 (@code{keyboard-escape-quit}) can either quit or abort. This key was | |
96 defined because @key{ESC} is used to ``get out'' in many PC programs. | |
97 It can cancel a prefix argument, clear a selected region, or get out of | |
98 a Query Replace, like @kbd{C-g}. It can get out of the minibuffer or a | |
99 recursive edit, like @kbd{C-]}. It can also get out of splitting the | |
100 frame into multiple windows, like @kbd{C-x 1}. One thing it cannot do, | |
101 however, is stop a command that is running. That's because it executes | |
102 as an ordinary command, and Emacs doesn't notice it until it is ready | |
103 for a command. | |
104 | |
105 @findex top-level | |
106 The command @kbd{M-x top-level} is equivalent to ``enough'' @kbd{C-]} | |
107 commands to get you out of all the levels of recursive edits that you | |
108 are in. @kbd{C-]} gets you out one level at a time, but @kbd{M-x | |
109 top-level} goes out all levels at once. Both @kbd{C-]} and @kbd{M-x | |
110 top-level} are like all other commands, and unlike @kbd{C-g}, in that | |
111 they take effect only when Emacs is ready for a command. @kbd{C-]} is | |
112 an ordinary key and has its meaning only because of its binding in the | |
113 keymap. @xref{Recursive Edit}. | |
114 | |
115 @kbd{C-x u} (@code{undo}) is not strictly speaking a way of canceling | |
116 a command, but you can think of it as canceling a command that already | |
117 finished executing. @xref{Undo}. | |
118 | |
119 @node Lossage, Bugs, Quitting, Top | |
120 @section Dealing with Emacs Trouble | |
121 | |
122 This section describes various conditions in which Emacs fails to work | |
123 normally, and how to recognize them and correct them. | |
124 | |
125 @menu | |
126 * DEL Gets Help:: What to do if @key{DEL} doesn't delete. | |
127 * Stuck Recursive:: `[...]' in mode line around the parentheses. | |
128 * Screen Garbled:: Garbage on the screen. | |
129 * Text Garbled:: Garbage in the text. | |
130 * Unasked-for Search:: Spontaneous entry to incremental search. | |
131 * Memory Full:: How to cope when you run out of memory. | |
132 * After a Crash:: Recovering editing in an Emacs session that crashed. | |
133 * Emergency Escape:: Emergency escape--- | |
134 What to do if Emacs stops responding. | |
135 * Total Frustration:: When you are at your wits' end. | |
136 @end menu | |
137 | |
138 @node DEL Gets Help | |
139 @subsection If @key{DEL} Fails to Delete | |
140 | |
141 If you find that @key{DEL} enters Help like @kbd{Control-h} instead of | |
142 deleting a character, your terminal is sending the wrong code for | |
143 @key{DEL}. You can work around this problem by changing the keyboard | |
144 translation table (@pxref{Keyboard Translations}). | |
145 | |
146 @node Stuck Recursive | |
147 @subsection Recursive Editing Levels | |
148 | |
149 Recursive editing levels are important and useful features of Emacs, but | |
150 they can seem like malfunctions to the user who does not understand them. | |
151 | |
152 If the mode line has square brackets @samp{[@dots{}]} around the parentheses | |
153 that contain the names of the major and minor modes, you have entered a | |
154 recursive editing level. If you did not do this on purpose, or if you | |
155 don't understand what that means, you should just get out of the recursive | |
156 editing level. To do so, type @kbd{M-x top-level}. This is called getting | |
157 back to top level. @xref{Recursive Edit}. | |
158 | |
159 @node Screen Garbled | |
160 @subsection Garbage on the Screen | |
161 | |
162 If the data on the screen looks wrong, the first thing to do is see | |
36294
4f794fec4857
(Screen Garbled): Remove a comma.
Gerd Moellmann <gerd@gnu.org>
parents:
36180
diff
changeset
|
163 whether the text is really wrong. Type @kbd{C-l} to redisplay the |
25829 | 164 entire screen. If the screen appears correct after this, the problem |
165 was entirely in the previous screen update. (Otherwise, see @ref{Text | |
166 Garbled}.) | |
167 | |
168 Display updating problems often result from an incorrect termcap entry | |
169 for the terminal you are using. The file @file{etc/TERMS} in the Emacs | |
170 distribution gives the fixes for known problems of this sort. | |
171 @file{INSTALL} contains general advice for these problems in one of its | |
172 sections. Very likely there is simply insufficient padding for certain | |
173 display operations. To investigate the possibility that you have this sort | |
174 of problem, try Emacs on another terminal made by a different manufacturer. | |
175 If problems happen frequently on one kind of terminal but not another kind, | |
176 it is likely to be a bad termcap entry, though it could also be due to a | |
177 bug in Emacs that appears for terminals that have or that lack specific | |
178 features. | |
179 | |
180 @node Text Garbled | |
181 @subsection Garbage in the Text | |
182 | |
183 If @kbd{C-l} shows that the text is wrong, try undoing the changes to it | |
184 using @kbd{C-x u} until it gets back to a state you consider correct. Also | |
185 try @kbd{C-h l} to find out what command you typed to produce the observed | |
186 results. | |
187 | |
188 If a large portion of text appears to be missing at the beginning or | |
189 end of the buffer, check for the word @samp{Narrow} in the mode line. | |
190 If it appears, the text you don't see is probably still present, but | |
191 temporarily off-limits. To make it accessible again, type @kbd{C-x n | |
192 w}. @xref{Narrowing}. | |
193 | |
194 @node Unasked-for Search | |
195 @subsection Spontaneous Entry to Incremental Search | |
196 | |
197 If Emacs spontaneously displays @samp{I-search:} at the bottom of the | |
198 screen, it means that the terminal is sending @kbd{C-s} and @kbd{C-q} | |
199 according to the poorly designed xon/xoff ``flow control'' protocol. | |
200 | |
201 If this happens to you, your best recourse is to put the terminal in a | |
202 mode where it will not use flow control, or give it so much padding that | |
203 it will never send a @kbd{C-s}. (One way to increase the amount of | |
204 padding is to set the variable @code{baud-rate} to a larger value. Its | |
205 value is the terminal output speed, measured in the conventional units | |
206 of baud.) | |
207 | |
208 @cindex flow control | |
209 @cindex xon-xoff | |
210 @findex enable-flow-control | |
211 If you don't succeed in turning off flow control, the next best thing | |
212 is to tell Emacs to cope with it. To do this, call the function | |
213 @code{enable-flow-control}. | |
214 | |
215 @findex enable-flow-control-on | |
216 Typically there are particular terminal types with which you must use | |
217 flow control. You can conveniently ask for flow control on those | |
218 terminal types only, using @code{enable-flow-control-on}. For example, | |
219 if you find you must use flow control on VT-100 and H19 terminals, put | |
220 the following in your @file{.emacs} file: | |
221 | |
222 @example | |
223 (enable-flow-control-on "vt100" "h19") | |
224 @end example | |
225 | |
226 When flow control is enabled, you must type @kbd{C-\} to get the | |
227 effect of a @kbd{C-s}, and type @kbd{C-^} to get the effect of a | |
228 @kbd{C-q}. (These aliases work by means of keyboard translations; see | |
229 @ref{Keyboard Translations}.) | |
230 | |
231 @node Memory Full | |
232 @subsection Running out of Memory | |
233 @cindex memory full | |
234 @cindex out of memory | |
235 | |
236 If you get the error message @samp{Virtual memory exceeded}, save your | |
237 modified buffers with @kbd{C-x s}. This method of saving them has the | |
238 smallest need for additional memory. Emacs keeps a reserve of memory | |
239 which it makes available when this error happens; that should be enough | |
240 to enable @kbd{C-x s} to complete its work. | |
241 | |
242 Once you have saved your modified buffers, you can exit this Emacs job | |
243 and start another, or you can use @kbd{M-x kill-some-buffers} to free | |
244 space in the current Emacs job. If you kill buffers containing a | |
245 substantial amount of text, you can safely go on editing. Emacs refills | |
246 its memory reserve automatically when it sees sufficient free space | |
247 available, in case you run out of memory another time. | |
248 | |
249 Do not use @kbd{M-x buffer-menu} to save or kill buffers when you run | |
250 out of memory, because the buffer menu needs a fair amount memory | |
251 itself, and the reserve supply may not be enough. | |
252 | |
253 @node After a Crash | |
254 @subsection Recovery After a Crash | |
255 | |
256 If Emacs or the computer crashes, you can recover the files you were | |
257 editing at the time of the crash from their auto-save files. To do | |
258 this, start Emacs again and type the command @kbd{M-x recover-session}. | |
259 | |
260 This command initially displays a buffer which lists interrupted | |
261 session files, each with its date. You must choose which session to | |
262 recover from. Typically the one you want is the most recent one. Move | |
263 point to the one you choose, and type @kbd{C-c C-c}. | |
264 | |
265 Then @code{recover-session} asks about each of the files that you were | |
266 editing during that session; it asks whether to recover that file. If | |
267 you answer @kbd{y} for a file, it shows the dates of that file and its | |
268 auto-save file, then asks once again whether to recover that file. For | |
269 the second question, you must confirm with @kbd{yes}. If you do, Emacs | |
270 visits the file but gets the text from the auto-save file. | |
271 | |
272 When @code{recover-session} is done, the files you've chosen to | |
273 recover are present in Emacs buffers. You should then save them. Only | |
274 this---saving them---updates the files themselves. | |
275 | |
276 @node Emergency Escape | |
277 @subsection Emergency Escape | |
278 | |
279 Because at times there have been bugs causing Emacs to loop without | |
280 checking @code{quit-flag}, a special feature causes Emacs to be suspended | |
281 immediately if you type a second @kbd{C-g} while the flag is already set, | |
282 so you can always get out of GNU Emacs. Normally Emacs recognizes and | |
283 clears @code{quit-flag} (and quits!) quickly enough to prevent this from | |
284 happening. (On MS-DOS and compatible systems, type @kbd{C-@key{BREAK}} | |
285 twice.) | |
286 | |
287 When you resume Emacs after a suspension caused by multiple @kbd{C-g}, it | |
288 asks two questions before going back to what it had been doing: | |
289 | |
290 @example | |
291 Auto-save? (y or n) | |
292 Abort (and dump core)? (y or n) | |
293 @end example | |
294 | |
295 @noindent | |
296 Answer each one with @kbd{y} or @kbd{n} followed by @key{RET}. | |
297 | |
298 Saying @kbd{y} to @samp{Auto-save?} causes immediate auto-saving of all | |
299 modified buffers in which auto-saving is enabled. | |
300 | |
301 Saying @kbd{y} to @samp{Abort (and dump core)?} causes an illegal instruction to be | |
302 executed, dumping core. This is to enable a wizard to figure out why Emacs | |
303 was failing to quit in the first place. Execution does not continue | |
304 after a core dump. If you answer @kbd{n}, execution does continue. With | |
305 luck, GNU Emacs will ultimately check @code{quit-flag} and quit normally. | |
306 If not, and you type another @kbd{C-g}, it is suspended again. | |
307 | |
308 If Emacs is not really hung, just slow, you may invoke the double | |
309 @kbd{C-g} feature without really meaning to. Then just resume and answer | |
310 @kbd{n} to both questions, and you will arrive at your former state. | |
311 Presumably the quit you requested will happen soon. | |
312 | |
313 The double-@kbd{C-g} feature is turned off when Emacs is running under | |
314 the X Window System, since you can use the window manager to kill Emacs | |
315 or to create another window and run another program. | |
316 | |
317 On MS-DOS and compatible systems, the emergency escape feature is | |
318 sometimes unavailable, even if you press @kbd{C-@key{BREAK}} twice, when | |
319 some system call (MS-DOS or BIOS) hangs, or when Emacs is stuck in a | |
320 very tight endless loop (in C code, @strong{not} in Lisp code). | |
321 | |
322 @node Total Frustration | |
323 @subsection Help for Total Frustration | |
324 @cindex Eliza | |
325 @cindex doctor | |
326 | |
327 If using Emacs (or something else) becomes terribly frustrating and none | |
328 of the techniques described above solve the problem, Emacs can still help | |
329 you. | |
330 | |
331 First, if the Emacs you are using is not responding to commands, type | |
332 @kbd{C-g C-g} to get out of it and then start a new one. | |
333 | |
334 @findex doctor | |
335 Second, type @kbd{M-x doctor @key{RET}}. | |
336 | |
337 The doctor will help you feel better. Each time you say something to | |
338 the doctor, you must end it by typing @key{RET} @key{RET}. This lets | |
339 the doctor know you are finished. | |
340 | |
341 @node Bugs, Contributing, Lossage, Top | |
342 @section Reporting Bugs | |
343 | |
344 @cindex bugs | |
345 Sometimes you will encounter a bug in Emacs. Although we cannot | |
346 promise we can or will fix the bug, and we might not even agree that it | |
347 is a bug, we want to hear about problems you encounter. Often we agree | |
348 they are bugs and want to fix them. | |
349 | |
350 To make it possible for us to fix a bug, you must report it. In order | |
351 to do so effectively, you must know when and how to do it. | |
352 | |
353 @menu | |
354 * Criteria: Bug Criteria. Have you really found a bug? | |
355 * Understanding Bug Reporting:: How to report a bug effectively. | |
356 * Checklist:: Steps to follow for a good bug report. | |
357 * Sending Patches:: How to send a patch for GNU Emacs. | |
358 @end menu | |
359 | |
360 @node Bug Criteria | |
361 @subsection When Is There a Bug | |
362 | |
363 If Emacs executes an illegal instruction, or dies with an operating | |
364 system error message that indicates a problem in the program (as opposed to | |
365 something like ``disk full''), then it is certainly a bug. | |
366 | |
367 If Emacs updates the display in a way that does not correspond to what is | |
368 in the buffer, then it is certainly a bug. If a command seems to do the | |
369 wrong thing but the problem corrects itself if you type @kbd{C-l}, it is a | |
370 case of incorrect display updating. | |
371 | |
372 Taking forever to complete a command can be a bug, but you must make | |
373 certain that it was really Emacs's fault. Some commands simply take a | |
374 long time. Type @kbd{C-g} (@kbd{C-@key{BREAK}} on MS-DOS) and then @kbd{C-h l} | |
375 to see whether the input Emacs received was what you intended to type; | |
376 if the input was such that you @emph{know} it should have been processed | |
377 quickly, report a bug. If you don't know whether the command should | |
378 take a long time, find out by looking in the manual or by asking for | |
379 assistance. | |
380 | |
381 If a command you are familiar with causes an Emacs error message in a | |
382 case where its usual definition ought to be reasonable, it is probably a | |
383 bug. | |
384 | |
385 If a command does the wrong thing, that is a bug. But be sure you know | |
386 for certain what it ought to have done. If you aren't familiar with the | |
387 command, or don't know for certain how the command is supposed to work, | |
388 then it might actually be working right. Rather than jumping to | |
389 conclusions, show the problem to someone who knows for certain. | |
390 | |
36388
5835d43dcf93
(Bug Criteria): Reword a sentence.
Gerd Moellmann <gerd@gnu.org>
parents:
36294
diff
changeset
|
391 Finally, a command's intended definition may not be the best |
5835d43dcf93
(Bug Criteria): Reword a sentence.
Gerd Moellmann <gerd@gnu.org>
parents:
36294
diff
changeset
|
392 possible definition for editing with. This is a very important sort |
5835d43dcf93
(Bug Criteria): Reword a sentence.
Gerd Moellmann <gerd@gnu.org>
parents:
36294
diff
changeset
|
393 of problem, but it is also a matter of judgment. Also, it is easy to |
5835d43dcf93
(Bug Criteria): Reword a sentence.
Gerd Moellmann <gerd@gnu.org>
parents:
36294
diff
changeset
|
394 come to such a conclusion out of ignorance of some of the existing |
5835d43dcf93
(Bug Criteria): Reword a sentence.
Gerd Moellmann <gerd@gnu.org>
parents:
36294
diff
changeset
|
395 features. It is probably best not to complain about such a problem |
5835d43dcf93
(Bug Criteria): Reword a sentence.
Gerd Moellmann <gerd@gnu.org>
parents:
36294
diff
changeset
|
396 until you have checked the documentation in the usual ways, feel |
5835d43dcf93
(Bug Criteria): Reword a sentence.
Gerd Moellmann <gerd@gnu.org>
parents:
36294
diff
changeset
|
397 confident that you understand it, and know for certain that what you |
5835d43dcf93
(Bug Criteria): Reword a sentence.
Gerd Moellmann <gerd@gnu.org>
parents:
36294
diff
changeset
|
398 want is not available. If you are not sure what the command is |
5835d43dcf93
(Bug Criteria): Reword a sentence.
Gerd Moellmann <gerd@gnu.org>
parents:
36294
diff
changeset
|
399 supposed to do after a careful reading of the manual, check the index |
5835d43dcf93
(Bug Criteria): Reword a sentence.
Gerd Moellmann <gerd@gnu.org>
parents:
36294
diff
changeset
|
400 and glossary for any terms that may be unclear. |
25829 | 401 |
402 If after careful rereading of the manual you still do not understand | |
403 what the command should do, that indicates a bug in the manual, which | |
404 you should report. The manual's job is to make everything clear to | |
405 people who are not Emacs experts---including you. It is just as | |
406 important to report documentation bugs as program bugs. | |
407 | |
408 If the on-line documentation string of a function or variable disagrees | |
409 with the manual, one of them must be wrong; that is a bug. | |
410 | |
411 @node Understanding Bug Reporting | |
412 @subsection Understanding Bug Reporting | |
413 | |
414 @findex emacs-version | |
415 When you decide that there is a bug, it is important to report it and to | |
416 report it in a way which is useful. What is most useful is an exact | |
417 description of what commands you type, starting with the shell command to | |
418 run Emacs, until the problem happens. | |
419 | |
420 The most important principle in reporting a bug is to report | |
421 @emph{facts}. Hypotheses and verbal descriptions are no substitute for | |
422 the detailed raw data. Reporting the facts is straightforward, but many | |
423 people strain to posit explanations and report them instead of the | |
424 facts. If the explanations are based on guesses about how Emacs is | |
425 implemented, they will be useless; meanwhile, lacking the facts, we will | |
426 have no real information about the bug. | |
427 | |
428 For example, suppose that you type @kbd{C-x C-f /glorp/baz.ugh | |
429 @key{RET}}, visiting a file which (you know) happens to be rather large, | |
430 and Emacs displayed @samp{I feel pretty today}. The best way to report | |
431 the bug is with a sentence like the preceding one, because it gives all | |
432 the facts. | |
433 | |
434 A bad way would be to assume that the problem is due to the size of | |
435 the file and say, ``I visited a large file, and Emacs displayed @samp{I | |
436 feel pretty today}.'' This is what we mean by ``guessing | |
437 explanations.'' The problem is just as likely to be due to the fact | |
438 that there is a @samp{z} in the file name. If this is so, then when we | |
439 got your report, we would try out the problem with some ``large file,'' | |
440 probably with no @samp{z} in its name, and not see any problem. There | |
441 is no way in the world that we could guess that we should try visiting a | |
442 file with a @samp{z} in its name. | |
443 | |
444 Alternatively, the problem might be due to the fact that the file starts | |
445 with exactly 25 spaces. For this reason, you should make sure that you | |
446 inform us of the exact contents of any file that is needed to reproduce the | |
447 bug. What if the problem only occurs when you have typed the @kbd{C-x C-a} | |
448 command previously? This is why we ask you to give the exact sequence of | |
449 characters you typed since starting the Emacs session. | |
450 | |
451 You should not even say ``visit a file'' instead of @kbd{C-x C-f} unless | |
452 you @emph{know} that it makes no difference which visiting command is used. | |
453 Similarly, rather than saying ``if I have three characters on the line,'' | |
454 say ``after I type @kbd{@key{RET} A B C @key{RET} C-p},'' if that is | |
455 the way you entered the text.@refill | |
456 | |
457 So please don't guess any explanations when you report a bug. If you | |
458 want to actually @emph{debug} the problem, and report explanations that | |
459 are more than guesses, that is useful---but please include the facts as | |
460 well. | |
461 | |
462 @node Checklist | |
463 @subsection Checklist for Bug Reports | |
464 | |
465 @cindex reporting bugs | |
466 The best way to send a bug report is to mail it electronically to the | |
36180
252e21b04fb1
Suggest copying problematical manual text into the bug report.
Richard M. Stallman <rms@gnu.org>
parents:
35874
diff
changeset
|
467 Emacs maintainers at @email{bug-gnu-emacs@@gnu.org}, or to |
252e21b04fb1
Suggest copying problematical manual text into the bug report.
Richard M. Stallman <rms@gnu.org>
parents:
35874
diff
changeset
|
468 @email{emacs-pretest-bug@@gnu.org} if you are pretesting an Emacs beta |
26021
4f5e4ec69f6a
Add emacs-prestest-bug@gnu.org analogous to bug-gnu-emacs@gnu.org.
Gerd Moellmann <gerd@gnu.org>
parents:
25829
diff
changeset
|
469 release. (If you want to suggest a change as an improvement, use the |
4f5e4ec69f6a
Add emacs-prestest-bug@gnu.org analogous to bug-gnu-emacs@gnu.org.
Gerd Moellmann <gerd@gnu.org>
parents:
25829
diff
changeset
|
470 same address.) |
25829 | 471 |
472 If you'd like to read the bug reports, you can find them on the | |
473 newsgroup @samp{gnu.emacs.bug}; keep in mind, however, that as a | |
474 spectator you should not criticize anything about what you see there. | |
475 The purpose of bug reports is to give information to the Emacs | |
476 maintainers. Spectators are welcome only as long as they do not | |
477 interfere with this. In particular, some bug reports contain large | |
478 amounts of data; spectators should not complain about this. | |
479 | |
480 Please do not post bug reports using netnews; mail is more reliable | |
481 than netnews about reporting your correct address, which we may need in | |
482 order to ask you for more information. | |
483 | |
484 If you can't send electronic mail, then mail the bug report on paper | |
485 or machine-readable media to this address: | |
486 | |
487 @format | |
488 GNU Emacs Bugs | |
489 Free Software Foundation | |
490 59 Temple Place, Suite 330 | |
491 Boston, MA 02111-1307 USA | |
492 @end format | |
493 | |
494 We do not promise to fix the bug; but if the bug is serious, | |
495 or ugly, or easy to fix, chances are we will want to. | |
496 | |
497 @findex report-emacs-bug | |
498 A convenient way to send a bug report for Emacs is to use the command | |
499 @kbd{M-x report-emacs-bug}. This sets up a mail buffer (@pxref{Sending | |
500 Mail}) and automatically inserts @emph{some} of the essential | |
501 information. However, it cannot supply all the necessary information; | |
502 you should still read and follow the guidelines below, so you can enter | |
503 the other crucial information by hand before you send the message. | |
504 | |
505 To enable maintainers to investigate a bug, your report | |
506 should include all these things: | |
507 | |
508 @itemize @bullet | |
509 @item | |
510 The version number of Emacs. Without this, we won't know whether there | |
511 is any point in looking for the bug in the current version of GNU | |
512 Emacs. | |
513 | |
514 You can get the version number by typing @kbd{M-x emacs-version | |
515 @key{RET}}. If that command does not work, you probably have something | |
516 other than GNU Emacs, so you will have to report the bug somewhere | |
517 else. | |
518 | |
519 @item | |
520 The type of machine you are using, and the operating system name and | |
521 version number. @kbd{M-x emacs-version @key{RET}} provides this | |
522 information too. Copy its output from the @samp{*Messages*} buffer, so | |
523 that you get it all and get it accurately. | |
524 | |
525 @item | |
526 The operands given to the @code{configure} command when Emacs was | |
527 installed. | |
528 | |
529 @item | |
530 A complete list of any modifications you have made to the Emacs source. | |
531 (We may not have time to investigate the bug unless it happens in an | |
532 unmodified Emacs. But if you've made modifications and you don't tell | |
533 us, you are sending us on a wild goose chase.) | |
534 | |
535 Be precise about these changes. A description in English is not | |
536 enough---send a context diff for them. | |
537 | |
538 Adding files of your own, or porting to another machine, is a | |
539 modification of the source. | |
540 | |
541 @item | |
542 Details of any other deviations from the standard procedure for installing | |
543 GNU Emacs. | |
544 | |
545 @item | |
546 The complete text of any files needed to reproduce the bug. | |
547 | |
548 If you can tell us a way to cause the problem without visiting any files, | |
549 please do so. This makes it much easier to debug. If you do need files, | |
550 make sure you arrange for us to see their exact contents. For example, it | |
551 can often matter whether there are spaces at the ends of lines, or a | |
552 newline after the last line in the buffer (nothing ought to care whether | |
553 the last line is terminated, but try telling the bugs that). | |
554 | |
555 @item | |
556 The precise commands we need to type to reproduce the bug. | |
557 | |
558 @findex open-dribble-file | |
559 @cindex dribble file | |
35705
6c05ec832ecc
(Checklist): Add index entry for logging keystrokes.
Eli Zaretskii <eliz@gnu.org>
parents:
35239
diff
changeset
|
560 @cindex logging keystrokes |
25829 | 561 The easy way to record the input to Emacs precisely is to write a |
562 dribble file. To start the file, execute the Lisp expression | |
563 | |
564 @example | |
565 (open-dribble-file "~/dribble") | |
566 @end example | |
567 | |
568 @noindent | |
569 using @kbd{M-:} or from the @samp{*scratch*} buffer just after | |
570 starting Emacs. From then on, Emacs copies all your input to the | |
571 specified dribble file until the Emacs process is killed. | |
572 | |
573 @item | |
574 @findex open-termscript | |
575 @cindex termscript file | |
29107 | 576 @cindex @env{TERM} environment variable |
25829 | 577 For possible display bugs, the terminal type (the value of environment |
29107 | 578 variable @env{TERM}), the complete termcap entry for the terminal from |
25829 | 579 @file{/etc/termcap} (since that file is not identical on all machines), |
580 and the output that Emacs actually sent to the terminal. | |
581 | |
582 The way to collect the terminal output is to execute the Lisp expression | |
583 | |
584 @example | |
585 (open-termscript "~/termscript") | |
586 @end example | |
587 | |
588 @noindent | |
589 using @kbd{M-:} or from the @samp{*scratch*} buffer just after | |
590 starting Emacs. From then on, Emacs copies all terminal output to the | |
591 specified termscript file as well, until the Emacs process is killed. | |
592 If the problem happens when Emacs starts up, put this expression into | |
593 your @file{.emacs} file so that the termscript file will be open when | |
594 Emacs displays the screen for the first time. | |
595 | |
596 Be warned: it is often difficult, and sometimes impossible, to fix a | |
597 terminal-dependent bug without access to a terminal of the type that | |
598 stimulates the bug.@refill | |
599 | |
600 @item | |
35239
a4e73c75cbca
Ask for locale info in bug reports.
Richard M. Stallman <rms@gnu.org>
parents:
35188
diff
changeset
|
601 If non-ASCII text or internationalization is relevant, the locale that |
36497
1ba3f8033b3a
(Checklist): Say that the example with LC_ALL and such is for a Unix shell.
Eli Zaretskii <eliz@gnu.org>
parents:
36388
diff
changeset
|
602 was current when you started Emacs. On GNU/Linux and Unix systems, or |
1ba3f8033b3a
(Checklist): Say that the example with LC_ALL and such is for a Unix shell.
Eli Zaretskii <eliz@gnu.org>
parents:
36388
diff
changeset
|
603 if you use a Unix-style shell such as Bash, you can use this shell |
1ba3f8033b3a
(Checklist): Say that the example with LC_ALL and such is for a Unix shell.
Eli Zaretskii <eliz@gnu.org>
parents:
36388
diff
changeset
|
604 command to view the relevant values: |
35239
a4e73c75cbca
Ask for locale info in bug reports.
Richard M. Stallman <rms@gnu.org>
parents:
35188
diff
changeset
|
605 |
a4e73c75cbca
Ask for locale info in bug reports.
Richard M. Stallman <rms@gnu.org>
parents:
35188
diff
changeset
|
606 @example |
a4e73c75cbca
Ask for locale info in bug reports.
Richard M. Stallman <rms@gnu.org>
parents:
35188
diff
changeset
|
607 echo LC_ALL=$LC_ALL LC_CTYPE=$LC_CTYPE LANG=$LANG |
a4e73c75cbca
Ask for locale info in bug reports.
Richard M. Stallman <rms@gnu.org>
parents:
35188
diff
changeset
|
608 @end example |
a4e73c75cbca
Ask for locale info in bug reports.
Richard M. Stallman <rms@gnu.org>
parents:
35188
diff
changeset
|
609 |
a4e73c75cbca
Ask for locale info in bug reports.
Richard M. Stallman <rms@gnu.org>
parents:
35188
diff
changeset
|
610 You can use the @kbd{M-!} command to execute the shell command from |
a4e73c75cbca
Ask for locale info in bug reports.
Richard M. Stallman <rms@gnu.org>
parents:
35188
diff
changeset
|
611 Emacs, and then copy the output from the @samp{*Messages*} buffer into |
a4e73c75cbca
Ask for locale info in bug reports.
Richard M. Stallman <rms@gnu.org>
parents:
35188
diff
changeset
|
612 the bug report. |
a4e73c75cbca
Ask for locale info in bug reports.
Richard M. Stallman <rms@gnu.org>
parents:
35188
diff
changeset
|
613 |
a4e73c75cbca
Ask for locale info in bug reports.
Richard M. Stallman <rms@gnu.org>
parents:
35188
diff
changeset
|
614 @item |
25829 | 615 A description of what behavior you observe that you believe is |
616 incorrect. For example, ``The Emacs process gets a fatal signal,'' or, | |
617 ``The resulting text is as follows, which I think is wrong.'' | |
618 | |
619 Of course, if the bug is that Emacs gets a fatal signal, then one can't | |
620 miss it. But if the bug is incorrect text, the maintainer might fail to | |
621 notice what is wrong. Why leave it to chance? | |
622 | |
623 Even if the problem you experience is a fatal signal, you should still | |
624 say so explicitly. Suppose something strange is going on, such as, your | |
625 copy of the source is out of sync, or you have encountered a bug in the | |
626 C library on your system. (This has happened!) Your copy might crash | |
627 and the copy here might not. If you @emph{said} to expect a crash, then | |
628 when Emacs here fails to crash, we would know that the bug was not | |
629 happening. If you don't say to expect a crash, then we would not know | |
630 whether the bug was happening---we would not be able to draw any | |
631 conclusion from our observations. | |
632 | |
633 @item | |
36180
252e21b04fb1
Suggest copying problematical manual text into the bug report.
Richard M. Stallman <rms@gnu.org>
parents:
35874
diff
changeset
|
634 If the bug is that the Emacs Manual or the Emacs Lisp Reference Manual |
252e21b04fb1
Suggest copying problematical manual text into the bug report.
Richard M. Stallman <rms@gnu.org>
parents:
35874
diff
changeset
|
635 fails to describe the actual behavior of Emacs, or that the text is |
252e21b04fb1
Suggest copying problematical manual text into the bug report.
Richard M. Stallman <rms@gnu.org>
parents:
35874
diff
changeset
|
636 confusing, copy in the text from the online manual which you think is |
252e21b04fb1
Suggest copying problematical manual text into the bug report.
Richard M. Stallman <rms@gnu.org>
parents:
35874
diff
changeset
|
637 at fault. If the section is small, just the section name is enough. |
252e21b04fb1
Suggest copying problematical manual text into the bug report.
Richard M. Stallman <rms@gnu.org>
parents:
35874
diff
changeset
|
638 |
252e21b04fb1
Suggest copying problematical manual text into the bug report.
Richard M. Stallman <rms@gnu.org>
parents:
35874
diff
changeset
|
639 @item |
25829 | 640 If the manifestation of the bug is an Emacs error message, it is |
641 important to report the precise text of the error message, and a | |
642 backtrace showing how the Lisp program in Emacs arrived at the error. | |
643 | |
644 To get the error message text accurately, copy it from the | |
645 @samp{*Messages*} buffer into the bug report. Copy all of it, not just | |
646 part. | |
647 | |
648 To make a backtrace for the error, evaluate the Lisp expression | |
649 @code{(setq @w{debug-on-error t})} before the error happens (that is to | |
650 say, you must execute that expression and then make the bug happen). | |
651 This causes the error to run the Lisp debugger, which shows you a | |
652 backtrace. Copy the text of the debugger's backtrace into the bug | |
653 report. | |
654 | |
655 This use of the debugger is possible only if you know how to make the | |
656 bug happen again. If you can't make it happen again, at least copy | |
657 the whole error message. | |
658 | |
659 @item | |
660 Check whether any programs you have loaded into the Lisp world, | |
661 including your @file{.emacs} file, set any variables that may affect the | |
662 functioning of Emacs. Also, see whether the problem happens in a | |
663 freshly started Emacs without loading your @file{.emacs} file (start | |
664 Emacs with the @code{-q} switch to prevent loading the init file). If | |
665 the problem does @emph{not} occur then, you must report the precise | |
666 contents of any programs that you must load into the Lisp world in order | |
667 to cause the problem to occur. | |
668 | |
669 @item | |
670 If the problem does depend on an init file or other Lisp programs that | |
671 are not part of the standard Emacs system, then you should make sure it | |
672 is not a bug in those programs by complaining to their maintainers | |
673 first. After they verify that they are using Emacs in a way that is | |
674 supposed to work, they should report the bug. | |
675 | |
676 @item | |
677 If you wish to mention something in the GNU Emacs source, show the line | |
678 of code with a few lines of context. Don't just give a line number. | |
679 | |
680 The line numbers in the development sources don't match those in your | |
681 sources. It would take extra work for the maintainers to determine what | |
682 code is in your version at a given line number, and we could not be | |
683 certain. | |
684 | |
685 @item | |
686 Additional information from a C debugger such as GDB might enable | |
687 someone to find a problem on a machine which he does not have available. | |
688 If you don't know how to use GDB, please read the GDB manual---it is not | |
689 very long, and using GDB is easy. You can find the GDB distribution, | |
690 including the GDB manual in online form, in most of the same places you | |
691 can find the Emacs distribution. To run Emacs under GDB, you should | |
692 switch to the @file{src} subdirectory in which Emacs was compiled, then | |
693 do @samp{gdb emacs}. It is important for the directory @file{src} to be | |
694 current so that GDB will read the @file{.gdbinit} file in this | |
695 directory. | |
696 | |
697 However, you need to think when you collect the additional information | |
698 if you want it to show what causes the bug. | |
699 | |
700 @cindex backtrace for bug reports | |
701 For example, many people send just a backtrace, but that is not very | |
702 useful by itself. A simple backtrace with arguments often conveys | |
703 little about what is happening inside GNU Emacs, because most of the | |
704 arguments listed in the backtrace are pointers to Lisp objects. The | |
705 numeric values of these pointers have no significance whatever; all that | |
706 matters is the contents of the objects they point to (and most of the | |
707 contents are themselves pointers). | |
708 | |
709 @findex debug_print | |
710 To provide useful information, you need to show the values of Lisp | |
711 objects in Lisp notation. Do this for each variable which is a Lisp | |
712 object, in several stack frames near the bottom of the stack. Look at | |
713 the source to see which variables are Lisp objects, because the debugger | |
714 thinks of them as integers. | |
715 | |
716 To show a variable's value in Lisp syntax, first print its value, then | |
717 use the user-defined GDB command @code{pr} to print the Lisp object in | |
718 Lisp syntax. (If you must use another debugger, call the function | |
719 @code{debug_print} with the object as an argument.) The @code{pr} | |
720 command is defined by the file @file{.gdbinit}, and it works only if you | |
721 are debugging a running process (not with a core dump). | |
722 | |
723 To make Lisp errors stop Emacs and return to GDB, put a breakpoint at | |
724 @code{Fsignal}. | |
725 | |
27729 | 726 For a short listing of Lisp functions running, type the GDB |
727 command @code{xbacktrace}. | |
728 | |
25829 | 729 The file @file{.gdbinit} defines several other commands that are useful |
730 for examining the data types and contents of Lisp objects. Their names | |
731 begin with @samp{x}. These commands work at a lower level than | |
732 @code{pr}, and are less convenient, but they may work even when | |
733 @code{pr} does not, such as when debugging a core dump or when Emacs has | |
734 had a fatal signal. | |
735 | |
35874
99572fa1c8c3
Remove the more arcane part of Emacs debug instructions. Replace
Eli Zaretskii <eliz@gnu.org>
parents:
35705
diff
changeset
|
736 @cindex debugging Emacs, tricks and techniques |
99572fa1c8c3
Remove the more arcane part of Emacs debug instructions. Replace
Eli Zaretskii <eliz@gnu.org>
parents:
35705
diff
changeset
|
737 More detailed advice and other useful techniques for debugging Emacs |
99572fa1c8c3
Remove the more arcane part of Emacs debug instructions. Replace
Eli Zaretskii <eliz@gnu.org>
parents:
35705
diff
changeset
|
738 are available in the file @file{etc/DEBUG} in the Emacs distribution. |
99572fa1c8c3
Remove the more arcane part of Emacs debug instructions. Replace
Eli Zaretskii <eliz@gnu.org>
parents:
35705
diff
changeset
|
739 That file also includes instructions for investigating problems |
99572fa1c8c3
Remove the more arcane part of Emacs debug instructions. Replace
Eli Zaretskii <eliz@gnu.org>
parents:
35705
diff
changeset
|
740 whereby Emacs stops responding (many people assume that Emacs is |
36180
252e21b04fb1
Suggest copying problematical manual text into the bug report.
Richard M. Stallman <rms@gnu.org>
parents:
35874
diff
changeset
|
741 ``hung,'' whereas in fact it might be in an infinite loop). |
25829 | 742 |
35874
99572fa1c8c3
Remove the more arcane part of Emacs debug instructions. Replace
Eli Zaretskii <eliz@gnu.org>
parents:
35705
diff
changeset
|
743 In an installed Emacs, the file @file{etc/DEBUG} is in the same |
99572fa1c8c3
Remove the more arcane part of Emacs debug instructions. Replace
Eli Zaretskii <eliz@gnu.org>
parents:
35705
diff
changeset
|
744 directory where the Emacs on-line documentation file @file{DOC}, |
99572fa1c8c3
Remove the more arcane part of Emacs debug instructions. Replace
Eli Zaretskii <eliz@gnu.org>
parents:
35705
diff
changeset
|
745 typically in the @file{/usr/local/share/emacs/@var{version}/etc/} |
99572fa1c8c3
Remove the more arcane part of Emacs debug instructions. Replace
Eli Zaretskii <eliz@gnu.org>
parents:
35705
diff
changeset
|
746 directory. The directory for your installation is stored in the |
99572fa1c8c3
Remove the more arcane part of Emacs debug instructions. Replace
Eli Zaretskii <eliz@gnu.org>
parents:
35705
diff
changeset
|
747 variable @code{data-directory}. |
25829 | 748 @end itemize |
749 | |
750 Here are some things that are not necessary in a bug report: | |
751 | |
752 @itemize @bullet | |
753 @item | |
754 A description of the envelope of the bug---this is not necessary for a | |
755 reproducible bug. | |
756 | |
757 Often people who encounter a bug spend a lot of time investigating | |
758 which changes to the input file will make the bug go away and which | |
759 changes will not affect it. | |
760 | |
761 This is often time-consuming and not very useful, because the way we | |
762 will find the bug is by running a single example under the debugger with | |
763 breakpoints, not by pure deduction from a series of examples. You might | |
764 as well save time by not searching for additional examples. | |
765 | |
766 Of course, if you can find a simpler example to report @emph{instead} of | |
767 the original one, that is a convenience. Errors in the output will be | |
768 easier to spot, running under the debugger will take less time, etc. | |
769 | |
770 However, simplification is not vital; if you can't do this or don't have | |
771 time to try, please report the bug with your original test case. | |
772 | |
773 @item | |
774 A system-call trace of Emacs execution. | |
775 | |
776 System-call traces are very useful for certain special kinds of | |
777 debugging, but in most cases they give little useful information. It is | |
778 therefore strange that many people seem to think that @emph{the} way to | |
779 report information about a crash is to send a system-call trace. Perhaps | |
780 this is a habit formed from experience debugging programs that don't | |
781 have source code or debugging symbols. | |
782 | |
783 In most programs, a backtrace is normally far, far more informative than | |
784 a system-call trace. Even in Emacs, a simple backtrace is generally | |
785 more informative, though to give full information you should supplement | |
786 the backtrace by displaying variable values and printing them as Lisp | |
787 objects with @code{pr} (see above). | |
788 | |
789 @item | |
790 A patch for the bug. | |
791 | |
792 A patch for the bug is useful if it is a good one. But don't omit the | |
793 other information that a bug report needs, such as the test case, on the | |
794 assumption that a patch is sufficient. We might see problems with your | |
795 patch and decide to fix the problem another way, or we might not | |
796 understand it at all. And if we can't understand what bug you are | |
797 trying to fix, or why your patch should be an improvement, we mustn't | |
798 install it. | |
799 | |
800 @ifinfo | |
801 @xref{Sending Patches}, for guidelines on how to make it easy for us to | |
802 understand and install your patches. | |
803 @end ifinfo | |
804 | |
805 @item | |
806 A guess about what the bug is or what it depends on. | |
807 | |
808 Such guesses are usually wrong. Even experts can't guess right about | |
809 such things without first using the debugger to find the facts. | |
810 @end itemize | |
811 | |
812 @node Sending Patches | |
813 @subsection Sending Patches for GNU Emacs | |
814 | |
815 @cindex sending patches for GNU Emacs | |
816 @cindex patches, sending | |
817 If you would like to write bug fixes or improvements for GNU Emacs, | |
818 that is very helpful. When you send your changes, please follow these | |
819 guidelines to make it easy for the maintainers to use them. If you | |
820 don't follow these guidelines, your information might still be useful, | |
821 but using it will take extra work. Maintaining GNU Emacs is a lot of | |
822 work in the best of circumstances, and we can't keep up unless you do | |
823 your best to help. | |
824 | |
825 @itemize @bullet | |
826 @item | |
827 Send an explanation with your changes of what problem they fix or what | |
828 improvement they bring about. For a bug fix, just include a copy of the | |
829 bug report, and explain why the change fixes the bug. | |
830 | |
831 (Referring to a bug report is not as good as including it, because then | |
832 we will have to look it up, and we have probably already deleted it if | |
833 we've already fixed the bug.) | |
834 | |
835 @item | |
836 Always include a proper bug report for the problem you think you have | |
837 fixed. We need to convince ourselves that the change is right before | |
838 installing it. Even if it is correct, we might have trouble | |
839 understanding it if we don't have a way to reproduce the problem. | |
840 | |
841 @item | |
842 Include all the comments that are appropriate to help people reading the | |
843 source in the future understand why this change was needed. | |
844 | |
845 @item | |
846 Don't mix together changes made for different reasons. | |
847 Send them @emph{individually}. | |
848 | |
849 If you make two changes for separate reasons, then we might not want to | |
850 install them both. We might want to install just one. If you send them | |
851 all jumbled together in a single set of diffs, we have to do extra work | |
852 to disentangle them---to figure out which parts of the change serve | |
853 which purpose. If we don't have time for this, we might have to ignore | |
854 your changes entirely. | |
855 | |
856 If you send each change as soon as you have written it, with its own | |
857 explanation, then two changes never get tangled up, and we can consider | |
858 each one properly without any extra work to disentangle them. | |
859 | |
860 @item | |
861 Send each change as soon as that change is finished. Sometimes people | |
862 think they are helping us by accumulating many changes to send them all | |
863 together. As explained above, this is absolutely the worst thing you | |
864 could do. | |
865 | |
866 Since you should send each change separately, you might as well send it | |
867 right away. That gives us the option of installing it immediately if it | |
868 is important. | |
869 | |
870 @item | |
871 Use @samp{diff -c} to make your diffs. Diffs without context are hard | |
872 to install reliably. More than that, they are hard to study; we must | |
873 always study a patch to decide whether we want to install it. Unidiff | |
874 format is better than contextless diffs, but not as easy to read as | |
875 @samp{-c} format. | |
876 | |
877 If you have GNU diff, use @samp{diff -c -F'^[_a-zA-Z0-9$]+ *('} when | |
878 making diffs of C code. This shows the name of the function that each | |
879 change occurs in. | |
880 | |
881 @item | |
882 Avoid any ambiguity as to which is the old version and which is the new. | |
883 Please make the old version the first argument to diff, and the new | |
884 version the second argument. And please give one version or the other a | |
885 name that indicates whether it is the old version or your new changed | |
886 one. | |
887 | |
888 @item | |
889 Write the change log entries for your changes. This is both to save us | |
890 the extra work of writing them, and to help explain your changes so we | |
891 can understand them. | |
892 | |
893 The purpose of the change log is to show people where to find what was | |
894 changed. So you need to be specific about what functions you changed; | |
895 in large functions, it's often helpful to indicate where within the | |
896 function the change was. | |
897 | |
898 On the other hand, once you have shown people where to find the change, | |
899 you need not explain its purpose in the change log. Thus, if you add a | |
900 new function, all you need to say about it is that it is new. If you | |
901 feel that the purpose needs explaining, it probably does---but put the | |
902 explanation in comments in the code. It will be more useful there. | |
903 | |
904 Please read the @file{ChangeLog} files in the @file{src} and @file{lisp} | |
905 directories to see what sorts of information to put in, and to learn the | |
906 style that we use. If you would like your name to appear in the header | |
907 line, showing who made the change, send us the header line. | |
908 @xref{Change Log}. | |
909 | |
910 @item | |
911 When you write the fix, keep in mind that we can't install a change that | |
912 would break other systems. Please think about what effect your change | |
913 will have if compiled on another type of system. | |
914 | |
915 Sometimes people send fixes that @emph{might} be an improvement in | |
916 general---but it is hard to be sure of this. It's hard to install | |
917 such changes because we have to study them very carefully. Of course, | |
918 a good explanation of the reasoning by which you concluded the change | |
919 was correct can help convince us. | |
920 | |
921 The safest changes are changes to the configuration files for a | |
922 particular machine. These are safe because they can't create new bugs | |
923 on other machines. | |
924 | |
925 Please help us keep up with the workload by designing the patch in a | |
926 form that is clearly safe to install. | |
927 @end itemize | |
928 | |
929 @node Contributing, Service, Bugs, Top | |
930 @section Contributing to Emacs Development | |
931 | |
932 If you would like to help pretest Emacs releases to assure they work | |
933 well, or if you would like to work on improving Emacs, please contact | |
29107 | 934 the maintainers at @email{bug-gnu-emacs@@gnu.org}. A pretester |
25829 | 935 should be prepared to investigate bugs as well as report them. If you'd |
936 like to work on improving Emacs, please ask for suggested projects or | |
937 suggest your own ideas. | |
938 | |
939 If you have already written an improvement, please tell us about it. If | |
940 you have not yet started work, it is useful to contact | |
29107 | 941 @email{bug-gnu-emacs@@gnu.org} before you start; it might be |
25829 | 942 possible to suggest ways to make your extension fit in better with the |
943 rest of Emacs. | |
944 | |
945 @node Service, Command Arguments, Contributing, Top | |
946 @section How To Get Help with GNU Emacs | |
947 | |
948 If you need help installing, using or changing GNU Emacs, there are two | |
949 ways to find it: | |
950 | |
951 @itemize @bullet | |
952 @item | |
953 Send a message to the mailing list | |
29107 | 954 @email{help-gnu-emacs@@gnu.org}, or post your request on |
25829 | 955 newsgroup @code{gnu.emacs.help}. (This mailing list and newsgroup |
956 interconnect, so it does not matter which one you use.) | |
957 | |
958 @item | |
959 Look in the service directory for someone who might help you for a fee. | |
960 The service directory is found in the file named @file{etc/SERVICE} in the | |
961 Emacs distribution. | |
962 @end itemize |