mirror of
https://git.savannah.gnu.org/git/emacs.git
synced 2024-12-12 09:28:24 +00:00
cd2e816cd3
This is in preparation for generating the former automatically from the latter. * admin/notes/bugtracker, admin/notes/copyright, admin/notes/newfile: ChangeLog -> change log * admin/notes/changelogs: Remove, merging old contents to ... * admin/notes/repo: ... here. * doc/emacs/maintaining.texi (Change Log): Mention that ChangeLog files may be copied to or from a version control system. * doc/emacs/trouble.texi (Sending Patches): Point to the commit messages. * doc/lispref/intro.texi (Acknowledgments): ChangeLog file -> change log entries. * doc/lispref/tips.texi (Library Headers): Emacs uses a version control system. * etc/CONTRIBUTE: Give advice about git commit messages and how to generate proposed patches containing them.
30 lines
1.1 KiB
Plaintext
30 lines
1.1 KiB
Plaintext
CHECKLIST FOR ADDING A NEW FILE TO EMACS -*- outline -*-
|
|
|
|
** Make sure the author(s) have a copyright assignment/disclaimer.
|
|
|
|
** Make sure the file matches the standard Emacs template (header
|
|
format, copyright and license notice, etc).
|
|
|
|
** Make sure the filename does not cause the DOS port any problems (8+3).
|
|
Run the `doschk' program like this:
|
|
|
|
find /path/to/emacs -print | doschk
|
|
|
|
and examine the output for DOS-related problems. The sections of
|
|
output under the headings "The following files are not valid DOS file
|
|
names:" and "The following resolve to the same DOS file names:" should
|
|
not include any files that end up in the release tarball.
|
|
|
|
** Commit in the name of the author(s), not your own name.
|
|
|
|
** If appropriate, check that the file compiles OK and that Emacs
|
|
builds fine with it. Address any compilation warnings.
|
|
|
|
** If a major contribution, consider adding an entry to the
|
|
Acknowledgments in doc/emacs/emacs.texi and ack.texi.
|
|
|
|
** If appropriate, add a short NEWS entry.
|
|
|
|
** If appropriate, update make-dist (not needed with "standard" file
|
|
names, eg *.el).
|