annotate doc/lispref/tips.texi @ 84464:ccd6d86fd9a6

* s/darwin.h (MULTI_KBOARD): Only define for Carbon.
author Dan Nicolaescu <dann@ics.uci.edu>
date Tue, 11 Sep 2007 01:04:00 +0000
parents 0ba80d073e27
children 107ccd98fa12
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
84105
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1 @c -*-texinfo-*-
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2 @c This is part of the GNU Emacs Lisp Reference Manual.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1995, 1998, 1999, 2001, 2002,
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4 @c 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5 @c See the file elisp.texi for copying conditions.
84116
0ba80d073e27 (setfilename): Go up one more level to ../../info.
Glenn Morris <rgm@gnu.org>
parents: 84105
diff changeset
6 @setfilename ../../info/tips
84105
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7 @node Tips, GNU Emacs Internals, GPL, Top
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8 @appendix Tips and Conventions
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9 @cindex tips for writing Lisp
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10 @cindex standards of coding style
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11 @cindex coding standards
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13 This chapter describes no additional features of Emacs Lisp. Instead
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14 it gives advice on making effective use of the features described in the
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15 previous chapters, and describes conventions Emacs Lisp programmers
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16 should follow.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18 You can automatically check some of the conventions described below by
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19 running the command @kbd{M-x checkdoc RET} when visiting a Lisp file.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20 It cannot check all of the conventions, and not all the warnings it
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21 gives necessarily correspond to problems, but it is worth examining them
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22 all.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
23
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
24 @menu
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
25 * Coding Conventions:: Conventions for clean and robust programs.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
26 * Key Binding Conventions:: Which keys should be bound by which programs.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
27 * Programming Tips:: Making Emacs code fit smoothly in Emacs.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
28 * Compilation Tips:: Making compiled code run fast.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
29 * Warning Tips:: Turning off compiler warnings.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
30 * Documentation Tips:: Writing readable documentation strings.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
31 * Comment Tips:: Conventions for writing comments.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
32 * Library Headers:: Standard headers for library packages.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
33 @end menu
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
34
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
35 @node Coding Conventions
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
36 @section Emacs Lisp Coding Conventions
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
37
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
38 @cindex coding conventions in Emacs Lisp
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
39 Here are conventions that you should follow when writing Emacs Lisp
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
40 code intended for widespread use:
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
41
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
42 @itemize @bullet
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
43 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
44 Simply loading the package should not change Emacs's editing behavior.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
45 Include a command or commands to enable and disable the feature,
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
46 or to invoke it.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
47
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
48 This convention is mandatory for any file that includes custom
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
49 definitions. If fixing such a file to follow this convention requires
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
50 an incompatible change, go ahead and make the incompatible change;
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
51 don't postpone it.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
52
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
53 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
54 Since all global variables share the same name space, and all
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
55 functions share another name space, you should choose a short word to
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
56 distinguish your program from other Lisp programs@footnote{The
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
57 benefits of a Common Lisp-style package system are considered not to
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
58 outweigh the costs.}. Then take care to begin the names of all global
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
59 variables, constants, and functions in your program with the chosen
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
60 prefix. This helps avoid name conflicts.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
61
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
62 Occasionally, for a command name intended for users to use, it is more
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
63 convenient if some words come before the package's name prefix. And
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
64 constructs that define functions, variables, etc., work better if they
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
65 start with @samp{defun} or @samp{defvar}, so put the name prefix later
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
66 on in the name.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
67
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
68 This recommendation applies even to names for traditional Lisp
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
69 primitives that are not primitives in Emacs Lisp---such as
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
70 @code{copy-list}. Believe it or not, there is more than one plausible
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
71 way to define @code{copy-list}. Play it safe; append your name prefix
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
72 to produce a name like @code{foo-copy-list} or @code{mylib-copy-list}
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
73 instead.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
74
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
75 If you write a function that you think ought to be added to Emacs under
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
76 a certain name, such as @code{twiddle-files}, don't call it by that name
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
77 in your program. Call it @code{mylib-twiddle-files} in your program,
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
78 and send mail to @samp{bug-gnu-emacs@@gnu.org} suggesting we add
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
79 it to Emacs. If and when we do, we can change the name easily enough.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
80
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
81 If one prefix is insufficient, your package can use two or three
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
82 alternative common prefixes, so long as they make sense.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
83
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
84 Separate the prefix from the rest of the symbol name with a hyphen,
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
85 @samp{-}. This will be consistent with Emacs itself and with most Emacs
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
86 Lisp programs.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
87
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
88 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
89 Put a call to @code{provide} at the end of each separate Lisp file.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
90
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
91 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
92 If a file requires certain other Lisp programs to be loaded
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
93 beforehand, then the comments at the beginning of the file should say
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
94 so. Also, use @code{require} to make sure they are loaded.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
95
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
96 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
97 If one file @var{foo} uses a macro defined in another file @var{bar},
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
98 @var{foo} should contain this expression before the first use of the
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
99 macro:
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
100
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
101 @example
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
102 (eval-when-compile (require '@var{bar}))
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
103 @end example
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
104
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
105 @noindent
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
106 (And the library @var{bar} should contain @code{(provide '@var{bar})},
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
107 to make the @code{require} work.) This will cause @var{bar} to be
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
108 loaded when you byte-compile @var{foo}. Otherwise, you risk compiling
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
109 @var{foo} without the necessary macro loaded, and that would produce
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
110 compiled code that won't work right. @xref{Compiling Macros}.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
111
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
112 Using @code{eval-when-compile} avoids loading @var{bar} when
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
113 the compiled version of @var{foo} is @emph{used}.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
114
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
115 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
116 Please don't require the @code{cl} package of Common Lisp extensions at
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
117 run time. Use of this package is optional, and it is not part of the
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
118 standard Emacs namespace. If your package loads @code{cl} at run time,
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
119 that could cause name clashes for users who don't use that package.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
120
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
121 However, there is no problem with using the @code{cl} package at
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
122 compile time, with @code{(eval-when-compile (require 'cl))}. That's
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
123 sufficient for using the macros in the @code{cl} package, because the
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
124 compiler expands them before generating the byte-code.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
125
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
126 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
127 When defining a major mode, please follow the major mode
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
128 conventions. @xref{Major Mode Conventions}.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
129
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
130 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
131 When defining a minor mode, please follow the minor mode
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
132 conventions. @xref{Minor Mode Conventions}.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
133
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
134 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
135 If the purpose of a function is to tell you whether a certain condition
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
136 is true or false, give the function a name that ends in @samp{p}. If
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
137 the name is one word, add just @samp{p}; if the name is multiple words,
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
138 add @samp{-p}. Examples are @code{framep} and @code{frame-live-p}.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
139
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
140 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
141 If a user option variable records a true-or-false condition, give it a
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
142 name that ends in @samp{-flag}.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
143
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
144 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
145 If the purpose of a variable is to store a single function, give it a
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
146 name that ends in @samp{-function}. If the purpose of a variable is
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
147 to store a list of functions (i.e., the variable is a hook), please
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
148 follow the naming conventions for hooks. @xref{Hooks}.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
149
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
150 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
151 @cindex unloading packages, preparing for
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
152 If loading the file adds functions to hooks, define a function
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
153 @code{@var{feature}-unload-hook}, where @var{feature} is the name of
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
154 the feature the package provides, and make it undo any such changes.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
155 Using @code{unload-feature} to unload the file will run this function.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
156 @xref{Unloading}.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
157
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
158 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
159 It is a bad idea to define aliases for the Emacs primitives. Normally
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
160 you should use the standard names instead. The case where an alias
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
161 may be useful is where it facilitates backwards compatibility or
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
162 portability.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
163
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
164 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
165 If a package needs to define an alias or a new function for
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
166 compatibility with some other version of Emacs, name it with the package
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
167 prefix, not with the raw name with which it occurs in the other version.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
168 Here is an example from Gnus, which provides many examples of such
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
169 compatibility issues.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
170
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
171 @example
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
172 (defalias 'gnus-point-at-bol
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
173 (if (fboundp 'point-at-bol)
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
174 'point-at-bol
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
175 'line-beginning-position))
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
176 @end example
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
177
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
178 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
179 Redefining (or advising) an Emacs primitive is a bad idea. It may do
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
180 the right thing for a particular program, but there is no telling what
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
181 other programs might break as a result. In any case, it is a problem
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
182 for debugging, because the advised function doesn't do what its source
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
183 code says it does. If the programmer investigating the problem is
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
184 unaware that there is advice on the function, the experience can be
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
185 very frustrating.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
186
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
187 We hope to remove all the places in Emacs that advise primitives.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
188 In the mean time, please don't add any more.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
189
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
190 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
191 It is likewise a bad idea for one Lisp package to advise a function
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
192 in another Lisp package.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
193
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
194 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
195 Likewise, avoid using @code{eval-after-load} (@pxref{Hooks for
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
196 Loading}) in libraries and packages. This feature is meant for
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
197 personal customizations; using it in a Lisp program is unclean,
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
198 because it modifies the behavior of another Lisp file in a way that's
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
199 not visible in that file. This is an obstacle for debugging, much
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
200 like advising a function in the other package.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
201
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
202 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
203 If a file does replace any of the functions or library programs of
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
204 standard Emacs, prominent comments at the beginning of the file should
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
205 say which functions are replaced, and how the behavior of the
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
206 replacements differs from that of the originals.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
207
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
208 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
209 Constructs that define a function or variable should be macros,
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
210 not functions, and their names should start with @samp{def}.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
211
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
212 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
213 A macro that defines a function or variable should have a name that
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
214 starts with @samp{define-}. The macro should receive the name to be
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
215 defined as the first argument. That will help various tools find the
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
216 definition automatically. Avoid constructing the names in the macro
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
217 itself, since that would confuse these tools.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
218
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
219 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
220 Please keep the names of your Emacs Lisp source files to 13 characters
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
221 or less. This way, if the files are compiled, the compiled files' names
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
222 will be 14 characters or less, which is short enough to fit on all kinds
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
223 of Unix systems.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
224
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
225 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
226 In some other systems there is a convention of choosing variable names
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
227 that begin and end with @samp{*}. We don't use that convention in Emacs
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
228 Lisp, so please don't use it in your programs. (Emacs uses such names
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
229 only for special-purpose buffers.) The users will find Emacs more
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
230 coherent if all libraries use the same conventions.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
231
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
232 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
233 If your program contains non-ASCII characters in string or character
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
234 constants, you should make sure Emacs always decodes these characters
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
235 the same way, regardless of the user's settings. There are two ways
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
236 to do that:
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
237
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
238 @itemize -
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
239 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
240 Use coding system @code{emacs-mule}, and specify that for
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
241 @code{coding} in the @samp{-*-} line or the local variables list.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
242
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
243 @example
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
244 ;; XXX.el -*- coding: emacs-mule; -*-
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
245 @end example
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
246
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
247 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
248 Use one of the coding systems based on ISO 2022 (such as
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
249 iso-8859-@var{n} and iso-2022-7bit), and specify it with @samp{!} at
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
250 the end for @code{coding}. (The @samp{!} turns off any possible
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
251 character translation.)
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
252
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
253 @example
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
254 ;; XXX.el -*- coding: iso-latin-2!; -*-
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
255 @end example
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
256 @end itemize
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
257
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
258 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
259 Indent each function with @kbd{C-M-q} (@code{indent-sexp}) using the
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
260 default indentation parameters.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
261
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
262 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
263 Don't make a habit of putting close-parentheses on lines by themselves;
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
264 Lisp programmers find this disconcerting. Once in a while, when there
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
265 is a sequence of many consecutive close-parentheses, it may make sense
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
266 to split the sequence in one or two significant places.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
267
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
268 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
269 Please put a copyright notice and copying permission notice on the
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
270 file if you distribute copies. Use a notice like this one:
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
271
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
272 @smallexample
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
273 ;; Copyright (C) @var{year} @var{name}
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
274
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
275 ;; This program is free software; you can redistribute it and/or
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
276 ;; modify it under the terms of the GNU General Public License as
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
277 ;; published by the Free Software Foundation; either version 3 of
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
278 ;; the License, or (at your option) any later version.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
279
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
280 ;; This program is distributed in the hope that it will be
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
281 ;; useful, but WITHOUT ANY WARRANTY; without even the implied
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
282 ;; warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
283 ;; PURPOSE. See the GNU General Public License for more details.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
284
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
285 ;; You should have received a copy of the GNU General Public
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
286 ;; License along with this program; if not, write to the Free
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
287 ;; Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
288 ;; Boston, MA 02110-1301 USA
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
289 @end smallexample
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
290
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
291 If you have signed papers to assign the copyright to the Foundation,
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
292 then use @samp{Free Software Foundation, Inc.} as @var{name}.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
293 Otherwise, use your name. See also @xref{Library Headers}.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
294 @end itemize
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
295
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
296 @node Key Binding Conventions
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
297 @section Key Binding Conventions
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
298 @cindex key binding, conventions for
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
299
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
300 @itemize @bullet
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
301 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
302 @cindex mouse-2
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
303 @cindex references, following
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
304 Special major modes used for read-only text should usually redefine
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
305 @kbd{mouse-2} and @key{RET} to trace some sort of reference in the text.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
306 Modes such as Dired, Info, Compilation, and Occur redefine it in this
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
307 way.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
308
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
309 In addition, they should mark the text as a kind of ``link'' so that
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
310 @kbd{mouse-1} will follow it also. @xref{Links and Mouse-1}.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
311
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
312 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
313 @cindex reserved keys
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
314 @cindex keys, reserved
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
315 Please do not define @kbd{C-c @var{letter}} as a key in Lisp programs.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
316 Sequences consisting of @kbd{C-c} and a letter (either upper or lower
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
317 case) are reserved for users; they are the @strong{only} sequences
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
318 reserved for users, so do not block them.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
319
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
320 Changing all the Emacs major modes to respect this convention was a
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
321 lot of work; abandoning this convention would make that work go to
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
322 waste, and inconvenience users. Please comply with it.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
323
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
324 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
325 Function keys @key{F5} through @key{F9} without modifier keys are
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
326 also reserved for users to define.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
327
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
328 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
329 Applications should not bind mouse events based on button 1 with the
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
330 shift key held down. These events include @kbd{S-mouse-1},
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
331 @kbd{M-S-mouse-1}, @kbd{C-S-mouse-1}, and so on. They are reserved for
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
332 users.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
333
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
334 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
335 Sequences consisting of @kbd{C-c} followed by a control character or a
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
336 digit are reserved for major modes.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
337
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
338 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
339 Sequences consisting of @kbd{C-c} followed by @kbd{@{}, @kbd{@}},
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
340 @kbd{<}, @kbd{>}, @kbd{:} or @kbd{;} are also reserved for major modes.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
341
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
342 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
343 Sequences consisting of @kbd{C-c} followed by any other punctuation
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
344 character are allocated for minor modes. Using them in a major mode is
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
345 not absolutely prohibited, but if you do that, the major mode binding
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
346 may be shadowed from time to time by minor modes.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
347
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
348 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
349 Do not bind @kbd{C-h} following any prefix character (including
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
350 @kbd{C-c}). If you don't bind @kbd{C-h}, it is automatically available
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
351 as a help character for listing the subcommands of the prefix character.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
352
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
353 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
354 Do not bind a key sequence ending in @key{ESC} except following
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
355 another @key{ESC}. (That is, it is OK to bind a sequence ending in
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
356 @kbd{@key{ESC} @key{ESC}}.)
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
357
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
358 The reason for this rule is that a non-prefix binding for @key{ESC} in
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
359 any context prevents recognition of escape sequences as function keys in
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
360 that context.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
361
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
362 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
363 Anything which acts like a temporary mode or state which the user can
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
364 enter and leave should define @kbd{@key{ESC} @key{ESC}} or
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
365 @kbd{@key{ESC} @key{ESC} @key{ESC}} as a way to escape.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
366
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
367 For a state which accepts ordinary Emacs commands, or more generally any
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
368 kind of state in which @key{ESC} followed by a function key or arrow key
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
369 is potentially meaningful, then you must not define @kbd{@key{ESC}
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
370 @key{ESC}}, since that would preclude recognizing an escape sequence
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
371 after @key{ESC}. In these states, you should define @kbd{@key{ESC}
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
372 @key{ESC} @key{ESC}} as the way to escape. Otherwise, define
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
373 @kbd{@key{ESC} @key{ESC}} instead.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
374 @end itemize
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
375
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
376 @node Programming Tips
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
377 @section Emacs Programming Tips
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
378 @cindex programming conventions
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
379
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
380 Following these conventions will make your program fit better
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
381 into Emacs when it runs.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
382
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
383 @itemize @bullet
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
384 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
385 Don't use @code{next-line} or @code{previous-line} in programs; nearly
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
386 always, @code{forward-line} is more convenient as well as more
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
387 predictable and robust. @xref{Text Lines}.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
388
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
389 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
390 Don't call functions that set the mark, unless setting the mark is one
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
391 of the intended features of your program. The mark is a user-level
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
392 feature, so it is incorrect to change the mark except to supply a value
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
393 for the user's benefit. @xref{The Mark}.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
394
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
395 In particular, don't use any of these functions:
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
396
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
397 @itemize @bullet
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
398 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
399 @code{beginning-of-buffer}, @code{end-of-buffer}
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
400 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
401 @code{replace-string}, @code{replace-regexp}
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
402 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
403 @code{insert-file}, @code{insert-buffer}
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
404 @end itemize
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
405
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
406 If you just want to move point, or replace a certain string, or insert
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
407 a file or buffer's contents, without any of the other features
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
408 intended for interactive users, you can replace these functions with
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
409 one or two lines of simple Lisp code.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
410
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
411 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
412 Use lists rather than vectors, except when there is a particular reason
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
413 to use a vector. Lisp has more facilities for manipulating lists than
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
414 for vectors, and working with lists is usually more convenient.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
415
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
416 Vectors are advantageous for tables that are substantial in size and are
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
417 accessed in random order (not searched front to back), provided there is
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
418 no need to insert or delete elements (only lists allow that).
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
419
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
420 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
421 The recommended way to show a message in the echo area is with
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
422 the @code{message} function, not @code{princ}. @xref{The Echo Area}.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
423
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
424 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
425 When you encounter an error condition, call the function @code{error}
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
426 (or @code{signal}). The function @code{error} does not return.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
427 @xref{Signaling Errors}.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
428
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
429 Do not use @code{message}, @code{throw}, @code{sleep-for},
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
430 or @code{beep} to report errors.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
431
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
432 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
433 An error message should start with a capital letter but should not end
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
434 with a period.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
435
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
436 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
437 A question asked in the minibuffer with @code{y-or-n-p} or
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
438 @code{yes-or-no-p} should start with a capital letter and end with
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
439 @samp{? }.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
440
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
441 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
442 When you mention a default value in a minibuffer prompt,
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
443 put it and the word @samp{default} inside parentheses.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
444 It should look like this:
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
445
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
446 @example
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
447 Enter the answer (default 42):
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
448 @end example
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
449
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
450 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
451 In @code{interactive}, if you use a Lisp expression to produce a list
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
452 of arguments, don't try to provide the ``correct'' default values for
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
453 region or position arguments. Instead, provide @code{nil} for those
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
454 arguments if they were not specified, and have the function body
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
455 compute the default value when the argument is @code{nil}. For
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
456 instance, write this:
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
457
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
458 @example
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
459 (defun foo (pos)
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
460 (interactive
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
461 (list (if @var{specified} @var{specified-pos})))
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
462 (unless pos (setq pos @var{default-pos}))
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
463 ...)
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
464 @end example
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
465
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
466 @noindent
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
467 rather than this:
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
468
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
469 @example
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
470 (defun foo (pos)
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
471 (interactive
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
472 (list (if @var{specified} @var{specified-pos}
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
473 @var{default-pos})))
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
474 ...)
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
475 @end example
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
476
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
477 @noindent
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
478 This is so that repetition of the command will recompute
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
479 these defaults based on the current circumstances.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
480
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
481 You do not need to take such precautions when you use interactive
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
482 specs @samp{d}, @samp{m} and @samp{r}, because they make special
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
483 arrangements to recompute the argument values on repetition of the
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
484 command.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
485
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
486 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
487 Many commands that take a long time to execute display a message that
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
488 says something like @samp{Operating...} when they start, and change it to
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
489 @samp{Operating...done} when they finish. Please keep the style of
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
490 these messages uniform: @emph{no} space around the ellipsis, and
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
491 @emph{no} period after @samp{done}.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
492
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
493 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
494 Try to avoid using recursive edits. Instead, do what the Rmail @kbd{e}
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
495 command does: use a new local keymap that contains one command defined
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
496 to switch back to the old local keymap. Or do what the
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
497 @code{edit-options} command does: switch to another buffer and let the
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
498 user switch back at will. @xref{Recursive Editing}.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
499 @end itemize
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
500
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
501 @node Compilation Tips
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
502 @section Tips for Making Compiled Code Fast
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
503 @cindex execution speed
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
504 @cindex speedups
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
505
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
506 Here are ways of improving the execution speed of byte-compiled
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
507 Lisp programs.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
508
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
509 @itemize @bullet
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
510 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
511 @cindex profiling
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
512 @cindex timing programs
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
513 @cindex @file{elp.el}
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
514 Profile your program with the @file{elp} library. See the file
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
515 @file{elp.el} for instructions.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
516
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
517 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
518 @cindex @file{benchmark.el}
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
519 @cindex benchmarking
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
520 Check the speed of individual Emacs Lisp forms using the
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
521 @file{benchmark} library. See the functions @code{benchmark-run} and
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
522 @code{benchmark-run-compiled} in @file{benchmark.el}.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
523
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
524 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
525 Use iteration rather than recursion whenever possible.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
526 Function calls are slow in Emacs Lisp even when a compiled function
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
527 is calling another compiled function.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
528
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
529 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
530 Using the primitive list-searching functions @code{memq}, @code{member},
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
531 @code{assq}, or @code{assoc} is even faster than explicit iteration. It
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
532 can be worth rearranging a data structure so that one of these primitive
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
533 search functions can be used.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
534
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
535 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
536 Certain built-in functions are handled specially in byte-compiled code,
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
537 avoiding the need for an ordinary function call. It is a good idea to
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
538 use these functions rather than alternatives. To see whether a function
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
539 is handled specially by the compiler, examine its @code{byte-compile}
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
540 property. If the property is non-@code{nil}, then the function is
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
541 handled specially.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
542
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
543 For example, the following input will show you that @code{aref} is
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
544 compiled specially (@pxref{Array Functions}):
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
545
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
546 @example
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
547 @group
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
548 (get 'aref 'byte-compile)
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
549 @result{} byte-compile-two-args
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
550 @end group
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
551 @end example
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
552
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
553 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
554 If calling a small function accounts for a substantial part of your
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
555 program's running time, make the function inline. This eliminates
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
556 the function call overhead. Since making a function inline reduces
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
557 the flexibility of changing the program, don't do it unless it gives
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
558 a noticeable speedup in something slow enough that users care about
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
559 the speed. @xref{Inline Functions}.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
560 @end itemize
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
561
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
562 @node Warning Tips
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
563 @section Tips for Avoiding Compiler Warnings
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
564 @cindex byte compiler warnings, how to avoid
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
565
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
566 @itemize @bullet
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
567 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
568 Try to avoid compiler warnings about undefined free variables, by adding
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
569 dummy @code{defvar} definitions for these variables, like this:
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
570
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
571 @example
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
572 (defvar foo)
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
573 @end example
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
574
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
575 Such a definition has no effect except to tell the compiler
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
576 not to warn about uses of the variable @code{foo} in this file.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
577
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
578 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
579 If you use many functions and variables from a certain file, you can
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
580 add a @code{require} for that package to avoid compilation warnings
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
581 for them. For instance,
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
582
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
583 @example
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
584 (eval-when-compile
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
585 (require 'foo))
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
586 @end example
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
587
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
588 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
589 If you bind a variable in one function, and use it or set it in
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
590 another function, the compiler warns about the latter function unless
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
591 the variable has a definition. But adding a definition would be
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
592 unclean if the variable has a short name, since Lisp packages should
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
593 not define short variable names. The right thing to do is to rename
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
594 this variable to start with the name prefix used for the other
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
595 functions and variables in your package.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
596
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
597 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
598 The last resort for avoiding a warning, when you want to do something
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
599 that usually is a mistake but it's not a mistake in this one case,
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
600 is to put a call to @code{with-no-warnings} around it.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
601 @end itemize
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
602
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
603 @node Documentation Tips
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
604 @section Tips for Documentation Strings
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
605 @cindex documentation strings, conventions and tips
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
606
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
607 @findex checkdoc-minor-mode
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
608 Here are some tips and conventions for the writing of documentation
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
609 strings. You can check many of these conventions by running the command
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
610 @kbd{M-x checkdoc-minor-mode}.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
611
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
612 @itemize @bullet
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
613 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
614 Every command, function, or variable intended for users to know about
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
615 should have a documentation string.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
616
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
617 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
618 An internal variable or subroutine of a Lisp program might as well have
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
619 a documentation string. In earlier Emacs versions, you could save space
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
620 by using a comment instead of a documentation string, but that is no
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
621 longer the case---documentation strings now take up very little space in
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
622 a running Emacs.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
623
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
624 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
625 Format the documentation string so that it fits in an Emacs window on an
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
626 80-column screen. It is a good idea for most lines to be no wider than
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
627 60 characters. The first line should not be wider than 67 characters
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
628 or it will look bad in the output of @code{apropos}.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
629
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
630 You can fill the text if that looks good. However, rather than blindly
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
631 filling the entire documentation string, you can often make it much more
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
632 readable by choosing certain line breaks with care. Use blank lines
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
633 between topics if the documentation string is long.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
634
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
635 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
636 The first line of the documentation string should consist of one or two
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
637 complete sentences that stand on their own as a summary. @kbd{M-x
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
638 apropos} displays just the first line, and if that line's contents don't
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
639 stand on their own, the result looks bad. In particular, start the
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
640 first line with a capital letter and end with a period.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
641
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
642 For a function, the first line should briefly answer the question,
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
643 ``What does this function do?'' For a variable, the first line should
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
644 briefly answer the question, ``What does this value mean?''
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
645
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
646 Don't limit the documentation string to one line; use as many lines as
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
647 you need to explain the details of how to use the function or
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
648 variable. Please use complete sentences for the rest of the text too.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
649
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
650 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
651 When the user tries to use a disabled command, Emacs displays just the
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
652 first paragraph of its documentation string---everything through the
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
653 first blank line. If you wish, you can choose which information to
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
654 include before the first blank line so as to make this display useful.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
655
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
656 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
657 The first line should mention all the important arguments of the
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
658 function, and should mention them in the order that they are written
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
659 in a function call. If the function has many arguments, then it is
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
660 not feasible to mention them all in the first line; in that case, the
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
661 first line should mention the first few arguments, including the most
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
662 important arguments.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
663
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
664 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
665 When a function's documentation string mentions the value of an argument
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
666 of the function, use the argument name in capital letters as if it were
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
667 a name for that value. Thus, the documentation string of the function
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
668 @code{eval} refers to its second argument as @samp{FORM}, because the
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
669 actual argument name is @code{form}:
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
670
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
671 @example
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
672 Evaluate FORM and return its value.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
673 @end example
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
674
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
675 Also write metasyntactic variables in capital letters, such as when you
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
676 show the decomposition of a list or vector into subunits, some of which
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
677 may vary. @samp{KEY} and @samp{VALUE} in the following example
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
678 illustrate this practice:
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
679
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
680 @example
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
681 The argument TABLE should be an alist whose elements
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
682 have the form (KEY . VALUE). Here, KEY is ...
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
683 @end example
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
684
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
685 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
686 Never change the case of a Lisp symbol when you mention it in a doc
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
687 string. If the symbol's name is @code{foo}, write ``foo,'' not
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
688 ``Foo'' (which is a different symbol).
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
689
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
690 This might appear to contradict the policy of writing function
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
691 argument values, but there is no real contradiction; the argument
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
692 @emph{value} is not the same thing as the @emph{symbol} which the
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
693 function uses to hold the value.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
694
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
695 If this puts a lower-case letter at the beginning of a sentence
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
696 and that annoys you, rewrite the sentence so that the symbol
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
697 is not at the start of it.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
698
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
699 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
700 Do not start or end a documentation string with whitespace.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
701
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
702 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
703 @strong{Do not} indent subsequent lines of a documentation string so
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
704 that the text is lined up in the source code with the text of the first
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
705 line. This looks nice in the source code, but looks bizarre when users
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
706 view the documentation. Remember that the indentation before the
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
707 starting double-quote is not part of the string!
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
708
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
709 @anchor{Docstring hyperlinks}
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
710 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
711 @iftex
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
712 When a documentation string refers to a Lisp symbol, write it as it
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
713 would be printed (which usually means in lower case), with single-quotes
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
714 around it. For example: @samp{`lambda'}. There are two exceptions:
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
715 write @code{t} and @code{nil} without single-quotes.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
716 @end iftex
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
717 @ifnottex
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
718 When a documentation string refers to a Lisp symbol, write it as it
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
719 would be printed (which usually means in lower case), with single-quotes
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
720 around it. For example: @samp{lambda}. There are two exceptions: write
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
721 t and nil without single-quotes. (In this manual, we use a different
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
722 convention, with single-quotes for all symbols.)
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
723 @end ifnottex
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
724
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
725 @cindex hyperlinks in documentation strings
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
726 Help mode automatically creates a hyperlink when a documentation string
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
727 uses a symbol name inside single quotes, if the symbol has either a
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
728 function or a variable definition. You do not need to do anything
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
729 special to make use of this feature. However, when a symbol has both a
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
730 function definition and a variable definition, and you want to refer to
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
731 just one of them, you can specify which one by writing one of the words
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
732 @samp{variable}, @samp{option}, @samp{function}, or @samp{command},
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
733 immediately before the symbol name. (Case makes no difference in
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
734 recognizing these indicator words.) For example, if you write
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
735
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
736 @example
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
737 This function sets the variable `buffer-file-name'.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
738 @end example
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
739
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
740 @noindent
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
741 then the hyperlink will refer only to the variable documentation of
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
742 @code{buffer-file-name}, and not to its function documentation.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
743
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
744 If a symbol has a function definition and/or a variable definition, but
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
745 those are irrelevant to the use of the symbol that you are documenting,
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
746 you can write the words @samp{symbol} or @samp{program} before the
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
747 symbol name to prevent making any hyperlink. For example,
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
748
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
749 @example
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
750 If the argument KIND-OF-RESULT is the symbol `list',
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
751 this function returns a list of all the objects
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
752 that satisfy the criterion.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
753 @end example
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
754
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
755 @noindent
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
756 does not make a hyperlink to the documentation, irrelevant here, of the
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
757 function @code{list}.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
758
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
759 Normally, no hyperlink is made for a variable without variable
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
760 documentation. You can force a hyperlink for such variables by
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
761 preceding them with one of the words @samp{variable} or
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
762 @samp{option}.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
763
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
764 Hyperlinks for faces are only made if the face name is preceded or
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
765 followed by the word @samp{face}. In that case, only the face
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
766 documentation will be shown, even if the symbol is also defined as a
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
767 variable or as a function.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
768
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
769 To make a hyperlink to Info documentation, write the name of the Info
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
770 node (or anchor) in single quotes, preceded by @samp{info node},
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
771 @samp{Info node}, @samp{info anchor} or @samp{Info anchor}. The Info
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
772 file name defaults to @samp{emacs}. For example,
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
773
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
774 @smallexample
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
775 See Info node `Font Lock' and Info node `(elisp)Font Lock Basics'.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
776 @end smallexample
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
777
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
778 Finally, to create a hyperlink to URLs, write the URL in single
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
779 quotes, preceded by @samp{URL}. For example,
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
780
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
781 @smallexample
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
782 The home page for the GNU project has more information (see URL
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
783 `http://www.gnu.org/').
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
784 @end smallexample
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
785
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
786 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
787 Don't write key sequences directly in documentation strings. Instead,
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
788 use the @samp{\\[@dots{}]} construct to stand for them. For example,
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
789 instead of writing @samp{C-f}, write the construct
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
790 @samp{\\[forward-char]}. When Emacs displays the documentation string,
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
791 it substitutes whatever key is currently bound to @code{forward-char}.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
792 (This is normally @samp{C-f}, but it may be some other character if the
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
793 user has moved key bindings.) @xref{Keys in Documentation}.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
794
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
795 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
796 In documentation strings for a major mode, you will want to refer to the
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
797 key bindings of that mode's local map, rather than global ones.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
798 Therefore, use the construct @samp{\\<@dots{}>} once in the
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
799 documentation string to specify which key map to use. Do this before
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
800 the first use of @samp{\\[@dots{}]}. The text inside the
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
801 @samp{\\<@dots{}>} should be the name of the variable containing the
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
802 local keymap for the major mode.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
803
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
804 It is not practical to use @samp{\\[@dots{}]} very many times, because
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
805 display of the documentation string will become slow. So use this to
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
806 describe the most important commands in your major mode, and then use
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
807 @samp{\\@{@dots{}@}} to display the rest of the mode's keymap.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
808
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
809 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
810 For consistency, phrase the verb in the first sentence of a function's
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
811 documentation string as an imperative---for instance, use ``Return the
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
812 cons of A and B.'' in preference to ``Returns the cons of A and B@.''
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
813 Usually it looks good to do likewise for the rest of the first
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
814 paragraph. Subsequent paragraphs usually look better if each sentence
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
815 is indicative and has a proper subject.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
816
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
817 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
818 The documentation string for a function that is a yes-or-no predicate
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
819 should start with words such as ``Return t if,'' to indicate
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
820 explicitly what constitutes ``truth.'' The word ``return'' avoids
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
821 starting the sentence with lower-case ``t,'' which could be somewhat
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
822 distracting.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
823
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
824 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
825 If a line in a documentation string begins with an open-parenthesis,
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
826 write a backslash before the open-parenthesis, like this:
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
827
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
828 @example
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
829 The argument FOO can be either a number
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
830 \(a buffer position) or a string (a file name).
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
831 @end example
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
832
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
833 This prevents the open-parenthesis from being treated as the start of a
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
834 defun (@pxref{Defuns,, Defuns, emacs, The GNU Emacs Manual}).
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
835
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
836 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
837 Write documentation strings in the active voice, not the passive, and in
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
838 the present tense, not the future. For instance, use ``Return a list
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
839 containing A and B.'' instead of ``A list containing A and B will be
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
840 returned.''
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
841
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
842 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
843 Avoid using the word ``cause'' (or its equivalents) unnecessarily.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
844 Instead of, ``Cause Emacs to display text in boldface,'' write just
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
845 ``Display text in boldface.''
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
846
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
847 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
848 Avoid using ``iff'' (a mathematics term meaning ``if and only if''),
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
849 since many people are unfamiliar with it and mistake it for a typo. In
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
850 most cases, the meaning is clear with just ``if''. Otherwise, try to
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
851 find an alternate phrasing that conveys the meaning.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
852
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
853 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
854 When a command is meaningful only in a certain mode or situation,
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
855 do mention that in the documentation string. For example,
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
856 the documentation of @code{dired-find-file} is:
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
857
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
858 @example
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
859 In Dired, visit the file or directory named on this line.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
860 @end example
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
861
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
862 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
863 When you define a variable that users ought to set interactively, you
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
864 normally should use @code{defcustom}. However, if for some reason you
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
865 use @code{defvar} instead, start the doc string with a @samp{*}.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
866 @xref{Defining Variables}.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
867
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
868 @item
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
869 The documentation string for a variable that is a yes-or-no flag should
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
870 start with words such as ``Non-nil means,'' to make it clear that
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
871 all non-@code{nil} values are equivalent and indicate explicitly what
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
872 @code{nil} and non-@code{nil} mean.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
873 @end itemize
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
874
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
875 @node Comment Tips
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
876 @section Tips on Writing Comments
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
877 @cindex comments, Lisp convention for
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
878
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
879 We recommend these conventions for where to put comments and how to
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
880 indent them:
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
881
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
882 @table @samp
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
883 @item ;
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
884 Comments that start with a single semicolon, @samp{;}, should all be
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
885 aligned to the same column on the right of the source code. Such
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
886 comments usually explain how the code on the same line does its job. In
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
887 Lisp mode and related modes, the @kbd{M-;} (@code{indent-for-comment})
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
888 command automatically inserts such a @samp{;} in the right place, or
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
889 aligns such a comment if it is already present.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
890
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
891 This and following examples are taken from the Emacs sources.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
892
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
893 @smallexample
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
894 @group
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
895 (setq base-version-list ; there was a base
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
896 (assoc (substring fn 0 start-vn) ; version to which
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
897 file-version-assoc-list)) ; this looks like
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
898 ; a subversion
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
899 @end group
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
900 @end smallexample
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
901
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
902 @item ;;
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
903 Comments that start with two semicolons, @samp{;;}, should be aligned to
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
904 the same level of indentation as the code. Such comments usually
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
905 describe the purpose of the following lines or the state of the program
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
906 at that point. For example:
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
907
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
908 @smallexample
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
909 @group
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
910 (prog1 (setq auto-fill-function
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
911 @dots{}
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
912 @dots{}
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
913 ;; update mode line
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
914 (force-mode-line-update)))
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
915 @end group
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
916 @end smallexample
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
917
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
918 We also normally use two semicolons for comments outside functions.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
919
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
920 @smallexample
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
921 @group
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
922 ;; This Lisp code is run in Emacs
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
923 ;; when it is to operate as a server
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
924 ;; for other processes.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
925 @end group
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
926 @end smallexample
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
927
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
928 Every function that has no documentation string (presumably one that is
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
929 used only internally within the package it belongs to), should instead
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
930 have a two-semicolon comment right before the function, explaining what
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
931 the function does and how to call it properly. Explain precisely what
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
932 each argument means and how the function interprets its possible values.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
933
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
934 @item ;;;
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
935 Comments that start with three semicolons, @samp{;;;}, should start at
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
936 the left margin. These are used, occasionally, for comments within
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
937 functions that should start at the margin. We also use them sometimes
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
938 for comments that are between functions---whether to use two or three
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
939 semicolons depends on whether the comment should be considered a
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
940 ``heading'' by Outline minor mode. By default, comments starting with
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
941 at least three semicolons (followed by a single space and a
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
942 non-whitespace character) are considered headings, comments starting
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
943 with two or less are not.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
944
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
945 Another use for triple-semicolon comments is for commenting out lines
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
946 within a function. We use three semicolons for this precisely so that
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
947 they remain at the left margin. By default, Outline minor mode does
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
948 not consider a comment to be a heading (even if it starts with at
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
949 least three semicolons) if the semicolons are followed by at least two
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
950 spaces. Thus, if you add an introductory comment to the commented out
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
951 code, make sure to indent it by at least two spaces after the three
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
952 semicolons.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
953
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
954 @smallexample
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
955 (defun foo (a)
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
956 ;;; This is no longer necessary.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
957 ;;; (force-mode-line-update)
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
958 (message "Finished with %s" a))
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
959 @end smallexample
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
960
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
961 When commenting out entire functions, use two semicolons.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
962
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
963 @item ;;;;
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
964 Comments that start with four semicolons, @samp{;;;;}, should be aligned
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
965 to the left margin and are used for headings of major sections of a
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
966 program. For example:
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
967
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
968 @smallexample
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
969 ;;;; The kill ring
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
970 @end smallexample
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
971 @end table
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
972
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
973 @noindent
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
974 The indentation commands of the Lisp modes in Emacs, such as @kbd{M-;}
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
975 (@code{indent-for-comment}) and @key{TAB} (@code{lisp-indent-line}),
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
976 automatically indent comments according to these conventions,
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
977 depending on the number of semicolons. @xref{Comments,,
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
978 Manipulating Comments, emacs, The GNU Emacs Manual}.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
979
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
980 @node Library Headers
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
981 @section Conventional Headers for Emacs Libraries
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
982 @cindex header comments
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
983 @cindex library header comments
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
984
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
985 Emacs has conventions for using special comments in Lisp libraries
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
986 to divide them into sections and give information such as who wrote
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
987 them. This section explains these conventions.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
988
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
989 We'll start with an example, a package that is included in the Emacs
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
990 distribution.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
991
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
992 Parts of this example reflect its status as part of Emacs; for
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
993 example, the copyright notice lists the Free Software Foundation as the
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
994 copyright holder, and the copying permission says the file is part of
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
995 Emacs. When you write a package and post it, the copyright holder would
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
996 be you (unless your employer claims to own it instead), and you should
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
997 get the suggested copying permission from the end of the GNU General
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
998 Public License itself. Don't say your file is part of Emacs
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
999 if we haven't installed it in Emacs yet!
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1000
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1001 With that warning out of the way, on to the example:
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1002
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1003 @smallexample
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1004 @group
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1005 ;;; lisp-mnt.el --- minor mode for Emacs Lisp maintainers
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1006
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1007 ;; Copyright (C) 1992 Free Software Foundation, Inc.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1008 @end group
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1009
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1010 ;; Author: Eric S. Raymond <esr@@snark.thyrsus.com>
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1011 ;; Maintainer: Eric S. Raymond <esr@@snark.thyrsus.com>
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1012 ;; Created: 14 Jul 1992
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1013 ;; Version: 1.2
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1014 @group
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1015 ;; Keywords: docs
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1016
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1017 ;; This file is part of GNU Emacs.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1018 @dots{}
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1019 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1020 ;; Boston, MA 02110-1301, USA.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1021 @end group
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1022 @end smallexample
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1023
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1024 The very first line should have this format:
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1025
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1026 @example
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1027 ;;; @var{filename} --- @var{description}
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1028 @end example
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1029
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1030 @noindent
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1031 The description should be complete in one line. If the file
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1032 needs a @samp{-*-} specification, put it after @var{description}.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1033
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1034 After the copyright notice come several @dfn{header comment} lines,
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1035 each beginning with @samp{;; @var{header-name}:}. Here is a table of
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1036 the conventional possibilities for @var{header-name}:
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1037
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1038 @table @samp
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1039 @item Author
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1040 This line states the name and net address of at least the principal
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1041 author of the library.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1042
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1043 If there are multiple authors, you can list them on continuation lines
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1044 led by @code{;;} and a tab character, like this:
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1045
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1046 @smallexample
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1047 @group
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1048 ;; Author: Ashwin Ram <Ram-Ashwin@@cs.yale.edu>
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1049 ;; Dave Sill <de5@@ornl.gov>
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1050 ;; Dave Brennan <brennan@@hal.com>
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1051 ;; Eric Raymond <esr@@snark.thyrsus.com>
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1052 @end group
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1053 @end smallexample
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1054
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1055 @item Maintainer
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1056 This line should contain a single name/address as in the Author line, or
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1057 an address only, or the string @samp{FSF}. If there is no maintainer
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1058 line, the person(s) in the Author field are presumed to be the
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1059 maintainers. The example above is mildly bogus because the maintainer
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1060 line is redundant.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1061
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1062 The idea behind the @samp{Author} and @samp{Maintainer} lines is to make
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1063 possible a Lisp function to ``send mail to the maintainer'' without
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1064 having to mine the name out by hand.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1065
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1066 Be sure to surround the network address with @samp{<@dots{}>} if
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1067 you include the person's full name as well as the network address.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1068
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1069 @item Created
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1070 This optional line gives the original creation date of the
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1071 file. For historical interest only.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1072
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1073 @item Version
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1074 If you wish to record version numbers for the individual Lisp program, put
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1075 them in this line.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1076
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1077 @item Adapted-By
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1078 In this header line, place the name of the person who adapted the
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1079 library for installation (to make it fit the style conventions, for
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1080 example).
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1081
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1082 @item Keywords
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1083 This line lists keywords for the @code{finder-by-keyword} help command.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1084 Please use that command to see a list of the meaningful keywords.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1085
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1086 This field is important; it's how people will find your package when
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1087 they're looking for things by topic area. To separate the keywords, you
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1088 can use spaces, commas, or both.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1089 @end table
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1090
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1091 Just about every Lisp library ought to have the @samp{Author} and
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1092 @samp{Keywords} header comment lines. Use the others if they are
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1093 appropriate. You can also put in header lines with other header
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1094 names---they have no standard meanings, so they can't do any harm.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1095
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1096 We use additional stylized comments to subdivide the contents of the
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1097 library file. These should be separated by blank lines from anything
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1098 else. Here is a table of them:
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1099
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1100 @table @samp
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1101 @item ;;; Commentary:
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1102 This begins introductory comments that explain how the library works.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1103 It should come right after the copying permissions, terminated by a
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1104 @samp{Change Log}, @samp{History} or @samp{Code} comment line. This
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1105 text is used by the Finder package, so it should make sense in that
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1106 context.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1107
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1108 @item ;;; Documentation:
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1109 This was used in some files in place of @samp{;;; Commentary:},
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1110 but it is deprecated.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1111
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1112 @item ;;; Change Log:
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1113 This begins change log information stored in the library file (if you
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1114 store the change history there). For Lisp files distributed with Emacs,
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1115 the change history is kept in the file @file{ChangeLog} and not in the
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1116 source file at all; these files generally do not have a @samp{;;; Change
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1117 Log:} line. @samp{History} is an alternative to @samp{Change Log}.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1118
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1119 @item ;;; Code:
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1120 This begins the actual code of the program.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1121
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1122 @item ;;; @var{filename} ends here
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1123 This is the @dfn{footer line}; it appears at the very end of the file.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1124 Its purpose is to enable people to detect truncated versions of the file
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1125 from the lack of a footer line.
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1126 @end table
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1127
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1128 @ignore
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1129 arch-tag: 9ea911c2-6b1d-47dd-88b7-0a94e8b27c2e
672f5b796f1a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1130 @end ignore