annotate CONTRIBUTE @ 80009:e3aefab00216

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