Mercurial > emacs
annotate admin/notes/newfile @ 111873:2e087a5593f8
* make-dist: Exclude etc/*.pyc.
author | Glenn Morris <rgm@gnu.org> |
---|---|
date | Fri, 10 Dec 2010 18:30:29 -0800 |
parents | 43f8ac6763d9 |
children |
rev | line source |
---|---|
104341
f25cba6d7938
Checklist for adding new files to Emacs.
Glenn Morris <rgm@gnu.org>
parents:
diff
changeset
|
1 CHECKLIST FOR ADDING A NEW FILE TO EMACS -*- outline -*- |
f25cba6d7938
Checklist for adding new files to Emacs.
Glenn Morris <rgm@gnu.org>
parents:
diff
changeset
|
2 |
f25cba6d7938
Checklist for adding new files to Emacs.
Glenn Morris <rgm@gnu.org>
parents:
diff
changeset
|
3 ** Make sure the author(s) have a copyright assignment/disclaimer. |
f25cba6d7938
Checklist for adding new files to Emacs.
Glenn Morris <rgm@gnu.org>
parents:
diff
changeset
|
4 |
f25cba6d7938
Checklist for adding new files to Emacs.
Glenn Morris <rgm@gnu.org>
parents:
diff
changeset
|
5 ** Make sure the file matches the standard Emacs template (header |
f25cba6d7938
Checklist for adding new files to Emacs.
Glenn Morris <rgm@gnu.org>
parents:
diff
changeset
|
6 format, copyright and license notice, etc). |
f25cba6d7938
Checklist for adding new files to Emacs.
Glenn Morris <rgm@gnu.org>
parents:
diff
changeset
|
7 |
f25cba6d7938
Checklist for adding new files to Emacs.
Glenn Morris <rgm@gnu.org>
parents:
diff
changeset
|
8 ** Make sure the filename does not cause the DOS port any problems (8+3). |
104527
f03eb2311295
Details of how to check for problems with DOS 8+3 file-name restrictions.
Eli Zaretskii <eliz@gnu.org>
parents:
104341
diff
changeset
|
9 Run the `doschk' program like this: |
f03eb2311295
Details of how to check for problems with DOS 8+3 file-name restrictions.
Eli Zaretskii <eliz@gnu.org>
parents:
104341
diff
changeset
|
10 |
104585 | 11 find /path/to/emacs -print | doschk |
104527
f03eb2311295
Details of how to check for problems with DOS 8+3 file-name restrictions.
Eli Zaretskii <eliz@gnu.org>
parents:
104341
diff
changeset
|
12 |
f03eb2311295
Details of how to check for problems with DOS 8+3 file-name restrictions.
Eli Zaretskii <eliz@gnu.org>
parents:
104341
diff
changeset
|
13 and examine the output for DOS-related problems. The sections of |
f03eb2311295
Details of how to check for problems with DOS 8+3 file-name restrictions.
Eli Zaretskii <eliz@gnu.org>
parents:
104341
diff
changeset
|
14 output under the headings "The following files are not valid DOS file |
f03eb2311295
Details of how to check for problems with DOS 8+3 file-name restrictions.
Eli Zaretskii <eliz@gnu.org>
parents:
104341
diff
changeset
|
15 names:" and "The following resolve to the same DOS file names:" should |
f03eb2311295
Details of how to check for problems with DOS 8+3 file-name restrictions.
Eli Zaretskii <eliz@gnu.org>
parents:
104341
diff
changeset
|
16 not include any files that end up in the release tarball. |
104341
f25cba6d7938
Checklist for adding new files to Emacs.
Glenn Morris <rgm@gnu.org>
parents:
diff
changeset
|
17 |
f25cba6d7938
Checklist for adding new files to Emacs.
Glenn Morris <rgm@gnu.org>
parents:
diff
changeset
|
18 ** Make the ChangeLog entry in the name of the author(s), not your own name. |
f25cba6d7938
Checklist for adding new files to Emacs.
Glenn Morris <rgm@gnu.org>
parents:
diff
changeset
|
19 |
f25cba6d7938
Checklist for adding new files to Emacs.
Glenn Morris <rgm@gnu.org>
parents:
diff
changeset
|
20 ** If appropriate, check that the file compiles OK and that Emacs |
f25cba6d7938
Checklist for adding new files to Emacs.
Glenn Morris <rgm@gnu.org>
parents:
diff
changeset
|
21 builds fine with it. Address any compilation warnings. |
f25cba6d7938
Checklist for adding new files to Emacs.
Glenn Morris <rgm@gnu.org>
parents:
diff
changeset
|
22 |
f25cba6d7938
Checklist for adding new files to Emacs.
Glenn Morris <rgm@gnu.org>
parents:
diff
changeset
|
23 ** If a major contribution, consider adding an entry to the |
f25cba6d7938
Checklist for adding new files to Emacs.
Glenn Morris <rgm@gnu.org>
parents:
diff
changeset
|
24 Acknowledgments in doc/emacs/emacs.texi and ack.texi. |
f25cba6d7938
Checklist for adding new files to Emacs.
Glenn Morris <rgm@gnu.org>
parents:
diff
changeset
|
25 |
f25cba6d7938
Checklist for adding new files to Emacs.
Glenn Morris <rgm@gnu.org>
parents:
diff
changeset
|
26 ** If appropriate, add a short NEWS entry. |
f25cba6d7938
Checklist for adding new files to Emacs.
Glenn Morris <rgm@gnu.org>
parents:
diff
changeset
|
27 |
f25cba6d7938
Checklist for adding new files to Emacs.
Glenn Morris <rgm@gnu.org>
parents:
diff
changeset
|
28 ** If appropriate, update make-dist (not needed with "standard" file |
f25cba6d7938
Checklist for adding new files to Emacs.
Glenn Morris <rgm@gnu.org>
parents:
diff
changeset
|
29 names, eg *.el). |