view 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)

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.

** Make the ChangeLog entry in the name of the author(s), not your own name.

** If appropriate, add an entry to lisp/Makefile.in ELCFILES.

** 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).