annotate etc/CONTRIBUTE @ 110410:f2e111723c3a

Merge changes made in Gnus trunk. Reimplement nnimap, and do tweaks to the rest of the code to support that. * gnus-int.el (gnus-finish-retrieve-group-infos) (gnus-retrieve-group-data-early): New functions. * gnus-range.el (gnus-range-nconcat): New function. * gnus-start.el (gnus-get-unread-articles): Support early retrieval of data. (gnus-read-active-for-groups): Support finishing the early retrieval of data. * gnus-sum.el (gnus-summary-move-article): Pass the move-to group name if the move is internal, so that nnimap can do fast internal moves. * gnus.el (gnus-article-special-mark-lists): Add uid/active tuples, for nnimap usage. * nnimap.el: Rewritten. * nnmail.el (nnmail-inhibit-default-split-group): New internal variable to allow the mail splitting to not return a default group. This is useful for nnimap, which will leave unmatched mail in the inbox. * utf7.el (utf7-encode): Autoload. Implement shell connection. * nnimap.el (nnimap-open-shell-stream): New function. (nnimap-open-connection): Use it. Get the number of lines by using BODYSTRUCTURE. (nnimap-transform-headers): Get the number of lines in each message. (nnimap-retrieve-headers): Query for BODYSTRUCTURE so that we get the number of lines. Not all servers return UIDNEXT. Work past this problem. Remove junk from end of file. Fix typo in "bogus" section. Make capabilties be case-insensitive. Require cl when compiling. Don't bug out if the LIST command doesn't have any parameters. 2010-09-17 Knut Anders Hatlen <kahatlen@gmail.com> (tiny change) * nnimap.el (nnimap-get-groups): Don't bug out if the LIST command doesn't have any parameters. (mm-text-html-renderer): Document gnus-article-html. 2010-09-17 Julien Danjou <julien@danjou.info> (tiny fix) * mm-decode.el (mm-text-html-renderer): Document gnus-article-html. * dgnushack.el: Define netrc-credentials. If the user doesn't have a /etc/services, supply some sensible port defaults. Have `unseen-or-unread' select an unread unseen article first. (nntp-open-server): Return whether the open was successful or not. Throughout all files, replace (save-excursion (set-buffer ...)) with (with-current-buffer ... ). Save result so that it doesn't say "failed" all the time. Add ~/.authinfo to the default, since that's probably most useful for users. Don't use the "finish" method when we're reading from the agent. Add some more nnimap-relevant agent stuff to nnagent.el. * nnimap.el (nnimap-with-process-buffer): Removed. Revert one line that was changed by mistake in the last checkin. (nnimap-open-connection): Don't error out when we can't make a connection nnimap-related changes to avoid bugging out if we can't contact a server. * gnus-start.el (gnus-get-unread-articles): Don't try to scan groups from methods that are denied. * nnimap.el (nnimap-possibly-change-group): Return nil if we can't log in. (nnimap-finish-retrieve-group-infos): Make sure we're not waiting for nothing. * gnus-sum.el (gnus-select-newsgroup): Indent.
author Katsumi Yamaoka <yamaoka@jpl.org>
date Sat, 18 Sep 2010 10:02:19 +0000
parents 7f1976431211
children 376148b31b5e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
107178
7f1976431211 CONTRIBUTE: Various minor updates and changes.
Glenn Morris <rgm@gnu.org>
parents: 106802
diff changeset
1 Copyright (C) 2006, 2007, 2008, 2009, 2010
7f1976431211 CONTRIBUTE: Various minor updates and changes.
Glenn Morris <rgm@gnu.org>
parents: 106802
diff changeset
2 Free Software Foundation, Inc.
84410
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
3 See end for license conditions.
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
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
6 Contributing to Emacs
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
7
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
8 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
9 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
10 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
11 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
12 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
13 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
14 platform, but that is not common nowadays.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
15
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
16 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
17 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
18 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
19 contain additional information.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
20
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
21 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
22 inclusion in a future version of Emacs (see below).
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
23
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
24 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
25 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
26 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
27 pages, or develop a package that works with Emacs.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
28
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
29 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
30
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
31
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
32 * Coding Standards
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
33
107178
7f1976431211 CONTRIBUTE: Various minor updates and changes.
Glenn Morris <rgm@gnu.org>
parents: 106802
diff changeset
34 Contributed code should follow the GNU Coding Standards.
84410
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
35
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
36 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
37 can use it.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
38
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
39 Emacs has certain additional style and coding conventions.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
40
106592
d04aeb2c3beb (Coding Standards): Update URL.
Glenn Morris <rgm@gnu.org>
parents: 100972
diff changeset
41 Ref: http://www.gnu.org/prep/standards/
84410
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
42 Ref: GNU Coding Standards Info Manual
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
43 Ref: The "Tips" Appendix in the Emacs Lisp Reference.
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
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
46 * Copyright Assignment
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
47
107178
7f1976431211 CONTRIBUTE: Various minor updates and changes.
Glenn Morris <rgm@gnu.org>
parents: 106802
diff changeset
48 We can accept small changes (roughly, fewer than 15 lines) without
7f1976431211 CONTRIBUTE: Various minor updates and changes.
Glenn Morris <rgm@gnu.org>
parents: 106802
diff changeset
49 legal papers. Anything more substantial requires a copyright
7f1976431211 CONTRIBUTE: Various minor updates and changes.
Glenn Morris <rgm@gnu.org>
parents: 106802
diff changeset
50 disclaimer or assignment (the latter is preferred, especially for
7f1976431211 CONTRIBUTE: Various minor updates and changes.
Glenn Morris <rgm@gnu.org>
parents: 106802
diff changeset
51 larger changes). Both of these involved filling out a short form and
7f1976431211 CONTRIBUTE: Various minor updates and changes.
Glenn Morris <rgm@gnu.org>
parents: 106802
diff changeset
52 filing it with the FSF. The process is straightforward -- contact us
7f1976431211 CONTRIBUTE: Various minor updates and changes.
Glenn Morris <rgm@gnu.org>
parents: 106802
diff changeset
53 at emacs-devel@gnu.org to obtain the relevant forms.
84410
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
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
56 * Getting the Source Code
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
57
107178
7f1976431211 CONTRIBUTE: Various minor updates and changes.
Glenn Morris <rgm@gnu.org>
parents: 106802
diff changeset
58 The latest version of Emacs can be downloaded using Bazaar from the
7f1976431211 CONTRIBUTE: Various minor updates and changes.
Glenn Morris <rgm@gnu.org>
parents: 106802
diff changeset
59 Savannah web site. It is important to write your patch based on the
7f1976431211 CONTRIBUTE: Various minor updates and changes.
Glenn Morris <rgm@gnu.org>
parents: 106802
diff changeset
60 latest version. If you start from an older version, your patch may be
7f1976431211 CONTRIBUTE: Various minor updates and changes.
Glenn Morris <rgm@gnu.org>
parents: 106802
diff changeset
61 outdated (so that maintainers will have a hard time applying it), or
7f1976431211 CONTRIBUTE: Various minor updates and changes.
Glenn Morris <rgm@gnu.org>
parents: 106802
diff changeset
62 changes in Emacs may have made your patch unnecessary.
84410
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
63
107178
7f1976431211 CONTRIBUTE: Various minor updates and changes.
Glenn Morris <rgm@gnu.org>
parents: 106802
diff changeset
64 After you have downloaded the Bazaar source, you should read the file
7f1976431211 CONTRIBUTE: Various minor updates and changes.
Glenn Morris <rgm@gnu.org>
parents: 106802
diff changeset
65 INSTALL.BZR for build instructions (they differ to some extent from a
84410
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
66 normal build).
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
67
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
68 Ref: http://savannah.gnu.org/projects/emacs
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
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
71 * Submitting Patches
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
72
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
73 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
74 can properly evaluate it.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
75
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
76 When you have all these pieces, bundle them up in a mail message and
106802
b92c3979701c Replace emacs-pretest-bug with bug-gnu-emacs mailing list.
Glenn Morris <rgm@gnu.org>
parents: 106592
diff changeset
77 send it to bug-gnu-emacs@gnu.org or emacs-devel@gnu.org.
84410
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
78
107178
7f1976431211 CONTRIBUTE: Various minor updates and changes.
Glenn Morris <rgm@gnu.org>
parents: 106802
diff changeset
79 All subsequent discussion should be sent to the same mailing list.
84410
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
80
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
81 ** Description
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
82
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
83 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
84 bug.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
85
84844
a80ba7633360 Fix typo and line break.
Glenn Morris <rgm@gnu.org>
parents: 84828
diff changeset
86 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
87
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
88 ** ChangeLog
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
89
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
90 A ChangeLog entry as plaintext (separate from the patch).
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
91
107178
7f1976431211 CONTRIBUTE: Various minor updates and changes.
Glenn Morris <rgm@gnu.org>
parents: 106802
diff changeset
92 See the various ChangeLog files for format and content. Note that,
84410
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
93 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
94 documentation, i.e. Texinfo files.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
95
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
96 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
97 Manual, for how to write good log entries.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
98
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
99 ** The patch itself.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
100
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
101 Please use "Context Diff" format.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
102
107178
7f1976431211 CONTRIBUTE: Various minor updates and changes.
Glenn Morris <rgm@gnu.org>
parents: 106802
diff changeset
103 If you are accessing the Bazaar repository, make sure your copy is
7f1976431211 CONTRIBUTE: Various minor updates and changes.
Glenn Morris <rgm@gnu.org>
parents: 106802
diff changeset
104 up-to-date (e.g. with `bzr pull'), then use
7f1976431211 CONTRIBUTE: Various minor updates and changes.
Glenn Morris <rgm@gnu.org>
parents: 106802
diff changeset
105 bzr diff --no-aliases --diff-options=-cp
7f1976431211 CONTRIBUTE: Various minor updates and changes.
Glenn Morris <rgm@gnu.org>
parents: 106802
diff changeset
106 Else, use
84410
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
107 diff -cp OLD NEW
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
108
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
109 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
110 latest version of GNU Diff.
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 ** Mail format.
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 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
115
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
116 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
117 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
118 as a last resort, uuencoded gzipped text.
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 ** Please reread your patch before submitting it.
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 ** Do not mix changes.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
123
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
124 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
125 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
126
107178
7f1976431211 CONTRIBUTE: Various minor updates and changes.
Glenn Morris <rgm@gnu.org>
parents: 106802
diff changeset
127 ** Do not make formatting changes.
7f1976431211 CONTRIBUTE: Various minor updates and changes.
Glenn Morris <rgm@gnu.org>
parents: 106802
diff changeset
128
7f1976431211 CONTRIBUTE: Various minor updates and changes.
Glenn Morris <rgm@gnu.org>
parents: 106802
diff changeset
129 Making cosmetic formatting changes (indentation, etc) makes it harder
7f1976431211 CONTRIBUTE: Various minor updates and changes.
Glenn Morris <rgm@gnu.org>
parents: 106802
diff changeset
130 to see what you have really changed.
7f1976431211 CONTRIBUTE: Various minor updates and changes.
Glenn Morris <rgm@gnu.org>
parents: 106802
diff changeset
131
84410
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
132
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
133 * Coding style and conventions.
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 ** Mandatory reading:
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 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
138
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
139 ** 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
140 included in Emacs.
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 ** 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
143
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
144 ** 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
145
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 * Supplemental information for Emacs Developers.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
148
107178
7f1976431211 CONTRIBUTE: Various minor updates and changes.
Glenn Morris <rgm@gnu.org>
parents: 106802
diff changeset
149 ** Write access to the Emacs repository.
84410
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
150
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
151 Once you become a frequent contributor to Emacs, we can consider
107178
7f1976431211 CONTRIBUTE: Various minor updates and changes.
Glenn Morris <rgm@gnu.org>
parents: 106802
diff changeset
152 giving you write access to the Bazaar repository.
84410
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
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
155 ** Emacs Mailing lists.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
156
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
157 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
158
107178
7f1976431211 CONTRIBUTE: Various minor updates and changes.
Glenn Morris <rgm@gnu.org>
parents: 106802
diff changeset
159 Bug reports and feature requests are sent to bug-gnu-emacs@gnu.org.
84410
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 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
162
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
163 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
164
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
165
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
166 ** Document your changes.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
167
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
168 Think carefully about whether your change requires updating the
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
169 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
170 item to the NEWS file.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
171
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
172 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
173 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
174 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
175 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
176 submit documentation changes, leave the NEWS entry unmarked. (These
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
177 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
178 was reflected in the manuals.)
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
179
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
180
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
181 ** Understanding Emacs Internals.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
182
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
183 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
184 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
185 of the Emacs Lisp Reference Manual may also help.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
186
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
187 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
188
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
189
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
190
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
191 This file is part of GNU Emacs.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
192
95004
cbf5528cf447 Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 87649
diff changeset
193 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
194 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
195 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
196 (at your option) any later version.
84410
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 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
199 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
200 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
201 GNU General Public License for more details.
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
202
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
203 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
204 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
205
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
206 Local variables:
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
207 mode: outline
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
208 paragraph-separate: "[ ]*$"
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
209 end:
07e464d63e3b Move here from the root dir.
Juri Linkov <juri@jurta.org>
parents:
diff changeset
210