annotate lispref/tips.texi @ 68701:efd297c5c768

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