annotate etc/CONTRIBUTE @ 98499:6e7acef982ee

(compilation-start): Make sure to move to point-max only when we are in the compilation buffer.
author Martin Rudalics <rudalics@gmx.at>
date Sat, 04 Oct 2008 10:04:59 +0000
parents cbf5528cf447
children c90853557b90
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
87649
107ccd98fa12 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 84844
diff changeset
1 Copyright (C) 2006, 2007, 2008 Free Software Foundation, Inc.
84410
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
2 See end for license conditions.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
3
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
4
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
5 Contributing to Emacs
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
6
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
7 Emacs is a collaborative project and we encourage contributions from
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
8 anyone and everyone. If you want to contribute in the way that will
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
9 help us most, we recommend (1) fixing reported bugs and (2)
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
10 implementing the feature ideas in etc/TODO. However, if you think of
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
11 new features to add, please suggest them too -- we might like your
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
12 idea. Porting to new platforms is also useful, when there is a new
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
13 platform, but that is not common nowadays.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
14
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
15 For documentation on how to develop Emacs changes, refer to the Emacs
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
16 Manual and the Emacs Lisp Reference Manual (both included in the Emacs
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
17 distribution). The web pages in http://www.gnu.org/software/emacs
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
18 contain additional information.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
19
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
20 You may also want to submit your change so that can be considered for
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
21 inclusion in a future version of Emacs (see below).
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
22
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
23 If you don't feel up to hacking Emacs, there are many other ways to
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
24 help. You can answer questions on the mailing lists, write
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
25 documentation, find and report bugs, contribute to the Emacs web
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
26 pages, or develop a package that works with Emacs.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
27
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
28 Here are some style and legal conventions for contributors to Emacs:
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
29
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
30
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
31 * Coding Standards
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
32
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
33 Contributed code should follow the GNU Coding Standard.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
34
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
35 If it doesn't, we'll need to find someone to fix the code before we
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
36 can use it.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
37
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
38 Emacs has certain additional style and coding conventions.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
39
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
40 Ref: http://www.gnu.org/prep/standards_toc.html
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
41 Ref: GNU Coding Standards Info Manual
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
42 Ref: The "Tips" Appendix in the Emacs Lisp Reference.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
43
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
44
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
45 * Copyright Assignment
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
46
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
47 We can accept small changes without legal papers, and for medium-size
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
48 changes a copyright disclaimer is ok too. To accept substantial
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
49 contributions from you, we need a copyright assignment form filled out
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
50 and filed with the FSF.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
51
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
52 Contact us at emacs-devel@gnu.org to obtain the relevant forms.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
53
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
54
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
55 * Getting the Source Code
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
56
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
57 The latest version of Emacs can be downloaded using CVS or Arch from
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
58 the Savannah web site. It is important to write your patch based on
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
59 this version; if you start from an older version, your patch may be
84844
a80ba7633360 Fix typo and line break.
Glenn Morris <rgm@gnu.org>
parents: 84828
diff changeset
60 outdated when you write it, and maintainers will have a hard time
84410
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
61 applying it.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
62
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
63 After you have downloaded the CVS source, you should read the file
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
64 INSTALL.CVS for build instructions (they differ to some extent from a
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
65 normal build).
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
66
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
67 Ref: http://savannah.gnu.org/projects/emacs
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
68
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
69
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
70 * Submitting Patches
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
71
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
72 Every patch must have several pieces of information before we
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
73 can properly evaluate it.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
74
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
75 When you have all these pieces, bundle them up in a mail message and
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
76 send it to emacs-pretest-bug@gnu.org or emacs-devel@gnu.org.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
77
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
78 All subsequent discussion should also be sent to the mailing list.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
79
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
80 ** Description
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
81
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
82 For bug fixes, a description of the bug and how your patch fixes this
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
83 bug.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
84
84844
a80ba7633360 Fix typo and line break.
Glenn Morris <rgm@gnu.org>
parents: 84828
diff changeset
85 For new features, a description of the feature and your implementation.
84410
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
86
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
87 ** ChangeLog
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
88
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
89 A ChangeLog entry as plaintext (separate from the patch).
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
90
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
91 See the various ChangeLog files for format and content. Note that,
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
92 unlike some other projects, we do require ChangeLogs also for
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
93 documentation, i.e. Texinfo files.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
94
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
95 Ref: "Change Log Concepts" node of the GNU Coding Standards Info
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
96 Manual, for how to write good log entries.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
97
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
98 ** The patch itself.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
99
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
100 Please use "Context Diff" format.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
101
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
102 If you are accessing the CVS repository use
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
103 cvs update; cvs diff -cp
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
104 else, use
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
105 diff -cp OLD NEW
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
106
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
107 If your version of diff does not support these options, then get the
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
108 latest version of GNU Diff.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
109
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
110 ** Mail format.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
111
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
112 We prefer to get the patches as inline plain text.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
113
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
114 Please be aware of line wrapping which will make the patch unreadable
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
115 and useless for us. To avoid that, you can use MIME attachments or,
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
116 as a last resort, uuencoded gzipped text.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
117
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
118 ** Please reread your patch before submitting it.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
119
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
120 ** Do not mix changes.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
121
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
122 If you send several unrelated changes together, we will ask you to
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
123 separate them so we can consider each of the changes by itself.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
124
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
125
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
126 * Coding style and conventions.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
127
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
128 ** Mandatory reading:
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
129
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
130 The "Tips and Conventions" Appendix of the Emacs Lisp Reference.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
131
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
132 ** Avoid using `defadvice' or `eval-after-load' for Lisp code to be
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
133 included in Emacs.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
134
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
135 ** Remove all trailing whitespace in all source and text files.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
136
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
137 ** Use ?\s instead of ? in Lisp code for a space character.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
138
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
139
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
140 * Supplemental information for Emacs Developers.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
141
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
142 ** Write access to Emacs' CVS repository.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
143
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
144 Once you become a frequent contributor to Emacs, we can consider
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
145 giving you write access to the CVS repository.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
146
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
147
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
148 ** Emacs Mailing lists.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
149
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
150 Discussion about Emacs development takes place on emacs-devel@gnu.org.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
151
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
152 Bug reports for released versions are sent to bug-gnu-emacs@gnu.org.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
153
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
154 Bug reports for development versions are sent to emacs-pretest-bug@gnu.org.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
155
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
156 You can subscribe to the mailing lists at savannah.gnu.org/projects/emacs.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
157
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
158 You can find the mailing lists archives at lists.gnu.org or gmane.org.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
159
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
160
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
161 ** Document your changes.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
162
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
163 Think carefully about whether your change requires updating the
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
164 documentation. If it does, you can either do this yourself or add an
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
165 item to the NEWS file.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
166
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
167 If you document your change in NEWS, please mark the NEWS entry with
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
168 the documentation status of the change: if you submit the changes for
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
169 the manuals, mark it with "+++"; if it doesn't need to be documented,
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
170 mark it with "---"; if it needs to be documented, but you didn't
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
171 submit documentation changes, leave the NEWS entry unmarked. (These
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
172 marks are checked by the Emacs maintainers to make sure every change
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
173 was reflected in the manuals.)
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
174
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
175
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
176 ** Understanding Emacs Internals.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
177
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
178 The best way to understand Emacs Internals is to read the code,
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
179 but the nodes "Tips" and "GNU Emacs Internals" in the Appendix
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
180 of the Emacs Lisp Reference Manual may also help.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
181
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
182 The file etc/DEBUG describes how to debug Emacs bugs.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
183
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
184
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
185
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
186 This file is part of GNU Emacs.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
187
95004
cbf5528cf447 Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 87649
diff changeset
188 GNU Emacs is free software: you can redistribute it and/or modify
84410
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
189 it under the terms of the GNU General Public License as published by
95004
cbf5528cf447 Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 87649
diff changeset
190 the Free Software Foundation, either version 3 of the License, or
cbf5528cf447 Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 87649
diff changeset
191 (at your option) any later version.
84410
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
192
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
193 GNU Emacs is distributed in the hope that it will be useful,
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
194 but WITHOUT ANY WARRANTY; without even the implied warranty of
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
195 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
196 GNU General Public License for more details.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
197
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
198 You should have received a copy of the GNU General Public License
95004
cbf5528cf447 Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 87649
diff changeset
199 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
84410
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
200
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
201 Local variables:
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
202 mode: outline
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
203 paragraph-separate: "[ ]*$"
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
204 end:
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
205