Mercurial > emacs
annotate etc/CONTRIBUTE @ 108750:3339da3cfeb3
Redesign bidi-aware edge positions of glyph rows, fix bug #6036.
dispextern.h (struct glyph_row): New members minpos and maxpos.
(MATRIX_ROW_START_CHARPOS, MATRIX_ROW_START_BYTEPOS)
(MATRIX_ROW_END_CHARPOS, MATRIX_ROW_END_BYTEPOS): Reference minpos
and maxpos members instead of start.pos and end.pos, respectively.
xdisp.c (display_line): Compare IT_CHARPOS with the position in
row->start.pos, rather than with MATRIX_ROW_START_CHARPOS.
(cursor_row_p): Use row->end.pos rather than MATRIX_ROW_END_CHARPOS.
(try_window_reusing_current_matrix, try_window_id): Use
ROW->minpos rather than ROW->start.pos.
(init_from_display_pos, init_iterator): Use EMACS_INT for
character and byte positions.
(find_row_edges): Renamed from find_row_end. Accept additional
arguments for minimum and maximum buffer positions seen by
display_line for this row. Don't use iterator to find the
position following the maximum one; instead, increment the
position found by display_line directly. Fix logic; eol_pos
should be tested before the rest. Handle the case of characters
delivered from display vector (bug#6036). Fix tests related to
it->method. Handle the truncated_on_right_p rows.
(RECORD_MAX_MIN_POS): New macro.
(display_line): Use it to record the minimum and maximum buffer
positions for glyphs in the row being assembled. Record the
position of the newline that terminates the line. If word wrap is
in effect, restore minimum and maximum positions seen up to the
wrap point, when iterator returns to it.
(try_window_reusing_current_matrix): Give up if in bidi-reordered
row and cursor not already at point. Restore original pre-bidi
code for unidirectional buffers.
dispnew.c (increment_row_positions, check_matrix_invariants):
Increment and check row->start.pos and row->end.pos, in addition
to MATRIX_ROW_START_CHARPOS and MATRIX_ROW_END_CHARPOS.
.gdbinit (prowlims): Display row->minpos and row->maxpos.
Display truncated_on_left_p and truncated_on_right_p flags.
Formatting fixes.
(pmtxrows): Display the ordinal number of each row. Don't display
rows beyond the last one.
bidi.c (bidi_cache_iterator_state): Don't zero out new_paragraph:
it is not copied by bidi_copy_it.
author | Eli Zaretskii <eliz@gnu.org> |
---|---|
date | Sat, 22 May 2010 22:32:21 +0300 |
parents | 7f1976431211 |
children | 376148b31b5e |
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 | 3 See end for license conditions. |
4 | |
5 | |
6 Contributing to Emacs | |
7 | |
8 Emacs is a collaborative project and we encourage contributions from | |
9 anyone and everyone. If you want to contribute in the way that will | |
10 help us most, we recommend (1) fixing reported bugs and (2) | |
11 implementing the feature ideas in etc/TODO. However, if you think of | |
12 new features to add, please suggest them too -- we might like your | |
13 idea. Porting to new platforms is also useful, when there is a new | |
14 platform, but that is not common nowadays. | |
15 | |
16 For documentation on how to develop Emacs changes, refer to the Emacs | |
17 Manual and the Emacs Lisp Reference Manual (both included in the Emacs | |
18 distribution). The web pages in http://www.gnu.org/software/emacs | |
19 contain additional information. | |
20 | |
21 You may also want to submit your change so that can be considered for | |
22 inclusion in a future version of Emacs (see below). | |
23 | |
24 If you don't feel up to hacking Emacs, there are many other ways to | |
25 help. You can answer questions on the mailing lists, write | |
26 documentation, find and report bugs, contribute to the Emacs web | |
27 pages, or develop a package that works with Emacs. | |
28 | |
29 Here are some style and legal conventions for contributors to Emacs: | |
30 | |
31 | |
32 * Coding Standards | |
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 | 35 |
36 If it doesn't, we'll need to find someone to fix the code before we | |
37 can use it. | |
38 | |
39 Emacs has certain additional style and coding conventions. | |
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 | 42 Ref: GNU Coding Standards Info Manual |
43 Ref: The "Tips" Appendix in the Emacs Lisp Reference. | |
44 | |
45 | |
46 * Copyright Assignment | |
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 | 54 |
55 | |
56 * Getting the Source Code | |
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 | 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 | 66 normal build). |
67 | |
68 Ref: http://savannah.gnu.org/projects/emacs | |
69 | |
70 | |
71 * Submitting Patches | |
72 | |
73 Every patch must have several pieces of information before we | |
74 can properly evaluate it. | |
75 | |
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 | 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 | 80 |
81 ** Description | |
82 | |
83 For bug fixes, a description of the bug and how your patch fixes this | |
84 bug. | |
85 | |
84844 | 86 For new features, a description of the feature and your implementation. |
84410 | 87 |
88 ** ChangeLog | |
89 | |
90 A ChangeLog entry as plaintext (separate from the patch). | |
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 | 93 unlike some other projects, we do require ChangeLogs also for |
94 documentation, i.e. Texinfo files. | |
95 | |
96 Ref: "Change Log Concepts" node of the GNU Coding Standards Info | |
97 Manual, for how to write good log entries. | |
98 | |
99 ** The patch itself. | |
100 | |
101 Please use "Context Diff" format. | |
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 | 107 diff -cp OLD NEW |
108 | |
109 If your version of diff does not support these options, then get the | |
110 latest version of GNU Diff. | |
111 | |
112 ** Mail format. | |
113 | |
114 We prefer to get the patches as inline plain text. | |
115 | |
116 Please be aware of line wrapping which will make the patch unreadable | |
117 and useless for us. To avoid that, you can use MIME attachments or, | |
118 as a last resort, uuencoded gzipped text. | |
119 | |
120 ** Please reread your patch before submitting it. | |
121 | |
122 ** Do not mix changes. | |
123 | |
124 If you send several unrelated changes together, we will ask you to | |
125 separate them so we can consider each of the changes by itself. | |
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 | 132 |
133 * Coding style and conventions. | |
134 | |
135 ** Mandatory reading: | |
136 | |
137 The "Tips and Conventions" Appendix of the Emacs Lisp Reference. | |
138 | |
139 ** Avoid using `defadvice' or `eval-after-load' for Lisp code to be | |
140 included in Emacs. | |
141 | |
142 ** Remove all trailing whitespace in all source and text files. | |
143 | |
144 ** Use ?\s instead of ? in Lisp code for a space character. | |
145 | |
146 | |
147 * Supplemental information for Emacs Developers. | |
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 | 150 |
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 | 153 |
154 | |
155 ** Emacs Mailing lists. | |
156 | |
157 Discussion about Emacs development takes place on emacs-devel@gnu.org. | |
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 | 160 |
161 You can subscribe to the mailing lists at savannah.gnu.org/projects/emacs. | |
162 | |
163 You can find the mailing lists archives at lists.gnu.org or gmane.org. | |
164 | |
165 | |
166 ** Document your changes. | |
167 | |
168 Think carefully about whether your change requires updating the | |
169 documentation. If it does, you can either do this yourself or add an | |
170 item to the NEWS file. | |
171 | |
172 If you document your change in NEWS, please mark the NEWS entry with | |
173 the documentation status of the change: if you submit the changes for | |
174 the manuals, mark it with "+++"; if it doesn't need to be documented, | |
175 mark it with "---"; if it needs to be documented, but you didn't | |
176 submit documentation changes, leave the NEWS entry unmarked. (These | |
177 marks are checked by the Emacs maintainers to make sure every change | |
178 was reflected in the manuals.) | |
179 | |
180 | |
181 ** Understanding Emacs Internals. | |
182 | |
183 The best way to understand Emacs Internals is to read the code, | |
184 but the nodes "Tips" and "GNU Emacs Internals" in the Appendix | |
185 of the Emacs Lisp Reference Manual may also help. | |
186 | |
187 The file etc/DEBUG describes how to debug Emacs bugs. | |
188 | |
189 | |
190 | |
191 This file is part of GNU Emacs. | |
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 | 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 | 197 |
198 GNU Emacs is distributed in the hope that it will be useful, | |
199 but WITHOUT ANY WARRANTY; without even the implied warranty of | |
200 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
201 GNU General Public License for more details. | |
202 | |
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 | 205 |
206 Local variables: | |
207 mode: outline | |
208 paragraph-separate: "[ ]*$" | |
209 end: | |
210 |