annotate CONTRIBUTE @ 90524:b7bcc590bab5

(ftfont_list): Fix typo. (ftfont_build_basic_charsets): Don't include letters with diactrics.
author Kenichi Handa <handa@m17n.org>
date Fri, 07 Jul 2006 11:48:40 +0000
parents fc0f241e3ff8
children 2abae690629b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
71604
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
1
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
2 Contributing to Emacs
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
3
71619
fc0f241e3ff8 Much rewrite.
Richard M. Stallman <rms@gnu.org>
parents: 71608
diff changeset
4 Emacs is a collaborative project and we encourage contributions from
fc0f241e3ff8 Much rewrite.
Richard M. Stallman <rms@gnu.org>
parents: 71608
diff changeset
5 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
6 help us most, we recommend (1) fixing reported bugs and (2)
fc0f241e3ff8 Much rewrite.
Richard M. Stallman <rms@gnu.org>
parents: 71608
diff changeset
7 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
8 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
9 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
10 platform, but that is not common nowadays.
fc0f241e3ff8 Much rewrite.
Richard M. Stallman <rms@gnu.org>
parents: 71608
diff changeset
11
fc0f241e3ff8 Much rewrite.
Richard M. Stallman <rms@gnu.org>
parents: 71608
diff changeset
12 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
13 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
14 distribution). The web pages in http://www.gnu.org/software/emacs
fc0f241e3ff8 Much rewrite.
Richard M. Stallman <rms@gnu.org>
parents: 71608
diff changeset
15 contain additional information.
71604
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
16
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
17 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
18 inclusion in a future version of Emacs (see below).
71604
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
19
71619
fc0f241e3ff8 Much rewrite.
Richard M. Stallman <rms@gnu.org>
parents: 71608
diff changeset
20 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
21 help. You can answer questions on the mailing lists, write
fc0f241e3ff8 Much rewrite.
Richard M. Stallman <rms@gnu.org>
parents: 71608
diff changeset
22 documentation, find and report bugs, contribute to the Emacs web
fc0f241e3ff8 Much rewrite.
Richard M. Stallman <rms@gnu.org>
parents: 71608
diff changeset
23 pages, or develop a package that works with Emacs.
71604
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
24
71619
fc0f241e3ff8 Much rewrite.
Richard M. Stallman <rms@gnu.org>
parents: 71608
diff changeset
25 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
26
71604
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
27
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
28 o Coding Standards
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
29
71619
fc0f241e3ff8 Much rewrite.
Richard M. Stallman <rms@gnu.org>
parents: 71608
diff changeset
30 Contributed code should follow the GNU Coding Standard.
fc0f241e3ff8 Much rewrite.
Richard M. Stallman <rms@gnu.org>
parents: 71608
diff changeset
31 If it doesn't, we'll need to find someone to fix the code
fc0f241e3ff8 Much rewrite.
Richard M. Stallman <rms@gnu.org>
parents: 71608
diff changeset
32 before we can use it.
71604
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
33
71619
fc0f241e3ff8 Much rewrite.
Richard M. Stallman <rms@gnu.org>
parents: 71608
diff changeset
34 Emacs has certain additional style and coding conventions.
71604
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
35
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
36 Ref: http://www.gnu.org/prep/standards_toc.html
71608
e4b43205e213 *** empty log message ***
Nick Roberts <nickrob@snap.net.nz>
parents: 71604
diff changeset
37 Ref: Standards Info Manual
71604
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
38
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
39
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
40 o Copyright Assignment
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
41
71619
fc0f241e3ff8 Much rewrite.
Richard M. Stallman <rms@gnu.org>
parents: 71608
diff changeset
42 We can accept small changes without legal papers, and for
fc0f241e3ff8 Much rewrite.
Richard M. Stallman <rms@gnu.org>
parents: 71608
diff changeset
43 medium-size changes a copyright disclaimer is ok too. Toa
fc0f241e3ff8 Much rewrite.
Richard M. Stallman <rms@gnu.org>
parents: 71608
diff changeset
44 accept substantial contributions from you, we need a copyright
fc0f241e3ff8 Much rewrite.
Richard M. Stallman <rms@gnu.org>
parents: 71608
diff changeset
45 assignment form filled out and filed with the FSF.
71604
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
46
71619
fc0f241e3ff8 Much rewrite.
Richard M. Stallman <rms@gnu.org>
parents: 71608
diff changeset
47 Contact us at emacs-devel@gnu.org to obtain the relevant
71604
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
48 forms.
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
49
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
50
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
51 o Getting the Source Code
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
52
71619
fc0f241e3ff8 Much rewrite.
Richard M. Stallman <rms@gnu.org>
parents: 71608
diff changeset
53 The latest version of Emacs can be downloaded using CVS or
fc0f241e3ff8 Much rewrite.
Richard M. Stallman <rms@gnu.org>
parents: 71608
diff changeset
54 Arch from the Savannah web site. It is important to write
fc0f241e3ff8 Much rewrite.
Richard M. Stallman <rms@gnu.org>
parents: 71608
diff changeset
55 your patch based this version; if you start from an older
fc0f241e3ff8 Much rewrite.
Richard M. Stallman <rms@gnu.org>
parents: 71608
diff changeset
56 version, your patch may be outdated when you write it.
71604
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
57
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
58 Ref: http://savannah.gnu.org/projects/emacs
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
59
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
60
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
61 o Submitting Patches
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
62
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
63 Every patch must have several pieces of information before we
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
64 can properly evaluate it.
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
65
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
66 For bug fixes, a description of the bug and how your patch fixes
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
67 this bug.
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 For new features, a description of the feature and your
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
70 implementation.
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
71
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
72 A ChangeLog entry as plaintext (separate from the patch); see
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
73 the various ChangeLog files for format and content. Note that,
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
74 unlike some other projects, we do require ChangeLogs also for
71608
e4b43205e213 *** empty log message ***
Nick Roberts <nickrob@snap.net.nz>
parents: 71604
diff changeset
75 documentation i.e. texinfo files.
e4b43205e213 *** empty log message ***
Nick Roberts <nickrob@snap.net.nz>
parents: 71604
diff changeset
76
e4b43205e213 *** empty log message ***
Nick Roberts <nickrob@snap.net.nz>
parents: 71604
diff changeset
77 Ref: Change Log Concepts node of the Standards Info Manual
71604
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
78
71608
e4b43205e213 *** empty log message ***
Nick Roberts <nickrob@snap.net.nz>
parents: 71604
diff changeset
79 The patch itself. If you are accessing the CVS repository use
e4b43205e213 *** empty log message ***
Nick Roberts <nickrob@snap.net.nz>
parents: 71604
diff changeset
80 "cvs update; cvs diff -cp"; else, use "diff -cp OLD NEW". If
e4b43205e213 *** empty log message ***
Nick Roberts <nickrob@snap.net.nz>
parents: 71604
diff changeset
81 your version of diff does not support these options, then get
e4b43205e213 *** empty log message ***
Nick Roberts <nickrob@snap.net.nz>
parents: 71604
diff changeset
82 the latest version of GNU diff.
71604
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
83
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
84 We accept patches as plain text (preferred for the compilers
71608
e4b43205e213 *** empty log message ***
Nick Roberts <nickrob@snap.net.nz>
parents: 71604
diff changeset
85 themselves), MIME attachments (preferred for the web pages), or
e4b43205e213 *** empty log message ***
Nick Roberts <nickrob@snap.net.nz>
parents: 71604
diff changeset
86 as uuencoded gzipped text.
71604
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
87
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
88 When you have all these pieces, bundle them up in a mail message
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
89 and send it to emacs-pretest-bug@gnu.org or emacs-devel@gnu.org.
71608
e4b43205e213 *** empty log message ***
Nick Roberts <nickrob@snap.net.nz>
parents: 71604
diff changeset
90 All subsequent discussion should also be sent to the mailing
e4b43205e213 *** empty log message ***
Nick Roberts <nickrob@snap.net.nz>
parents: 71604
diff changeset
91 list.
71604
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
92
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
93
71619
fc0f241e3ff8 Much rewrite.
Richard M. Stallman <rms@gnu.org>
parents: 71608
diff changeset
94 o Please reread your patch before submitting it.
fc0f241e3ff8 Much rewrite.
Richard M. Stallman <rms@gnu.org>
parents: 71608
diff changeset
95
71604
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
96
71619
fc0f241e3ff8 Much rewrite.
Richard M. Stallman <rms@gnu.org>
parents: 71608
diff changeset
97 o If you send several unrelated changes together, we will
fc0f241e3ff8 Much rewrite.
Richard M. Stallman <rms@gnu.org>
parents: 71608
diff changeset
98 ask you to separate them so we can consider each of the changes
fc0f241e3ff8 Much rewrite.
Richard M. Stallman <rms@gnu.org>
parents: 71608
diff changeset
99 by itself.
71604
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
100
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
101
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
102 o Supplemental information for Emacs Developers:
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
103
71619
fc0f241e3ff8 Much rewrite.
Richard M. Stallman <rms@gnu.org>
parents: 71608
diff changeset
104 Once you become a frequent contributor to Emacs, we can
fc0f241e3ff8 Much rewrite.
Richard M. Stallman <rms@gnu.org>
parents: 71608
diff changeset
105 consider giving you write access to the CVS repository.
71604
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
106
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
107 Discussion about Emacs development takes place on
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
108 emacs-devel@gnu.org.
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
109
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
110 Think carefully about whether your change requires updating the
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
111 documentation. If it does, you can either do this yourself or
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
112 add an item to the NEWS file.
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
113
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
114 The best way to understand Emacs Internals is to read the code
71608
e4b43205e213 *** empty log message ***
Nick Roberts <nickrob@snap.net.nz>
parents: 71604
diff changeset
115 but the nodes "Tips" and "GNU Emacs Internals" in the Appendix
e4b43205e213 *** empty log message ***
Nick Roberts <nickrob@snap.net.nz>
parents: 71604
diff changeset
116 of the Emacs Lisp Reference Manual may also help.
71604
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
117
71619
fc0f241e3ff8 Much rewrite.
Richard M. Stallman <rms@gnu.org>
parents: 71608
diff changeset
118 The file DEBUG describes how to debug Emacs bugs.
71604
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
119
71619
fc0f241e3ff8 Much rewrite.
Richard M. Stallman <rms@gnu.org>
parents: 71608
diff changeset
120 Avoid using `defadvice' or `eval-after-load' for Lisp
71604
801b0f932405 New file.
Nick Roberts <nickrob@snap.net.nz>
parents:
diff changeset
121 code to be included in Emacs.