Mercurial > emacs
annotate admin/notes/newfile @ 105445:01d333402a8c
* bookmark.el
(bookmark-get-bookmark, bookmark-get-bookmark-record,
bookmark-set-name, bookmark-prop-get, bookmark-prop-set,
bookmark-get-annotation, bookmark-set-annotation, bookmark-get-filename,
bookmark-set-filename, bookmark-get-position, bookmark-set-position,
bookmark-get-front-context-string, bookmark-set-front-context-string,
bookmark-get-rear-context-string, bookmark-set-rear-context-string,
bookmark-location, bookmark-jump, bookmark-jump-other-window,
bookmark-handle-bookmark, bookmark-relocate, bookmark-insert-location,
bookmark-rename, bookmark-insert, bookmark-delete, bookmark-time-to-save-p,
bookmark-edit-annotation-mode, bookmark-edit-annotation): Improve doc
strings to say whether bookmark can be a string or a record or both,
and make other consistency and clarity fixes.
(bookmark-get-handler, bookmark--jump-via, bookmark-write-file,
bookmark-default-annotation-text, bookmark-yank-word,
bookmark-maybe-load-default-file, bookmark-maybe-sort-alist,
bookmark-import-new-list, bookmark-maybe-rename,
bookmark-bmenu-show-filenames, bookmark-bmenu-hide-filenames,
bookmark-bmenu-bookmark): Give these doc strings.
(bookmark-bmenu-check-position): Give this a doc string, but also
add a FIXME comment about how the function may be pointless.
(bookmark-default-handler): Rework doc string and change a parameter
name, to clarify that this takes a bookmark record not a bookmark name.
(bookmark-set): Change a parameter name to indicate its meaning,
and improve the doc string a bit.
(Bug#4188)
author | Karl Fogel <kfogel@red-bean.com> |
---|---|
date | Mon, 05 Oct 2009 01:35:34 +0000 |
parents | dc1af63f6b73 |
children | 43f8ac6763d9 |
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, add an entry to lisp/Makefile.in ELCFILES. |
f25cba6d7938
Checklist for adding new files to Emacs.
Glenn Morris <rgm@gnu.org>
parents:
diff
changeset
|
21 |
f25cba6d7938
Checklist for adding new files to Emacs.
Glenn Morris <rgm@gnu.org>
parents:
diff
changeset
|
22 ** 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
|
23 builds fine with it. Address any compilation warnings. |
f25cba6d7938
Checklist for adding new files to Emacs.
Glenn Morris <rgm@gnu.org>
parents:
diff
changeset
|
24 |
f25cba6d7938
Checklist for adding new files to Emacs.
Glenn Morris <rgm@gnu.org>
parents:
diff
changeset
|
25 ** 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
|
26 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
|
27 |
f25cba6d7938
Checklist for adding new files to Emacs.
Glenn Morris <rgm@gnu.org>
parents:
diff
changeset
|
28 ** If appropriate, add a short NEWS entry. |
f25cba6d7938
Checklist for adding new files to Emacs.
Glenn Morris <rgm@gnu.org>
parents:
diff
changeset
|
29 |
f25cba6d7938
Checklist for adding new files to Emacs.
Glenn Morris <rgm@gnu.org>
parents:
diff
changeset
|
30 ** 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
|
31 names, eg *.el). |