Commit | Line | Data |
---|---|---|
f00366c2 | 1 | @c This is part of the Emacs manual. |
21e9e795 LK |
2 | @c Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1997, 1999, 2000, |
3 | @c 2001, 2005 Free Software Foundation, Inc. | |
f00366c2 RS |
4 | @c See file emacs.texi for copying conditions. |
5 | @node Maintaining, Abbrevs, Building, Top | |
6 | @chapter Maintaining Programs | |
7 | @cindex Lisp editing | |
8 | @cindex C editing | |
9 | @cindex program editing | |
10 | ||
11 | This chapter describes Emacs features for maintaining programs. The | |
21e9e795 LK |
12 | version control features (@pxref{Version Control}) are also particularly |
13 | useful for this purpose. | |
f00366c2 RS |
14 | |
15 | @menu | |
16 | * Change Log:: Maintaining a change history for your program. | |
f00366c2 RS |
17 | * Tags:: Go direct to any function in your program in one |
18 | command. Tags remembers which file it is in. | |
19 | * Emerge:: A convenient way of merging two versions of a program. | |
20 | @end menu | |
21 | ||
22 | @node Change Log | |
23 | @section Change Logs | |
24 | ||
25 | @cindex change log | |
26 | @kindex C-x 4 a | |
27 | @findex add-change-log-entry-other-window | |
28 | The Emacs command @kbd{C-x 4 a} adds a new entry to the change log | |
29 | file for the file you are editing | |
30 | (@code{add-change-log-entry-other-window}). If that file is actually | |
31 | a backup file, it makes an entry appropriate for the file's | |
32 | parent---that is useful for making log entries for functions that | |
33 | have been deleted in the current version. | |
34 | ||
35 | A change log file contains a chronological record of when and why you | |
36 | have changed a program, consisting of a sequence of entries describing | |
37 | individual changes. Normally it is kept in a file called | |
38 | @file{ChangeLog} in the same directory as the file you are editing, or | |
39 | one of its parent directories. A single @file{ChangeLog} file can | |
40 | record changes for all the files in its directory and all its | |
41 | subdirectories. | |
42 | ||
1e4cb307 RS |
43 | You should put a copyright notice and permission notice at the |
44 | end of the change log file. Here is an example: | |
45 | ||
46 | @example | |
47 | Copyright 1997, 1998 Free Software Foundation, Inc. | |
48 | Copying and distribution of this file, with or without modification, are | |
49 | permitted provided the copyright notice and this notice are preserved. | |
50 | @end example | |
51 | ||
52 | @noindent | |
53 | Of course, you should substitute the proper years and copyright holder. | |
54 | ||
21e9e795 LK |
55 | A change log entry starts with a header line that contains the current |
56 | date, your name, and your email address (taken from the variable | |
57 | @code{add-log-mailing-address}). Aside from these header lines, every | |
58 | line in the change log starts with a space or a tab. The bulk of the | |
59 | entry consists of @dfn{items}, each of which starts with a line starting | |
60 | with whitespace and a star. Here are two entries, both dated in May | |
61 | 1993, each with two items: | |
f00366c2 RS |
62 | |
63 | @iftex | |
64 | @medbreak | |
65 | @end iftex | |
66 | @smallexample | |
67 | 1993-05-25 Richard Stallman <rms@@gnu.org> | |
68 | ||
69 | * man.el: Rename symbols `man-*' to `Man-*'. | |
70 | (manual-entry): Make prompt string clearer. | |
71 | ||
72 | * simple.el (blink-matching-paren-distance): | |
73 | Change default to 12,000. | |
74 | ||
75 | 1993-05-24 Richard Stallman <rms@@gnu.org> | |
76 | ||
77 | * vc.el (minor-mode-map-alist): Don't use it if it's void. | |
78 | (vc-cancel-version): Doc fix. | |
79 | @end smallexample | |
80 | ||
81 | One entry can describe several changes; each change should have its | |
82 | own item. Normally there should be a blank line between items. When | |
83 | items are related (parts of the same change, in different places), group | |
84 | them by leaving no blank line between them. The second entry above | |
85 | contains two items grouped in this way. | |
86 | ||
87 | @kbd{C-x 4 a} visits the change log file and creates a new entry | |
88 | unless the most recent entry is for today's date and your name. It | |
89 | also creates a new item for the current file. For many languages, it | |
90 | can even guess the name of the function or other object that was | |
91 | changed. | |
92 | ||
93 | @vindex add-log-keep-changes-together | |
19b2c4ca | 94 | When the variable @code{add-log-keep-changes-together} is |
f00366c2 RS |
95 | non-@code{nil}, @kbd{C-x 4 a} adds to any existing entry for the file |
96 | rather than starting a new entry. | |
97 | ||
98 | @vindex change-log-version-info-enabled | |
99 | @vindex change-log-version-number-regexp-list | |
100 | @cindex file version in change log entries | |
101 | If the value of the variable @code{change-log-version-info-enabled} | |
102 | is non-@code{nil}, @kbd{C-x 4 a} adds the file's version number to the | |
103 | change log entry. It finds the version number by searching the first | |
104 | ten percent of the file, using regular expressions from the variable | |
105 | @code{change-log-version-number-regexp-list}. | |
106 | ||
ed1b7d5e RS |
107 | @vindex add-log-always-start-new-record |
108 | If @code{add-log-always-start-new-record} is non-@code{nil}, | |
109 | @kbd{C-x 4 a} always makes a new entry, even if the last entry | |
110 | was made by you and on the same date. | |
111 | ||
f00366c2 RS |
112 | @cindex Change Log mode |
113 | @findex change-log-mode | |
114 | The change log file is visited in Change Log mode. In this major | |
115 | mode, each bunch of grouped items counts as one paragraph, and each | |
116 | entry is considered a page. This facilitates editing the entries. | |
117 | @kbd{C-j} and auto-fill indent each new line like the previous line; | |
118 | this is convenient for entering the contents of an entry. | |
119 | ||
120 | @findex change-log-merge | |
121 | You can use the command @kbd{M-x change-log-merge} to merge other | |
122 | log files into a buffer in Change Log Mode, preserving the date | |
123 | ordering of entries. | |
124 | ||
125 | @findex change-log-redate | |
126 | @cindex converting change log date style | |
127 | Versions of Emacs before 20.1 used a different format for the time of | |
128 | the change log entry: | |
129 | ||
130 | @smallexample | |
131 | Fri May 25 11:23:23 1993 Richard Stallman <rms@@gnu.org> | |
132 | @end smallexample | |
133 | ||
134 | @noindent | |
135 | The @kbd{M-x change-log-redate} command converts all the old-style | |
136 | date entries in the change log file visited in the current buffer to | |
137 | the new format, to make the file uniform in style. This is handy when | |
138 | entries are contributed by many different people, some of whom use old | |
139 | versions of Emacs. | |
140 | ||
141 | Version control systems are another way to keep track of changes in your | |
142 | program and keep a change log. @xref{Log Buffer}. | |
143 | ||
e4059eed RS |
144 | @ignore |
145 | @c This is commented out because the command is specific | |
146 | @c to maintenance of Emacs itself. | |
147 | ||
f00366c2 RS |
148 | @node Authors |
149 | @section @file{AUTHORS} files | |
150 | @cindex @file{AUTHORS} file | |
151 | ||
152 | Programs which have many contributors usually include a file named | |
153 | @file{AUTHORS} in their distribution, which lists the individual | |
154 | contributions. Emacs has a special command for maintaining the | |
155 | @file{AUTHORS} file that is part of the Emacs distribution. | |
156 | ||
157 | @findex authors | |
158 | The @kbd{M-x authors} command prompts for the name of the root of the | |
9cd6acef | 159 | Emacs source directory. It then scans @file{ChangeLog} files and Lisp |
f00366c2 | 160 | source files under that directory for information about authors of |
d7ed11cd | 161 | individual packages, and people who made changes in source files, and |
f00366c2 RS |
162 | puts the information it gleans into a buffer named @samp{*Authors*}. |
163 | You can then edit the contents of that buffer and merge it with the | |
24cc235a | 164 | existing @file{AUTHORS} file. |
f00366c2 RS |
165 | |
166 | Do not assume that this command finds all the contributors; don't | |
167 | assume that a person not listed in the output was not a contributor. | |
168 | If you merged in someone's contribution and did not put his name | |
169 | in the change log, he won't show up in @kbd{M-x authors} either. | |
e4059eed | 170 | @end ignore |
f00366c2 RS |
171 | |
172 | @node Tags | |
173 | @section Tags Tables | |
174 | @cindex tags table | |
175 | ||
176 | A @dfn{tags table} is a description of how a multi-file program is | |
177 | broken up into files. It lists the names of the component files and the | |
178 | names and positions of the functions (or other named subunits) in each | |
179 | file. Grouping the related files makes it possible to search or replace | |
180 | through all the files with one command. Recording the function names | |
181 | and positions makes possible the @kbd{M-.} command which finds the | |
182 | definition of a function by looking up which of the files it is in. | |
183 | ||
184 | Tags tables are stored in files called @dfn{tags table files}. The | |
185 | conventional name for a tags table file is @file{TAGS}. | |
186 | ||
187 | Each entry in the tags table records the name of one tag, the name of the | |
bf8dd4e3 FP |
188 | file that the tag is defined in (implicitly), and the position in that |
189 | file of the tag's definition. When a file parsed by @code{etags} is | |
0f5401a8 FP |
190 | generated from a different source file, like a C file generated from a |
191 | Cweb source file, the tags of the parsed file reference the source | |
192 | file. | |
f00366c2 RS |
193 | |
194 | Just what names from the described files are recorded in the tags table | |
195 | depends on the programming language of the described file. They | |
196 | normally include all file names, functions and subroutines, and may | |
197 | also include global variables, data types, and anything else | |
198 | convenient. Each name recorded is called a @dfn{tag}. | |
199 | ||
200 | @cindex C++ class browser, tags | |
201 | @cindex tags, C++ | |
202 | @cindex class browser, C++ | |
203 | @cindex Ebrowse | |
204 | See also the Ebrowse facility, which is tailored for C++. | |
205 | @xref{Top,, Ebrowse, ebrowse, Ebrowse User's Manual}. | |
206 | ||
207 | @menu | |
208 | * Tag Syntax:: Tag syntax for various types of code and text files. | |
209 | * Create Tags Table:: Creating a tags table with @code{etags}. | |
210 | * Etags Regexps:: Create arbitrary tags using regular expressions. | |
211 | * Select Tags Table:: How to visit a tags table. | |
212 | * Find Tag:: Commands to find the definition of a specific tag. | |
213 | * Tags Search:: Using a tags table for searching and replacing. | |
214 | * List Tags:: Listing and finding tags defined in a file. | |
215 | @end menu | |
216 | ||
217 | @node Tag Syntax | |
218 | @subsection Source File Tag Syntax | |
219 | ||
220 | Here is how tag syntax is defined for the most popular languages: | |
221 | ||
222 | @itemize @bullet | |
223 | @item | |
224 | In C code, any C function or typedef is a tag, and so are definitions of | |
225 | @code{struct}, @code{union} and @code{enum}. | |
226 | @code{#define} macro definitions and @code{enum} constants are also | |
227 | tags, unless you specify @samp{--no-defines} when making the tags table. | |
228 | Similarly, global variables are tags, unless you specify | |
229 | @samp{--no-globals}. Use of @samp{--no-globals} and @samp{--no-defines} | |
230 | can make the tags table file much smaller. | |
231 | ||
232 | You can tag function declarations and external variables in addition | |
233 | to function definitions by giving the @samp{--declarations} option to | |
f01f5735 FP |
234 | @code{etags}. You can tag struct members with the @samp{--members} |
235 | option. | |
f00366c2 RS |
236 | |
237 | @item | |
238 | In C++ code, in addition to all the tag constructs of C code, member | |
239 | functions are also recognized, and optionally member variables if you | |
240 | use the @samp{--members} option. Tags for variables and functions in | |
241 | classes are named @samp{@var{class}::@var{variable}} and | |
242 | @samp{@var{class}::@var{function}}. @code{operator} definitions have | |
243 | tag names like @samp{operator+}. | |
244 | ||
245 | @item | |
246 | In Java code, tags include all the constructs recognized in C++, plus | |
247 | the @code{interface}, @code{extends} and @code{implements} constructs. | |
248 | Tags for variables and functions in classes are named | |
249 | @samp{@var{class}.@var{variable}} and @samp{@var{class}.@var{function}}. | |
250 | ||
251 | @item | |
252 | In La@TeX{} text, the argument of any of the commands @code{\chapter}, | |
253 | @code{\section}, @code{\subsection}, @code{\subsubsection}, | |
e4a1e8d9 FP |
254 | @code{\eqno}, @code{\label}, @code{\ref}, @code{\cite}, |
255 | @code{\bibitem}, @code{\part}, @code{\appendix}, @code{\entry}, | |
28665d46 | 256 | @code{\index}, @code{\def}, @code{\newcommand}, @code{\renewcommand}, |
e4a1e8d9 | 257 | @code{\newenvironment} or @code{\renewenvironment} is a tag.@refill |
f00366c2 RS |
258 | |
259 | Other commands can make tags as well, if you specify them in the | |
260 | environment variable @env{TEXTAGS} before invoking @code{etags}. The | |
261 | value of this environment variable should be a colon-separated list of | |
262 | command names. For example, | |
263 | ||
264 | @example | |
e4a1e8d9 | 265 | TEXTAGS="mycommand:myothercommand" |
f00366c2 RS |
266 | export TEXTAGS |
267 | @end example | |
268 | ||
269 | @noindent | |
e4a1e8d9 FP |
270 | specifies (using Bourne shell syntax) that the commands |
271 | @samp{\mycommand} and @samp{\myothercommand} also define tags. | |
f00366c2 RS |
272 | |
273 | @item | |
274 | In Lisp code, any function defined with @code{defun}, any variable | |
275 | defined with @code{defvar} or @code{defconst}, and in general the first | |
f01f5735 | 276 | argument of any expression that starts with @samp{(def} in column zero is |
f00366c2 RS |
277 | a tag. |
278 | ||
279 | @item | |
280 | In Scheme code, tags include anything defined with @code{def} or with a | |
281 | construct whose name starts with @samp{def}. They also include variables | |
282 | set with @code{set!} at top level in the file. | |
283 | @end itemize | |
284 | ||
285 | Several other languages are also supported: | |
286 | ||
287 | @itemize @bullet | |
288 | ||
289 | @item | |
f01f5735 | 290 | In Ada code, functions, procedures, packages, tasks and types are |
f00366c2 RS |
291 | tags. Use the @samp{--packages-only} option to create tags for |
292 | packages only. | |
293 | ||
294 | In Ada, the same name can be used for different kinds of entity | |
295 | (e.g.@:, for a procedure and for a function). Also, for things like | |
296 | packages, procedures and functions, there is the spec (i.e.@: the | |
297 | interface) and the body (i.e.@: the implementation). To make it | |
298 | easier to pick the definition you want, Ada tag name have suffixes | |
299 | indicating the type of entity: | |
300 | ||
301 | @table @samp | |
302 | @item /b | |
303 | package body. | |
304 | @item /f | |
305 | function. | |
306 | @item /k | |
307 | task. | |
308 | @item /p | |
309 | procedure. | |
310 | @item /s | |
311 | package spec. | |
312 | @item /t | |
313 | type. | |
314 | @end table | |
315 | ||
316 | Thus, @kbd{M-x find-tag @key{RET} bidule/b @key{RET}} will go | |
317 | directly to the body of the package @code{bidule}, while @kbd{M-x | |
318 | find-tag @key{RET} bidule @key{RET}} will just search for any tag | |
319 | @code{bidule}. | |
320 | ||
321 | @item | |
322 | In assembler code, labels appearing at the beginning of a line, | |
323 | followed by a colon, are tags. | |
324 | ||
325 | @item | |
326 | In Bison or Yacc input files, each rule defines as a tag the nonterminal | |
327 | it constructs. The portions of the file that contain C code are parsed | |
328 | as C code. | |
329 | ||
330 | @item | |
331 | In Cobol code, tags are paragraph names; that is, any word starting in | |
332 | column 8 and followed by a period. | |
333 | ||
334 | @item | |
f01f5735 | 335 | In Erlang code, the tags are the functions, records and macros defined |
f00366c2 RS |
336 | in the file. |
337 | ||
338 | @item | |
47d7776c | 339 | In Fortran code, functions, subroutines and block data are tags. |
f00366c2 | 340 | |
2c37653c FP |
341 | @item |
342 | In HTML input files, the tags are the @code{title} and the @code{h1}, | |
343 | @code{h2}, @code{h3} headers. Also, tags are @code{name=} in anchors | |
344 | and all occurrences of @code{id=}. | |
345 | ||
dfcb9727 FP |
346 | @item |
347 | In Lua input files, all functions are tags. | |
348 | ||
f00366c2 | 349 | @item |
f175bfff FP |
350 | In makefiles, targets are tags; additionally, variables are tags |
351 | unless you specify @samp{--no-globals}. | |
f00366c2 RS |
352 | |
353 | @item | |
354 | In Objective C code, tags include Objective C definitions for classes, | |
f01f5735 | 355 | class categories, methods and protocols. Tags for variables and |
3e7eaab2 FP |
356 | functions in classes are named @samp{@var{class}::@var{variable}} and |
357 | @samp{@var{class}::@var{function}}. | |
f00366c2 RS |
358 | |
359 | @item | |
360 | In Pascal code, the tags are the functions and procedures defined in | |
361 | the file. | |
362 | ||
363 | @item | |
3e7eaab2 FP |
364 | In Perl code, the tags are the packages, subroutines and variables |
365 | defined by the @code{package}, @code{sub}, @code{my} and @code{local} | |
366 | keywords. Use @samp{--globals} if you want to tag global variables. | |
367 | Tags for subroutines are named @samp{@var{package}::@var{sub}}. The | |
368 | name for subroutines defined in the default package is | |
369 | @samp{main::@var{sub}}. | |
f00366c2 | 370 | |
e94a3679 FP |
371 | @item |
372 | In PHP code, tags are functions, classes and defines. When using the | |
373 | @samp{--members} option, vars are tags too. | |
374 | ||
f00366c2 RS |
375 | @item |
376 | In PostScript code, the tags are the functions. | |
377 | ||
378 | @item | |
e94a3679 FP |
379 | In Prolog code, tags are predicates and rules at the beginning of |
380 | line. | |
f00366c2 RS |
381 | |
382 | @item | |
383 | In Python code, @code{def} or @code{class} at the beginning of a line | |
384 | generate a tag. | |
385 | @end itemize | |
386 | ||
387 | You can also generate tags based on regexp matching (@pxref{Etags | |
388 | Regexps}) to handle other formats and languages. | |
389 | ||
390 | @node Create Tags Table | |
391 | @subsection Creating Tags Tables | |
392 | @cindex @code{etags} program | |
393 | ||
394 | The @code{etags} program is used to create a tags table file. It knows | |
395 | the syntax of several languages, as described in | |
396 | @iftex | |
397 | the previous section. | |
398 | @end iftex | |
399 | @ifinfo | |
400 | @ref{Tag Syntax}. | |
401 | @end ifinfo | |
402 | Here is how to run @code{etags}: | |
403 | ||
404 | @example | |
405 | etags @var{inputfiles}@dots{} | |
406 | @end example | |
407 | ||
408 | @noindent | |
409 | The @code{etags} program reads the specified files, and writes a tags | |
410 | table named @file{TAGS} in the current working directory. | |
411 | ||
412 | If the specified files don't exist, @code{etags} looks for | |
413 | compressed versions of them and uncompresses them to read them. Under | |
414 | MS-DOS, @code{etags} also looks for file names like @file{mycode.cgz} | |
415 | if it is given @samp{mycode.c} on the command line and @file{mycode.c} | |
416 | does not exist. | |
417 | ||
418 | @code{etags} recognizes the language used in an input file based on | |
419 | its file name and contents. You can specify the language with the | |
420 | @samp{--language=@var{name}} option, described below. | |
421 | ||
422 | If the tags table data become outdated due to changes in the files | |
423 | described in the table, the way to update the tags table is the same | |
55d3737d RS |
424 | way it was made in the first place. If the tags table fails to record |
425 | a tag, or records it for the wrong file, then Emacs cannot possibly | |
426 | find its definition until you update the tags table. However, if the | |
f00366c2 | 427 | position recorded in the tags table becomes a little bit wrong (due to |
55d3737d RS |
428 | other editing), the only consequence is a slight delay in finding the |
429 | tag. Even if the stored position is very far wrong, Emacs will still | |
430 | find the tag, after searching most of the file for it. Even that | |
431 | delay is hardly noticeable with today's computers. | |
f00366c2 RS |
432 | |
433 | So you should update a tags table when you define new tags that you want | |
434 | to have listed, or when you move tag definitions from one file to another, | |
435 | or when changes become substantial. Normally there is no need to update | |
436 | the tags table after each edit, or even every day. | |
437 | ||
438 | One tags table can virtually include another. Specify the included | |
439 | tags file name with the @samp{--include=@var{file}} option when | |
440 | creating the file that is to include it. The latter file then acts as | |
441 | if it covered all the source files specified in the included file, as | |
442 | well as the files it directly contains. | |
443 | ||
444 | If you specify the source files with relative file names when you run | |
445 | @code{etags}, the tags file will contain file names relative to the | |
446 | directory where the tags file was initially written. This way, you can | |
447 | move an entire directory tree containing both the tags file and the | |
448 | source files, and the tags file will still refer correctly to the source | |
4559d619 FP |
449 | files. If the tags file is in @file{/dev}, however, the file names are |
450 | made relative to the current working directory. | |
f00366c2 RS |
451 | |
452 | If you specify absolute file names as arguments to @code{etags}, then | |
453 | the tags file will contain absolute file names. This way, the tags file | |
454 | will still refer to the same files even if you move it, as long as the | |
455 | source files remain in the same place. Absolute file names start with | |
456 | @samp{/}, or with @samp{@var{device}:/} on MS-DOS and MS-Windows. | |
457 | ||
458 | When you want to make a tags table from a great number of files, you | |
459 | may have problems listing them on the command line, because some systems | |
460 | have a limit on its length. The simplest way to circumvent this limit | |
461 | is to tell @code{etags} to read the file names from its standard input, | |
462 | by typing a dash in place of the file names, like this: | |
463 | ||
464 | @smallexample | |
465 | find . -name "*.[chCH]" -print | etags - | |
466 | @end smallexample | |
467 | ||
468 | Use the option @samp{--language=@var{name}} to specify the language | |
469 | explicitly. You can intermix these options with file names; each one | |
470 | applies to the file names that follow it. Specify | |
471 | @samp{--language=auto} to tell @code{etags} to resume guessing the | |
472 | language from the file names and file contents. Specify | |
473 | @samp{--language=none} to turn off language-specific processing | |
474 | entirely; then @code{etags} recognizes tags by regexp matching alone | |
475 | (@pxref{Etags Regexps}). | |
476 | ||
e4a1e8d9 FP |
477 | The option @samp{--parse-stdin=@var{file}} is mostly useful when |
478 | calling @code{etags} from programs. It can be used (only once) in | |
479 | place of a file name on the command line. @code{Etags} will read from | |
480 | standard input and mark the produced tags as belonging to the file | |
481 | @var{file}. | |
482 | ||
f00366c2 RS |
483 | @samp{etags --help} prints the list of the languages @code{etags} |
484 | knows, and the file name rules for guessing the language. It also prints | |
485 | a list of all the available @code{etags} options, together with a short | |
f01f5735 FP |
486 | explanation. If followed by one or more @samp{--language=@var{lang}} |
487 | options, prints detailed information about how tags are generated for | |
177c0ea7 | 488 | @var{lang}. |
f00366c2 RS |
489 | |
490 | @node Etags Regexps | |
491 | @subsection Etags Regexps | |
492 | ||
493 | The @samp{--regex} option provides a general way of recognizing tags | |
494 | based on regexp matching. You can freely intermix it with file names. | |
ed1b7d5e RS |
495 | If you specify multiple @samp{--regex} options, all of them are used |
496 | in parallel, but each one applies only to the source files that follow | |
497 | it. The syntax is: | |
f00366c2 RS |
498 | |
499 | @smallexample | |
cc76b311 FP |
500 | --regex=[@var{@{language@}}]/@var{tagregexp}/[@var{nameregexp}/]@var{modifiers} |
501 | @end smallexample | |
502 | ||
ed1b7d5e RS |
503 | The essential part of the option value is @var{tagregexp}, the |
504 | regexp for matching tags. It is always used anchored, that is, it | |
505 | only matches at the beginning of a line. If you want to allow | |
506 | indented tags, use a regexp that matches initial whitespace; start it | |
507 | with @samp{[ \t]*}. | |
508 | ||
509 | In these regular expressions, @samp{\} quotes the next character, and | |
510 | all the GCC character escape sequences are supported (@samp{\a} for | |
511 | bell, @samp{\b} for back space, @samp{\d} for delete, @samp{\e} for | |
512 | escape, @samp{\f} for formfeed, @samp{\n} for newline, @samp{\r} for | |
513 | carriage return, @samp{\t} for tab, and @samp{\v} for vertical tab). | |
514 | ||
515 | Ideally, @var{tagregexp} should not match more characters than are | |
516 | needed to recognize what you want to tag. If the syntax requires you | |
517 | to write @var{tagregexp} so it matches more characters beyond the tag | |
518 | itself, you should add a @var{nameregexp}, to pick out just the tag. | |
519 | This will enable Emacs to find tags more accurately and to do | |
520 | completion on tag names more reliably. You can find some examples | |
521 | below. | |
522 | ||
523 | The @var{modifiers} are a sequence of zero or more characters that | |
524 | modify the way @code{etags} does the matching. A regexp with no | |
525 | modifiers is applied sequentially to each line of the input file, in a | |
526 | case-sensitive way. The modifiers and their meanings are: | |
cc76b311 FP |
527 | |
528 | @table @samp | |
529 | @item i | |
ed1b7d5e | 530 | Ignore case when matching this regexp. |
cc76b311 | 531 | @item m |
ed1b7d5e RS |
532 | Match this regular expression against the whole file, so that |
533 | multi-line matches are possible. | |
cc76b311 | 534 | @item s |
ed1b7d5e RS |
535 | Match this regular expression against the whole file, and allow |
536 | @samp{.} in @var{tagregexp} to match newlines. | |
cc76b311 FP |
537 | @end table |
538 | ||
ed1b7d5e | 539 | The @samp{-R} option cancels all the regexps defined by preceding |
f00366c2 RS |
540 | @samp{--regex} options. It applies to the file names following it, as |
541 | you can see from the following example: | |
542 | ||
543 | @smallexample | |
648ed8f4 | 544 | etags --regex=/@var{reg1}/i voo.doo --regex=/@var{reg2}/m \ |
f00366c2 RS |
545 | bar.ber -R --lang=lisp los.er |
546 | @end smallexample | |
547 | ||
548 | @noindent | |
549 | Here @code{etags} chooses the parsing language for @file{voo.doo} and | |
550 | @file{bar.ber} according to their contents. @code{etags} also uses | |
551 | @var{reg1} to recognize additional tags in @file{voo.doo}, and both | |
552 | @var{reg1} and @var{reg2} to recognize additional tags in | |
648ed8f4 FP |
553 | @file{bar.ber}. @var{reg1} is checked against each line of |
554 | @file{voo.doo} and @file{bar.ber}, in a case-insensitive way, while | |
555 | @var{reg2} is checked against the whole @file{bar.ber} file, | |
556 | permitting multi-line matches, in a case-sensitive way. @code{etags} | |
ed1b7d5e RS |
557 | uses only the Lisp tags rules, with no user-specified regexp matching, |
558 | to recognize tags in @file{los.er}. | |
f00366c2 | 559 | |
b8fc5a9c FP |
560 | You can restrict a @samp{--regex} option to match only files of a |
561 | given language by using the optional prefix @var{@{language@}}. | |
648ed8f4 FP |
562 | (@samp{etags --help} prints the list of languages recognized by |
563 | @code{etags}.) This is particularly useful when storing many | |
564 | predefined regular expressions for @code{etags} in a file. The | |
f00366c2 RS |
565 | following example tags the @code{DEFVAR} macros in the Emacs source |
566 | files, for the C language only: | |
567 | ||
568 | @smallexample | |
569 | --regex='@{c@}/[ \t]*DEFVAR_[A-Z_ \t(]+"\([^"]+\)"/' | |
570 | @end smallexample | |
571 | ||
572 | @noindent | |
ed1b7d5e RS |
573 | When you have complex regular expressions, you can store the list of |
574 | them in a file. The following option syntax instructs @code{etags} to | |
575 | read two files of regular expressions. The regular expressions | |
576 | contained in the second file are matched without regard to case. | |
f00366c2 RS |
577 | |
578 | @smallexample | |
ed1b7d5e | 579 | --regex=@@@var{case-sensitive-file} --ignore-case-regex=@@@var{ignore-case-file} |
f00366c2 RS |
580 | @end smallexample |
581 | ||
582 | @noindent | |
ed1b7d5e RS |
583 | A regex file for @code{etags} contains one regular expression per |
584 | line. Empty lines, and lines beginning with space or tab are ignored. | |
585 | When the first character in a line is @samp{@@}, @code{etags} assumes | |
586 | that the rest of the line is the name of another file of regular | |
587 | expressions; thus, one such file can include another file. All the | |
588 | other lines are taken to be regular expressions. If the first | |
589 | non-whitespace text on the line is @samp{--}, that line is a comment. | |
590 | ||
591 | For example, we can create a file called @samp{emacs.tags} with the | |
f00366c2 RS |
592 | following contents: |
593 | ||
594 | @smallexample | |
595 | -- This is for GNU Emacs C source files | |
596 | @{c@}/[ \t]*DEFVAR_[A-Z_ \t(]+"\([^"]+\)"/\1/ | |
597 | @end smallexample | |
598 | ||
599 | @noindent | |
600 | and then use it like this: | |
601 | ||
602 | @smallexample | |
603 | etags --regex=@@emacs.tags *.[ch] */*.[ch] | |
604 | @end smallexample | |
605 | ||
606 | Here are some more examples. The regexps are quoted to protect them | |
607 | from shell interpretation. | |
608 | ||
609 | @itemize @bullet | |
610 | ||
611 | @item | |
612 | Tag Octave files: | |
613 | ||
614 | @smallexample | |
615 | etags --language=none \ | |
616 | --regex='/[ \t]*function.*=[ \t]*\([^ \t]*\)[ \t]*(/\1/' \ | |
617 | --regex='/###key \(.*\)/\1/' \ | |
618 | --regex='/[ \t]*global[ \t].*/' \ | |
619 | *.m | |
620 | @end smallexample | |
621 | ||
622 | @noindent | |
623 | Note that tags are not generated for scripts, so that you have to add | |
624 | a line by yourself of the form @samp{###key @var{scriptname}} if you | |
625 | want to jump to it. | |
626 | ||
627 | @item | |
628 | Tag Tcl files: | |
629 | ||
630 | @smallexample | |
631 | etags --language=none --regex='/proc[ \t]+\([^ \t]+\)/\1/' *.tcl | |
632 | @end smallexample | |
633 | ||
634 | @item | |
635 | Tag VHDL files: | |
636 | ||
637 | @smallexample | |
638 | etags --language=none \ | |
639 | --regex='/[ \t]*\(ARCHITECTURE\|CONFIGURATION\) +[^ ]* +OF/' \ | |
640 | --regex='/[ \t]*\(ATTRIBUTE\|ENTITY\|FUNCTION\|PACKAGE\ | |
641 | \( BODY\)?\|PROCEDURE\|PROCESS\|TYPE\)[ \t]+\([^ \t(]+\)/\3/' | |
642 | @end smallexample | |
643 | @end itemize | |
644 | ||
645 | @node Select Tags Table | |
646 | @subsection Selecting a Tags Table | |
647 | ||
648 | @vindex tags-file-name | |
649 | @findex visit-tags-table | |
650 | Emacs has at any time one @dfn{selected} tags table, and all the commands | |
651 | for working with tags tables use the selected one. To select a tags table, | |
652 | type @kbd{M-x visit-tags-table}, which reads the tags table file name as an | |
653 | argument. The name @file{TAGS} in the default directory is used as the | |
654 | default file name. | |
655 | ||
656 | All this command does is store the file name in the variable | |
657 | @code{tags-file-name}. Emacs does not actually read in the tags table | |
658 | contents until you try to use them. Setting this variable yourself is just | |
659 | as good as using @code{visit-tags-table}. The variable's initial value is | |
660 | @code{nil}; that value tells all the commands for working with tags tables | |
661 | that they must ask for a tags table file name to use. | |
662 | ||
663 | Using @code{visit-tags-table} when a tags table is already loaded | |
664 | gives you a choice: you can add the new tags table to the current list | |
665 | of tags tables, or start a new list. The tags commands use all the tags | |
666 | tables in the current list. If you start a new list, the new tags table | |
667 | is used @emph{instead} of others. If you add the new table to the | |
668 | current list, it is used @emph{as well as} the others. When the tags | |
669 | commands scan the list of tags tables, they don't always start at the | |
670 | beginning of the list; they start with the first tags table (if any) | |
671 | that describes the current file, proceed from there to the end of the | |
672 | list, and then scan from the beginning of the list until they have | |
673 | covered all the tables in the list. | |
674 | ||
675 | @vindex tags-table-list | |
676 | You can specify a precise list of tags tables by setting the variable | |
677 | @code{tags-table-list} to a list of strings, like this: | |
678 | ||
679 | @c keep this on two lines for formatting in smallbook | |
680 | @example | |
681 | @group | |
682 | (setq tags-table-list | |
683 | '("~/emacs" "/usr/local/lib/emacs/src")) | |
684 | @end group | |
685 | @end example | |
686 | ||
687 | @noindent | |
688 | This tells the tags commands to look at the @file{TAGS} files in your | |
689 | @file{~/emacs} directory and in the @file{/usr/local/lib/emacs/src} | |
690 | directory. The order depends on which file you are in and which tags | |
691 | table mentions that file, as explained above. | |
692 | ||
693 | Do not set both @code{tags-file-name} and @code{tags-table-list}. | |
694 | ||
695 | @node Find Tag | |
696 | @subsection Finding a Tag | |
697 | ||
698 | The most important thing that a tags table enables you to do is to find | |
699 | the definition of a specific tag. | |
700 | ||
701 | @table @kbd | |
702 | @item M-.@: @var{tag} @key{RET} | |
703 | Find first definition of @var{tag} (@code{find-tag}). | |
704 | @item C-u M-. | |
705 | Find next alternate definition of last tag specified. | |
706 | @item C-u - M-. | |
707 | Go back to previous tag found. | |
708 | @item C-M-. @var{pattern} @key{RET} | |
709 | Find a tag whose name matches @var{pattern} (@code{find-tag-regexp}). | |
710 | @item C-u C-M-. | |
711 | Find the next tag whose name matches the last pattern used. | |
712 | @item C-x 4 .@: @var{tag} @key{RET} | |
713 | Find first definition of @var{tag}, but display it in another window | |
714 | (@code{find-tag-other-window}). | |
715 | @item C-x 5 .@: @var{tag} @key{RET} | |
716 | Find first definition of @var{tag}, and create a new frame to select the | |
717 | buffer (@code{find-tag-other-frame}). | |
718 | @item M-* | |
719 | Pop back to where you previously invoked @kbd{M-.} and friends. | |
720 | @end table | |
721 | ||
722 | @kindex M-. | |
723 | @findex find-tag | |
724 | @kbd{M-.}@: (@code{find-tag}) is the command to find the definition of | |
725 | a specified tag. It searches through the tags table for that tag, as a | |
726 | string, and then uses the tags table info to determine the file that the | |
727 | definition is in and the approximate character position in the file of | |
728 | the definition. Then @code{find-tag} visits that file, moves point to | |
729 | the approximate character position, and searches ever-increasing | |
730 | distances away to find the tag definition. | |
731 | ||
732 | If an empty argument is given (just type @key{RET}), the balanced | |
733 | expression in the buffer before or around point is used as the | |
734 | @var{tag} argument. @xref{Expressions}. | |
735 | ||
736 | You don't need to give @kbd{M-.} the full name of the tag; a part | |
737 | will do. This is because @kbd{M-.} finds tags in the table which | |
738 | contain @var{tag} as a substring. However, it prefers an exact match | |
739 | to a substring match. To find other tags that match the same | |
740 | substring, give @code{find-tag} a numeric argument, as in @kbd{C-u | |
741 | M-.}; this does not read a tag name, but continues searching the tags | |
742 | table's text for another tag containing the same substring last used. | |
743 | If you have a real @key{META} key, @kbd{M-0 M-.}@: is an easier | |
744 | alternative to @kbd{C-u M-.}. | |
745 | ||
746 | @kindex C-x 4 . | |
747 | @findex find-tag-other-window | |
748 | @kindex C-x 5 . | |
749 | @findex find-tag-other-frame | |
750 | Like most commands that can switch buffers, @code{find-tag} has a | |
751 | variant that displays the new buffer in another window, and one that | |
752 | makes a new frame for it. The former is @kbd{C-x 4 .}, which invokes | |
753 | the command @code{find-tag-other-window}. The latter is @kbd{C-x 5 .}, | |
754 | which invokes @code{find-tag-other-frame}. | |
755 | ||
756 | To move back to places you've found tags recently, use @kbd{C-u - | |
757 | M-.}; more generally, @kbd{M-.} with a negative numeric argument. This | |
758 | command can take you to another buffer. @kbd{C-x 4 .} with a negative | |
759 | argument finds the previous tag location in another window. | |
760 | ||
761 | @kindex M-* | |
762 | @findex pop-tag-mark | |
763 | @vindex find-tag-marker-ring-length | |
764 | As well as going back to places you've found tags recently, you can go | |
765 | back to places @emph{from where} you found them. Use @kbd{M-*}, which | |
766 | invokes the command @code{pop-tag-mark}, for this. Typically you would | |
767 | find and study the definition of something with @kbd{M-.} and then | |
768 | return to where you were with @kbd{M-*}. | |
769 | ||
770 | Both @kbd{C-u - M-.} and @kbd{M-*} allow you to retrace your steps to | |
771 | a depth determined by the variable @code{find-tag-marker-ring-length}. | |
772 | ||
773 | @findex find-tag-regexp | |
774 | @kindex C-M-. | |
775 | The command @kbd{C-M-.} (@code{find-tag-regexp}) visits the tags that | |
776 | match a specified regular expression. It is just like @kbd{M-.} except | |
777 | that it does regexp matching instead of substring matching. | |
778 | ||
779 | @node Tags Search | |
780 | @subsection Searching and Replacing with Tags Tables | |
781 | @cindex search and replace in multiple files | |
782 | @cindex multiple-file search and replace | |
783 | ||
784 | The commands in this section visit and search all the files listed in the | |
785 | selected tags table, one by one. For these commands, the tags table serves | |
786 | only to specify a sequence of files to search. | |
787 | ||
788 | @table @kbd | |
789 | @item M-x tags-search @key{RET} @var{regexp} @key{RET} | |
790 | Search for @var{regexp} through the files in the selected tags | |
791 | table. | |
792 | @item M-x tags-query-replace @key{RET} @var{regexp} @key{RET} @var{replacement} @key{RET} | |
793 | Perform a @code{query-replace-regexp} on each file in the selected tags table. | |
794 | @item M-, | |
795 | Restart one of the commands above, from the current location of point | |
796 | (@code{tags-loop-continue}). | |
797 | @end table | |
798 | ||
799 | @findex tags-search | |
800 | @kbd{M-x tags-search} reads a regexp using the minibuffer, then | |
801 | searches for matches in all the files in the selected tags table, one | |
802 | file at a time. It displays the name of the file being searched so you | |
803 | can follow its progress. As soon as it finds an occurrence, | |
804 | @code{tags-search} returns. | |
805 | ||
806 | @kindex M-, | |
807 | @findex tags-loop-continue | |
808 | Having found one match, you probably want to find all the rest. To find | |
809 | one more match, type @kbd{M-,} (@code{tags-loop-continue}) to resume the | |
810 | @code{tags-search}. This searches the rest of the current buffer, followed | |
811 | by the remaining files of the tags table.@refill | |
812 | ||
813 | @findex tags-query-replace | |
814 | @kbd{M-x tags-query-replace} performs a single | |
815 | @code{query-replace-regexp} through all the files in the tags table. It | |
816 | reads a regexp to search for and a string to replace with, just like | |
817 | ordinary @kbd{M-x query-replace-regexp}. It searches much like @kbd{M-x | |
818 | tags-search}, but repeatedly, processing matches according to your | |
819 | input. @xref{Replace}, for more information on query replace. | |
820 | ||
821 | @vindex tags-case-fold-search | |
822 | @cindex case-sensitivity and tags search | |
823 | You can control the case-sensitivity of tags search commands by | |
824 | customizing the value of the variable @code{tags-case-fold-search}. The | |
825 | default is to use the same setting as the value of | |
826 | @code{case-fold-search} (@pxref{Search Case}). | |
827 | ||
828 | It is possible to get through all the files in the tags table with a | |
829 | single invocation of @kbd{M-x tags-query-replace}. But often it is | |
830 | useful to exit temporarily, which you can do with any input event that | |
831 | has no special query replace meaning. You can resume the query replace | |
832 | subsequently by typing @kbd{M-,}; this command resumes the last tags | |
833 | search or replace command that you did. | |
834 | ||
835 | The commands in this section carry out much broader searches than the | |
836 | @code{find-tag} family. The @code{find-tag} commands search only for | |
837 | definitions of tags that match your substring or regexp. The commands | |
838 | @code{tags-search} and @code{tags-query-replace} find every occurrence | |
839 | of the regexp, as ordinary search commands and replace commands do in | |
840 | the current buffer. | |
841 | ||
842 | These commands create buffers only temporarily for the files that they | |
843 | have to search (those which are not already visited in Emacs buffers). | |
844 | Buffers in which no match is found are quickly killed; the others | |
845 | continue to exist. | |
846 | ||
847 | It may have struck you that @code{tags-search} is a lot like | |
848 | @code{grep}. You can also run @code{grep} itself as an inferior of | |
849 | Emacs and have Emacs show you the matching lines one by one. This works | |
850 | much like running a compilation; finding the source locations of the | |
851 | @code{grep} matches works like finding the compilation errors. | |
852 | @xref{Compilation}. | |
853 | ||
854 | @node List Tags | |
855 | @subsection Tags Table Inquiries | |
856 | ||
857 | @table @kbd | |
858 | @item M-x list-tags @key{RET} @var{file} @key{RET} | |
859 | Display a list of the tags defined in the program file @var{file}. | |
860 | @item M-x tags-apropos @key{RET} @var{regexp} @key{RET} | |
861 | Display a list of all tags matching @var{regexp}. | |
862 | @end table | |
863 | ||
864 | @findex list-tags | |
865 | @kbd{M-x list-tags} reads the name of one of the files described by | |
866 | the selected tags table, and displays a list of all the tags defined in | |
867 | that file. The ``file name'' argument is really just a string to | |
868 | compare against the file names recorded in the tags table; it is read as | |
869 | a string rather than as a file name. Therefore, completion and | |
870 | defaulting are not available, and you must enter the file name the same | |
871 | way it appears in the tags table. Do not include a directory as part of | |
872 | the file name unless the file name recorded in the tags table includes a | |
873 | directory. | |
874 | ||
875 | @findex tags-apropos | |
876 | @vindex tags-apropos-verbose | |
877 | @kbd{M-x tags-apropos} is like @code{apropos} for tags | |
878 | (@pxref{Apropos}). It finds all the tags in the selected tags table | |
879 | whose entries match @var{regexp}, and displays them. If the variable | |
880 | @code{tags-apropos-verbose} is non-@code{nil}, it displays the names | |
881 | of the tags files together with the tag names. | |
882 | ||
883 | @vindex tags-tag-face | |
884 | @vindex tags-apropos-additional-actions | |
885 | You can customize the appearance of the output with the face | |
886 | @code{tags-tag-face}. You can display additional output with @kbd{M-x | |
887 | tags-apropos} by customizing the variable | |
888 | @code{tags-apropos-additional-actions}---see its documentation for | |
889 | details. | |
890 | ||
891 | You can also use the collection of tag names to complete a symbol | |
892 | name in the buffer. @xref{Symbol Completion}. | |
893 | ||
ebe19e1b | 894 | @node Emerge |
f00366c2 RS |
895 | @section Merging Files with Emerge |
896 | @cindex Emerge | |
897 | @cindex merging files | |
898 | ||
899 | It's not unusual for programmers to get their signals crossed and modify | |
900 | the same program in two different directions. To recover from this | |
901 | confusion, you need to merge the two versions. Emerge makes this | |
902 | easier. See also @ref{Comparing Files}, for commands to compare | |
b5f1c9fa | 903 | in a more manual fashion, and @ref{Top, Ediff,, ediff, The Ediff Manual}. |
f00366c2 RS |
904 | |
905 | @menu | |
906 | * Overview of Emerge:: How to start Emerge. Basic concepts. | |
907 | * Submodes of Emerge:: Fast mode vs. Edit mode. | |
908 | Skip Prefers mode and Auto Advance mode. | |
909 | * State of Difference:: You do the merge by specifying state A or B | |
910 | for each difference. | |
911 | * Merge Commands:: Commands for selecting a difference, | |
912 | changing states of differences, etc. | |
913 | * Exiting Emerge:: What to do when you've finished the merge. | |
914 | * Combining in Emerge:: How to keep both alternatives for a difference. | |
915 | * Fine Points of Emerge:: Misc. | |
916 | @end menu | |
917 | ||
918 | @node Overview of Emerge | |
919 | @subsection Overview of Emerge | |
920 | ||
921 | To start Emerge, run one of these four commands: | |
922 | ||
923 | @table @kbd | |
924 | @item M-x emerge-files | |
925 | @findex emerge-files | |
926 | Merge two specified files. | |
927 | ||
928 | @item M-x emerge-files-with-ancestor | |
929 | @findex emerge-files-with-ancestor | |
930 | Merge two specified files, with reference to a common ancestor. | |
931 | ||
932 | @item M-x emerge-buffers | |
933 | @findex emerge-buffers | |
934 | Merge two buffers. | |
935 | ||
936 | @item M-x emerge-buffers-with-ancestor | |
937 | @findex emerge-buffers-with-ancestor | |
938 | Merge two buffers with reference to a common ancestor in a third | |
939 | buffer. | |
940 | @end table | |
941 | ||
942 | @cindex merge buffer (Emerge) | |
943 | @cindex A and B buffers (Emerge) | |
944 | The Emerge commands compare two files or buffers, and display the | |
945 | comparison in three buffers: one for each input text (the @dfn{A buffer} | |
946 | and the @dfn{B buffer}), and one (the @dfn{merge buffer}) where merging | |
947 | takes place. The merge buffer shows the full merged text, not just the | |
948 | differences. Wherever the two input texts differ, you can choose which | |
949 | one of them to include in the merge buffer. | |
950 | ||
951 | The Emerge commands that take input from existing buffers use only the | |
952 | accessible portions of those buffers, if they are narrowed | |
953 | (@pxref{Narrowing}). | |
954 | ||
955 | If a common ancestor version is available, from which the two texts to | |
956 | be merged were both derived, Emerge can use it to guess which | |
957 | alternative is right. Wherever one current version agrees with the | |
958 | ancestor, Emerge presumes that the other current version is a deliberate | |
959 | change which should be kept in the merged version. Use the | |
960 | @samp{with-ancestor} commands if you want to specify a common ancestor | |
961 | text. These commands read three file or buffer names---variant A, | |
962 | variant B, and the common ancestor. | |
963 | ||
964 | After the comparison is done and the buffers are prepared, the | |
965 | interactive merging starts. You control the merging by typing special | |
966 | @dfn{merge commands} in the merge buffer. The merge buffer shows you a | |
967 | full merged text, not just differences. For each run of differences | |
968 | between the input texts, you can choose which one of them to keep, or | |
969 | edit them both together. | |
970 | ||
971 | The merge buffer uses a special major mode, Emerge mode, with commands | |
972 | for making these choices. But you can also edit the buffer with | |
973 | ordinary Emacs commands. | |
974 | ||
975 | At any given time, the attention of Emerge is focused on one | |
976 | particular difference, called the @dfn{selected} difference. This | |
977 | difference is marked off in the three buffers like this: | |
978 | ||
979 | @example | |
980 | vvvvvvvvvvvvvvvvvvvv | |
981 | @var{text that differs} | |
982 | ^^^^^^^^^^^^^^^^^^^^ | |
983 | @end example | |
984 | ||
985 | @noindent | |
986 | Emerge numbers all the differences sequentially and the mode | |
987 | line always shows the number of the selected difference. | |
988 | ||
989 | Normally, the merge buffer starts out with the A version of the text. | |
990 | But when the A version of a difference agrees with the common ancestor, | |
991 | then the B version is initially preferred for that difference. | |
992 | ||
993 | Emerge leaves the merged text in the merge buffer when you exit. At | |
994 | that point, you can save it in a file with @kbd{C-x C-w}. If you give a | |
995 | numeric argument to @code{emerge-files} or | |
996 | @code{emerge-files-with-ancestor}, it reads the name of the output file | |
997 | using the minibuffer. (This is the last file name those commands read.) | |
998 | Then exiting from Emerge saves the merged text in the output file. | |
999 | ||
1000 | Normally, Emerge commands save the output buffer in its file when you | |
1001 | exit. If you abort Emerge with @kbd{C-]}, the Emerge command does not | |
1002 | save the output buffer, but you can save it yourself if you wish. | |
1003 | ||
1004 | @node Submodes of Emerge | |
1005 | @subsection Submodes of Emerge | |
1006 | ||
1007 | You can choose between two modes for giving merge commands: Fast mode | |
1008 | and Edit mode. In Fast mode, basic merge commands are single | |
1009 | characters, but ordinary Emacs commands are disabled. This is | |
1010 | convenient if you use only merge commands. In Edit mode, all merge | |
1011 | commands start with the prefix key @kbd{C-c C-c}, and the normal Emacs | |
1012 | commands are also available. This allows editing the merge buffer, but | |
1013 | slows down Emerge operations. | |
1014 | ||
1015 | Use @kbd{e} to switch to Edit mode, and @kbd{C-c C-c f} to switch to | |
1016 | Fast mode. The mode line indicates Edit and Fast modes with @samp{E} | |
1017 | and @samp{F}. | |
1018 | ||
1019 | Emerge has two additional submodes that affect how particular merge | |
1020 | commands work: Auto Advance mode and Skip Prefers mode. | |
1021 | ||
1022 | If Auto Advance mode is in effect, the @kbd{a} and @kbd{b} commands | |
1023 | advance to the next difference. This lets you go through the merge | |
1024 | faster as long as you simply choose one of the alternatives from the | |
1025 | input. The mode line indicates Auto Advance mode with @samp{A}. | |
1026 | ||
1027 | If Skip Prefers mode is in effect, the @kbd{n} and @kbd{p} commands | |
1028 | skip over differences in states prefer-A and prefer-B (@pxref{State of | |
1029 | Difference}). Thus you see only differences for which neither version | |
1030 | is presumed ``correct.'' The mode line indicates Skip Prefers mode with | |
1031 | @samp{S}. | |
1032 | ||
1033 | @findex emerge-auto-advance-mode | |
1034 | @findex emerge-skip-prefers-mode | |
1035 | Use the command @kbd{s a} (@code{emerge-auto-advance-mode}) to set or | |
1036 | clear Auto Advance mode. Use @kbd{s s} | |
1037 | (@code{emerge-skip-prefers-mode}) to set or clear Skip Prefers mode. | |
1038 | These commands turn on the mode with a positive argument, turns it off | |
1039 | with a negative or zero argument, and toggle the mode with no argument. | |
1040 | ||
1041 | @node State of Difference | |
1042 | @subsection State of a Difference | |
1043 | ||
1044 | In the merge buffer, a difference is marked with lines of @samp{v} and | |
1045 | @samp{^} characters. Each difference has one of these seven states: | |
1046 | ||
1047 | @table @asis | |
1048 | @item A | |
1049 | The difference is showing the A version. The @kbd{a} command always | |
1050 | produces this state; the mode line indicates it with @samp{A}. | |
1051 | ||
1052 | @item B | |
1053 | The difference is showing the B version. The @kbd{b} command always | |
1054 | produces this state; the mode line indicates it with @samp{B}. | |
1055 | ||
1056 | @item default-A | |
1057 | @itemx default-B | |
1058 | The difference is showing the A or the B state by default, because you | |
1059 | haven't made a choice. All differences start in the default-A state | |
1060 | (and thus the merge buffer is a copy of the A buffer), except those for | |
1061 | which one alternative is ``preferred'' (see below). | |
1062 | ||
1063 | When you select a difference, its state changes from default-A or | |
1064 | default-B to plain A or B. Thus, the selected difference never has | |
1065 | state default-A or default-B, and these states are never displayed in | |
1066 | the mode line. | |
1067 | ||
1068 | The command @kbd{d a} chooses default-A as the default state, and @kbd{d | |
1069 | b} chooses default-B. This chosen default applies to all differences | |
1070 | which you haven't ever selected and for which no alternative is preferred. | |
1071 | If you are moving through the merge sequentially, the differences you | |
1072 | haven't selected are those following the selected one. Thus, while | |
1073 | moving sequentially, you can effectively make the A version the default | |
1074 | for some sections of the merge buffer and the B version the default for | |
1075 | others by using @kbd{d a} and @kbd{d b} between sections. | |
1076 | ||
1077 | @item prefer-A | |
1078 | @itemx prefer-B | |
1079 | The difference is showing the A or B state because it is | |
1080 | @dfn{preferred}. This means that you haven't made an explicit choice, | |
1081 | but one alternative seems likely to be right because the other | |
1082 | alternative agrees with the common ancestor. Thus, where the A buffer | |
1083 | agrees with the common ancestor, the B version is preferred, because | |
1084 | chances are it is the one that was actually changed. | |
1085 | ||
1086 | These two states are displayed in the mode line as @samp{A*} and @samp{B*}. | |
1087 | ||
1088 | @item combined | |
1089 | The difference is showing a combination of the A and B states, as a | |
1090 | result of the @kbd{x c} or @kbd{x C} commands. | |
1091 | ||
1092 | Once a difference is in this state, the @kbd{a} and @kbd{b} commands | |
1093 | don't do anything to it unless you give them a numeric argument. | |
1094 | ||
1095 | The mode line displays this state as @samp{comb}. | |
1096 | @end table | |
1097 | ||
1098 | @node Merge Commands | |
1099 | @subsection Merge Commands | |
1100 | ||
1101 | Here are the Merge commands for Fast mode; in Edit mode, precede them | |
1102 | with @kbd{C-c C-c}: | |
1103 | ||
1104 | @table @kbd | |
1105 | @item p | |
1106 | Select the previous difference. | |
1107 | ||
1108 | @item n | |
1109 | Select the next difference. | |
1110 | ||
1111 | @item a | |
1112 | Choose the A version of this difference. | |
1113 | ||
1114 | @item b | |
1115 | Choose the B version of this difference. | |
1116 | ||
1117 | @item C-u @var{n} j | |
1118 | Select difference number @var{n}. | |
1119 | ||
1120 | @item . | |
1121 | Select the difference containing point. You can use this command in the | |
1122 | merge buffer or in the A or B buffer. | |
1123 | ||
1124 | @item q | |
1125 | Quit---finish the merge. | |
1126 | ||
1127 | @item C-] | |
1128 | Abort---exit merging and do not save the output. | |
1129 | ||
1130 | @item f | |
1131 | Go into Fast mode. (In Edit mode, this is actually @kbd{C-c C-c f}.) | |
1132 | ||
1133 | @item e | |
1134 | Go into Edit mode. | |
1135 | ||
1136 | @item l | |
1137 | Recenter (like @kbd{C-l}) all three windows. | |
1138 | ||
1139 | @item - | |
1140 | Specify part of a prefix numeric argument. | |
1141 | ||
1142 | @item @var{digit} | |
1143 | Also specify part of a prefix numeric argument. | |
1144 | ||
1145 | @item d a | |
1146 | Choose the A version as the default from here down in | |
1147 | the merge buffer. | |
1148 | ||
1149 | @item d b | |
1150 | Choose the B version as the default from here down in | |
1151 | the merge buffer. | |
1152 | ||
1153 | @item c a | |
1154 | Copy the A version of this difference into the kill ring. | |
1155 | ||
1156 | @item c b | |
1157 | Copy the B version of this difference into the kill ring. | |
1158 | ||
1159 | @item i a | |
1160 | Insert the A version of this difference at point. | |
1161 | ||
1162 | @item i b | |
1163 | Insert the B version of this difference at point. | |
1164 | ||
1165 | @item m | |
1166 | Put point and mark around the difference. | |
1167 | ||
1168 | @item ^ | |
1169 | Scroll all three windows down (like @kbd{M-v}). | |
1170 | ||
1171 | @item v | |
1172 | Scroll all three windows up (like @kbd{C-v}). | |
1173 | ||
1174 | @item < | |
1175 | Scroll all three windows left (like @kbd{C-x <}). | |
1176 | ||
1177 | @item > | |
1178 | Scroll all three windows right (like @kbd{C-x >}). | |
1179 | ||
1180 | @item | | |
1181 | Reset horizontal scroll on all three windows. | |
1182 | ||
1183 | @item x 1 | |
1184 | Shrink the merge window to one line. (Use @kbd{C-u l} to restore it | |
1185 | to full size.) | |
1186 | ||
1187 | @item x c | |
1188 | Combine the two versions of this difference (@pxref{Combining in | |
1189 | Emerge}). | |
1190 | ||
1191 | @item x f | |
1192 | Show the names of the files/buffers Emerge is operating on, in a Help | |
1193 | window. (Use @kbd{C-u l} to restore windows.) | |
1194 | ||
1195 | @item x j | |
1196 | Join this difference with the following one. | |
1197 | (@kbd{C-u x j} joins this difference with the previous one.) | |
1198 | ||
1199 | @item x s | |
1200 | Split this difference into two differences. Before you use this | |
1201 | command, position point in each of the three buffers at the place where | |
1202 | you want to split the difference. | |
1203 | ||
1204 | @item x t | |
1205 | Trim identical lines off the top and bottom of the difference. | |
1206 | Such lines occur when the A and B versions are | |
1207 | identical but differ from the ancestor version. | |
1208 | @end table | |
1209 | ||
1210 | @node Exiting Emerge | |
1211 | @subsection Exiting Emerge | |
1212 | ||
1213 | The @kbd{q} command (@code{emerge-quit}) finishes the merge, storing | |
1214 | the results into the output file if you specified one. It restores the | |
1215 | A and B buffers to their proper contents, or kills them if they were | |
1216 | created by Emerge and you haven't changed them. It also disables the | |
1217 | Emerge commands in the merge buffer, since executing them later could | |
1218 | damage the contents of the various buffers. | |
1219 | ||
1220 | @kbd{C-]} aborts the merge. This means exiting without writing the | |
1221 | output file. If you didn't specify an output file, then there is no | |
1222 | real difference between aborting and finishing the merge. | |
1223 | ||
1224 | If the Emerge command was called from another Lisp program, then its | |
1225 | return value is @code{t} for successful completion, or @code{nil} if you | |
1226 | abort. | |
1227 | ||
1228 | @node Combining in Emerge | |
1229 | @subsection Combining the Two Versions | |
1230 | ||
1231 | Sometimes you want to keep @emph{both} alternatives for a particular | |
1232 | difference. To do this, use @kbd{x c}, which edits the merge buffer | |
1233 | like this: | |
1234 | ||
1235 | @example | |
1236 | @group | |
1237 | #ifdef NEW | |
1238 | @var{version from A buffer} | |
1239 | #else /* not NEW */ | |
1240 | @var{version from B buffer} | |
1241 | #endif /* not NEW */ | |
1242 | @end group | |
1243 | @end example | |
1244 | ||
1245 | @noindent | |
1246 | @vindex emerge-combine-versions-template | |
1247 | While this example shows C preprocessor conditionals delimiting the two | |
1248 | alternative versions, you can specify the strings to use by setting | |
1249 | the variable @code{emerge-combine-versions-template} to a string of your | |
1250 | choice. In the string, @samp{%a} says where to put version A, and | |
1251 | @samp{%b} says where to put version B. The default setting, which | |
1252 | produces the results shown above, looks like this: | |
1253 | ||
1254 | @example | |
1255 | @group | |
1256 | "#ifdef NEW\n%a#else /* not NEW */\n%b#endif /* not NEW */\n" | |
1257 | @end group | |
1258 | @end example | |
1259 | ||
1260 | @node Fine Points of Emerge | |
1261 | @subsection Fine Points of Emerge | |
1262 | ||
1263 | During the merge, you mustn't try to edit the A and B buffers yourself. | |
1264 | Emerge modifies them temporarily, but ultimately puts them back the way | |
1265 | they were. | |
1266 | ||
1267 | You can have any number of merges going at once---just don't use any one | |
1268 | buffer as input to more than one merge at once, since the temporary | |
1269 | changes made in these buffers would get in each other's way. | |
1270 | ||
1271 | Starting Emerge can take a long time because it needs to compare the | |
1272 | files fully. Emacs can't do anything else until @code{diff} finishes. | |
1273 | Perhaps in the future someone will change Emerge to do the comparison in | |
1274 | the background when the input files are large---then you could keep on | |
1275 | doing other things with Emacs until Emerge is ready to accept | |
1276 | commands. | |
1277 | ||
1278 | @vindex emerge-startup-hook | |
1279 | After setting up the merge, Emerge runs the hook | |
1280 | @code{emerge-startup-hook} (@pxref{Hooks}). | |
ab5796a9 MB |
1281 | |
1282 | @ignore | |
1283 | arch-tag: b9d83dfb-82ea-4ff6-bab5-05a3617091fb | |
1284 | @end ignore |