maintaining.texi 94.9 KB
Newer Older
Glenn Morris's avatar
Glenn Morris committed
1
@c This is part of the Emacs manual.
2
@c Copyright (C) 1985-1987, 1993-1995, 1997, 1999-2012
3
@c   Free Software Foundation, Inc.
Glenn Morris's avatar
Glenn Morris committed
4 5 6 7 8
@c See file emacs.texi for copying conditions.
@node Maintaining, Abbrevs, Building, Top
@chapter Maintaining Large Programs

  This chapter describes Emacs features for maintaining large
Glenn Morris's avatar
Glenn Morris committed
9 10 11 12
programs.  If you are maintaining a large Lisp program, then in
addition to the features described here, you may find
the @file{ERT} (``Emacs Lisp Regression Testing'') library useful
(@pxref{Top,,ERT,ert, Emacs Lisp Regression Testing}).
Glenn Morris's avatar
Glenn Morris committed
13 14

@menu
15
* Version Control::     Using version control systems.
16 17 18
* Change Log::          Maintaining a change history for your program.
* Tags::                Go directly to any function in your program in one
                          command.  Tags remembers which file it is in.
19
* EDE::                 An integrated development environment for Emacs.
Glenn Morris's avatar
Glenn Morris committed
20 21 22 23 24
@ifnottex
* Emerge::              A convenient way of merging two versions of a program.
@end ifnottex
@end menu

25 26 27 28
@node Version Control
@section Version Control
@cindex version control

29
  A @dfn{version control system} is a program that can record multiple
30
versions of a source file, storing information such as the creation
31 32 33 34 35 36 37 38 39 40 41 42
time of each version, who made it, and a description of what was
changed.

  The Emacs version control interface is called @dfn{VC}.  VC commands
work with several different version control systems; currently, it
supports GNU Arch, Bazaar, CVS, Git, Mercurial, Monotone, RCS,
SCCS/CSSC, and Subversion.  Of these, the GNU project distributes CVS,
Arch, RCS, and Bazaar.

  VC is enabled automatically whenever you visit a file governed by a
version control system.  To disable VC entirely, set the customizable
variable @code{vc-handled-backends} to @code{nil}
43 44 45 46 47 48 49 50 51 52 53
@iftex
(@pxref{Customizing VC,,,emacs-xtra, Specialized Emacs Features}).
@end iftex
@ifnottex
(@pxref{Customizing VC}).
@end ifnottex

@menu
* Introduction to VC::  How version control works in general.
* VC Mode Line::        How the mode line shows version control status.
* Basic VC Editing::    How to edit a file under version control.
54
* Log Buffer::          Features available in log entry buffers.
55
* Registering::         Putting a file under version control.
56
* Old Revisions::       Examining and comparing old versions.
57 58
* VC Change Log::       Viewing the VC Change Log.
* VC Undo::             Canceling changes before or after committing.
59 60 61 62 63 64 65 66 67 68 69 70
* VC Directory Mode::   Listing files managed by version control.
* Branches::            Multiple lines of development.
@ifnottex
* Miscellaneous VC::    Various other commands and features of VC.
* Customizing VC::      Variables that change VC's behavior.
@end ifnottex
@end menu

@node Introduction to VC
@subsection Introduction to Version Control

  VC allows you to use a version control system from within Emacs,
71 72 73 74 75 76
integrating the version control operations smoothly with editing.  It
provides a uniform interface for common operations in many version
control operations.

  Some uncommon or intricate version control operations, such as
altering repository settings, are not supported in VC.  You should
77
perform such tasks outside Emacs, e.g.@: via the command line.
78 79 80 81 82 83 84

  This section provides a general overview of version control, and
describes the version control systems that VC supports.  You can skip
this section if you are already familiar with the version control system
you want to use.

@menu
85
* Why Version Control?::    Understanding the problems it addresses.
86 87
* Version Control Systems:: Supported version control back-end systems.
* VCS Concepts::            Words and concepts related to version control.
88 89 90
* VCS Merging::             How file conflicts are handled.
* VCS Changesets::          How changes are grouped.
* VCS Repositories::        Where version control repositories are stored.
91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121
* Types of Log File::       The VCS log in contrast to the ChangeLog.
@end menu

@node Why Version Control?
@subsubsection Understanding the problems it addresses

  Version control systems provide you with three important
capabilities:

@itemize @bullet
@item
@dfn{Reversibility}: the ability to back up to a previous state if you
discover that some modification you did was a mistake or a bad idea.

@item
@dfn{Concurrency}: the ability to have many people modifying the same
collection of files knowing that conflicting modifications can be
detected and resolved.

@item
@dfn{History}: the ability to attach historical data to your data,
such as explanatory comments about the intention behind each change to
it.  Even for a programmer working solo, change histories are an
important aid to memory; for a multi-person project, they are a
vitally important form of communication among developers.
@end itemize

@node Version Control Systems
@subsubsection Supported Version Control Systems

@cindex back end (version control)
122 123
  VC currently works with many different version control systems,
which it refers to as @dfn{back ends}:
124 125 126 127 128 129 130

@itemize @bullet

@cindex SCCS
@item
SCCS was the first version control system ever built, and was long ago
superseded by more advanced ones.  VC compensates for certain features
131
missing in SCCS (e.g.@: tag names for releases) by implementing them
132 133 134 135 136 137 138 139 140 141 142 143
itself.  Other VC features, such as multiple branches, are simply
unavailable.  Since SCCS is non-free, we recommend avoiding it.

@cindex CSSC
@item
CSSC is a free replacement for SCCS.  You should use CSSC only if, for
some reason, you cannot use a more recent and better-designed version
control system.

@cindex RCS
@item
RCS is the free version control system around which VC was initially
144 145 146
built.  It is relatively primitive: it cannot be used over the
network, and works at the level of individual files.  Almost
everything you can do with RCS can be done through VC.
147 148 149 150 151 152

@cindex CVS
@item
CVS is the free version control system that was, until recently (circa
2008), used by the majority of free software projects.  Nowadays, it
is slowly being superseded by newer systems.  CVS allows concurrent
153 154 155
multi-user development either locally or over the network.  Unlike
newer systems, it lacks support for atomic commits and file
moving/renaming.  VC supports all basic editing operations under CVS.
156 157 158 159

@cindex SVN
@cindex Subversion
@item
160
Subversion (svn) is a free version control system designed to be
161 162 163
similar to CVS but without its problems (e.g., it supports atomic
commits of filesets, and versioning of directories, symbolic links,
meta-data, renames, copies, and deletes).
164 165 166 167

@cindex GNU Arch
@cindex Arch
@item
168
GNU Arch is one of the earliest @dfn{decentralized} version control
169
systems (the other being Monotone).  @xref{VCS Concepts}, for a
170
description of decentralized version control systems.  It is no longer
171
under active development, and has been deprecated in favor of Bazaar.
172 173 174

@cindex git
@item
175
Git is a decentralized version control system originally invented by
176
Linus Torvalds to support development of Linux (his kernel).  VC
177
supports many common Git operations, but others, such as repository
178
syncing, must be done from the command line.
179 180 181 182

@cindex hg
@cindex Mercurial
@item
183
Mercurial (hg) is a decentralized version control system broadly
184
resembling Git.  VC supports most Mercurial commands, with the
185
exception of repository sync operations.
186 187 188 189

@cindex bzr
@cindex Bazaar
@item
190 191
Bazaar (bzr) is a decentralized version control system that supports
both repository-based and decentralized versioning.  VC supports most
192
basic editing operations under Bazaar.
193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208
@end itemize

@node VCS Concepts
@subsubsection Concepts of Version Control

@cindex repository
@cindex registered file
   When a file is under version control, we say that it is
@dfn{registered} in the version control system.  The system has a
@dfn{repository} which stores both the file's present state and its
change history---enough to reconstruct the current version or any
earlier version.  The repository also contains other information, such
as @dfn{log entries} that describe the changes made to each file.

@cindex work file
@cindex checking out files
209 210 211
  The copy of a version-controlled file that you actually edit is
called the @dfn{work file}.  You can change each work file as you
would an ordinary file.  After you are done with a set of changes, you
212 213
may @dfn{commit} (or @dfn{check in}) the changes; this records the
changes in the repository, along with a descriptive log entry.
214

215 216 217
@cindex working tree
  A directory tree of work files is called a @dfn{working tree}.

218 219
@cindex revision
@cindex revision ID
220 221 222 223 224
  Each commit creates a new @dfn{revision} in the repository.  The
version control system keeps track of all past revisions and the
changes that were made in each revision.  Each revision is named by a
@dfn{revision ID}, whose format depends on the version control system;
in the simplest case, it is just an integer.
225 226

  To go beyond these basic concepts, you will need to understand three
227 228 229 230
aspects in which version control systems differ.  As explained in the
next three sections, they can be lock-based or merge-based; file-based
or changeset-based; and centralized or decentralized.  VC handles all
these modes of operation, but it cannot hide the differences.
231

232 233 234
@node VCS Merging
@subsubsection Merge-based vs lock-based Version Control

235 236 237 238
  A version control system typically has some mechanism to coordinate
between users who want to change the same file.  There are two ways to
do this: merging and locking.

239
@cindex merging-based version
240 241 242 243
  In a version control system that uses merging, each user may modify
a work file at any time.  The system lets you @dfn{merge} your work
file, which may contain changes that have not been committed, with the
latest changes that others have committed.
244

245
@cindex locking-based version
246 247 248 249 250 251
  Older version control systems use a @dfn{locking} scheme instead.
Here, work files are normally read-only.  To edit a file, you ask the
version control system to make it writable for you by @dfn{locking}
it; only one user can lock a given file at any given time.  This
procedure is analogous to, but different from, the locking that Emacs
uses to detect simultaneous editing of ordinary files
252
(@pxref{Interlocking}).  When you commit your changes, that unlocks
253 254 255 256 257 258 259
the file, and the work file becomes read-only again.  Other users may
then lock the file to make their own changes.

  Both locking and merging systems can have problems when multiple
users try to modify the same file at the same time.  Locking systems
have @dfn{lock conflicts}; a user may try to check a file out and be
unable to because it is locked.  In merging systems, @dfn{merge
260 261
conflicts} happen when you commit a change to a file that conflicts
with a change committed by someone else after your checkout.  Both
262
kinds of conflict have to be resolved by human judgment and
263 264 265
communication.  Experience has shown that merging is superior to
locking, both in convenience to developers and in minimizing the
number and severity of conflicts that actually occur.
266 267 268 269

  SCCS always uses locking.  RCS is lock-based by default but can be
told to operate in a merging style.  CVS and Subversion are
merge-based by default but can be told to operate in a locking mode.
270
Decentralized version control systems, such as GNU Arch, Git, and
271
Mercurial, are exclusively merging-based.
272

273
  VC mode supports both locking and merging version control.  The
274 275 276 277 278 279 280
terms ``commit'' and ``update'' are used in newer version control
systems; older lock-based systems use the terms ``check in'' and
``check out''.  VC hides the differences between them as much as
possible.

@node VCS Changesets
@subsubsection Changeset-based vs File-based Version Control
281

282
@cindex file-based version control
283 284
  On SCCS, RCS, CVS, and other early version control systems, version
control operations are @dfn{file-based}: each file has its own comment
285 286
and revision history separate from that of all other files.  Newer
systems, beginning with Subversion, are @dfn{changeset-based}: a
287
commit may include changes to several files, and the entire set of
288 289
changes is handled as a unit.  Any comment associated with the change
does not belong to a single file, but to the changeset itself.
290

291
@cindex changeset-based version control
292 293 294
  Changeset-based version control is more flexible and powerful than
file-based version control; usually, when a change to multiple files
has to be reversed, it's good to be able to easily identify and remove
295
all of it.
296

297 298 299 300 301
@node VCS Repositories
@subsubsection Decentralized vs Centralized Repositories

@cindex centralized version control
@cindex decentralized version control
302
@cindex distributed version control
303 304 305
  Early version control systems were designed around a
@dfn{centralized} model in which each project has only one repository
used by all developers.  SCCS, RCS, CVS, and Subversion share this
306 307
kind of model.  One of its drawbacks is that the repository is a choke
point for reliability and efficiency.
308

309 310 311 312 313 314 315
  GNU Arch pioneered the concept of @dfn{distributed} or
@dfn{decentralized} version control, later implemented in Git,
Mercurial, and Bazaar.  A project may have several different
repositories, and these systems support a sort of super-merge between
repositories that tries to reconcile their change histories.  In
effect, there is one repository for each developer, and repository
merges take the place of commit operations.
316

317 318 319
  VC helps you manage the traffic between your personal workfiles and
a repository.  Whether the repository is a single master, or one of a
network of peer repositories, is not something VC has to care about.
320 321 322 323 324 325 326 327 328

@node Types of Log File
@subsubsection Types of Log File
@cindex types of log file
@cindex log File, types of
@cindex version control log

  Projects that use a version control system can have two types of log
for changes.  One is the log maintained by the version control system:
329 330 331
each time you commit a change, you fill out a @dfn{log entry} for the
change (@pxref{Log Buffer}).  This is called the @dfn{version control
log}.
332 333 334 335 336 337

  The other kind of log is the file @file{ChangeLog} (@pxref{Change
Log}).  It provides a chronological record of all changes to a large
portion of a program---typically one directory and its subdirectories.
A small program would use one @file{ChangeLog} file; a large program
may have a @file{ChangeLog} file in each major directory.
338 339 340 341 342 343 344 345
@xref{Change Log}.  Programmers have used change logs since long
before version control systems.

  Changeset-based version systems typically maintain a changeset-based
modification log for the entire system, which makes change log files
somewhat redundant.  One advantage that they retain is that it is
sometimes useful to be able to view the transaction history of a
single directory separately from those of other directories.
346 347 348 349 350 351 352 353 354

  A project maintained with version control can use just the version
control log, or it can use both kinds of logs.  It can handle some
files one way and some files the other way.  Each project has its
policy, which you should follow.

  When the policy is to use both, you typically want to write an entry
for each change just once, then put it into both logs.  You can write
the entry in @file{ChangeLog}, then copy it to the log buffer with
355 356 357
@kbd{C-c C-a} when committing the change (@pxref{Log Buffer}).  Or you
can write the entry in the log buffer while committing the change, and
later use the @kbd{C-x v a} command to copy it to @file{ChangeLog}
358 359 360 361 362 363 364 365 366
@iftex
(@pxref{Change Logs and VC,,,emacs-xtra, Specialized Emacs Features}).
@end iftex
@ifnottex
(@pxref{Change Logs and VC}).
@end ifnottex

@node VC Mode Line
@subsection Version Control and the Mode Line
367
@cindex VC mode line indicator
368 369

  When you visit a file that is under version control, Emacs indicates
370 371
this on the mode line.  For example, @samp{Bzr-1223} says that Bazaar
is used for that file, and the current revision ID is 1223.
372

373
@cindex version control status
374
  The character between the back-end name and the revision ID
375 376 377 378 379 380 381 382
indicates the @dfn{version control status} of the work file.  In a
merge-based version control system, a @samp{-} character indicates
that the work file is unmodified, and @samp{:} indicates that it has
been modified.  @samp{!} indicates that the file contains conflicts as
result of a recent merge operation (@pxref{Merging}), or that the file
was removed from the version control.  Finally, @samp{?}  means that
the file is under version control, but is missing from the working
tree.
383 384 385

  In a lock-based system, @samp{-} indicates an unlocked file, and
@samp{:} a locked file; if the file is locked by another user (for
386
instance, @samp{jim}), that is displayed as @samp{RCS:jim:1.3}.
387
@samp{@@} means that the file was locally added, but not yet committed
388
to the master repository.
389 390 391 392

  On a graphical display, you can move the mouse over this mode line
indicator to pop up a ``tool-tip'', which displays a more verbose
description of the version control status.  Pressing @kbd{Mouse-1}
393 394
over the indicator pops up a menu of VC commands, identical to
@samp{Tools / Version Control} on the menu bar.
395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410

@vindex auto-revert-check-vc-info
  When Auto Revert mode (@pxref{Reverting}) reverts a buffer that is
under version control, it updates the version control information in
the mode line.  However, Auto Revert mode may not properly update this
information if the version control status changes without changes to
the work file, from outside the current Emacs session.  If you set
@code{auto-revert-check-vc-info} to @code{t}, Auto Revert mode updates
the version control status information every
@code{auto-revert-interval} seconds, even if the work file itself is
unchanged.  The resulting CPU usage depends on the version control
system, but is usually not excessive.

@node Basic VC Editing
@subsection Basic Editing under Version Control

411
@cindex filesets, VC
412
@cindex VC filesets
413
   Most VC commands operate on @dfn{VC filesets}.  A VC fileset is a
414 415 416 417
collection of one or more files that a VC operation acts on.  When you
type VC commands in a buffer visiting a version-controlled file, the
VC fileset is simply that one file.  When you type them in a VC
Directory buffer, and some files in it are marked, the VC fileset
418 419
consists of the marked files (@pxref{VC Directory Mode}).

420 421 422 423 424 425 426
  On modern changeset-based version control systems (@pxref{VCS
Changesets}), VC commands handle multi-file VC filesets as a group.
For example, committing a multi-file VC fileset generates a single
revision, containing the changes to all those files.  On older
file-based version control systems like CVS, each file in a multi-file
VC fileset is handled individually; for example, a commit generates
one revision for each changed file.
427 428 429

@table @kbd
@itemx C-x v v
430 431
Perform the next appropriate version control operation on the current
VC fileset.
432 433 434 435
@end table

@findex vc-next-action
@kindex C-x v v
436
  The principal VC command is a multi-purpose command, @kbd{C-x v v}
437 438 439 440 441 442 443 444 445 446 447
(@code{vc-next-action}), which performs the ``most appropriate''
action on the current VC fileset: either registering it with a version
control system, or committing it, or unlocking it, or merging changes
into it.  The precise actions are described in detail in the following
subsections.  You can use @kbd{C-x v v} either in a file-visiting
buffer or in a VC Directory buffer.

  Note that VC filesets are distinct from the ``named filesets'' used
for viewing and visiting files in functional groups
(@pxref{Filesets}).  Unlike named filesets, VC filesets are not named
and don't persist across sessions.
448 449 450 451 452 453 454 455 456 457

@menu
* VC With A Merging VCS::  Without locking: default mode for CVS.
* VC With A Locking VCS::  RCS in its default mode, SCCS, and optionally CVS.
* Advanced C-x v v::       Advanced features available with a prefix argument.
@end menu

@node VC With A Merging VCS
@subsubsection Basic Version Control with Merging

458 459
  On a merging-based version control system (i.e.@: most modern ones;
@pxref{VCS Merging}), @kbd{C-x v v} does the following:
460 461 462

@itemize @bullet
@item
463
If there is more than one file in the VC fileset and the files have
464 465 466
inconsistent version control statuses, signal an error.  (Note,
however, that a fileset is allowed to include both ``newly-added''
files and ``modified'' files; @pxref{Registering}.)
467 468

@item
469 470 471 472 473
If none of the files in the VC fileset are registered with a version
control system, register the VC fileset, i.e.@: place it under version
control.  @xref{Registering}.  If Emacs cannot find a system to
register under, it prompts for a repository type, creates a new
repository, and registers the VC fileset with it.
474 475

@item
476
If every work file in the VC fileset is unchanged, do nothing.
477 478

@item
479
If every work file in the VC fileset has been modified, commit the
480
changes.  To do this, Emacs pops up a @file{*vc-log*} buffer; type the
481
desired log entry for the new revision, followed by @kbd{C-c C-c} to
482
commit.  @xref{Log Buffer}.
483 484 485

If committing to a shared repository, the commit may fail if the
repository that has been changed since your last update.  In that
486 487 488 489 490
case, you must perform an update before trying again.  On a
decentralized version control system, use @kbd{C-x v +} (@pxref{VC
Pull}) or @kbd{C-x v m} (@pxref{Merging}).  On a centralized version
control system, type @kbd{C-x v v} again to merge in the repository
changes.
491 492

@item
493 494 495
Finally, if you are using a centralized version control system, check
if each work file in the VC fileset is up-to-date.  If any file has
been changed in the repository, offer to update it.
496 497 498
@end itemize

  These rules also apply when you use RCS in its ``non-locking'' mode,
499
except that changes are not automatically merged from the repository.
500 501
Nothing informs you if another user has committed changes in the same
file since you began editing it; when you commit your revision, his
502 503
changes are removed (however, they remain in the repository and are
thus not irrevocably lost).  Therefore, you must verify that the
504
current revision is unchanged before committing your changes.  In
505 506 507
addition, locking is possible with RCS even in this mode: @kbd{C-x v
v} with an unmodified file locks the file, just as it does with RCS in
its normal locking mode (@pxref{VC With A Locking VCS}).
508 509 510 511

@node VC With A Locking VCS
@subsubsection Basic Version Control with Locking

512 513
  On a locking-based version control system (such as SCCS, and RCS in
its default mode), @kbd{C-x v v} does the following:
514

515
@itemize @bullet
516
@item
517
If there is more than one file in the VC fileset and the files have
518
inconsistent version control statuses, signal an error.
519 520 521

@item
If each file in the VC fileset is not registered with a version
522 523 524 525
control system, register the VC fileset.  @xref{Registering}.  If
Emacs cannot find a system to register under, it prompts for a
repository type, creates a new repository, and registers the VC
fileset with it.
526 527

@item
Paul Eggert's avatar
Paul Eggert committed
528
If each file is registered and unlocked, lock it and make it writable,
529
so that you can begin to edit it.
530 531

@item
532
If each file is locked by you and contains changes, commit the
533
changes.  To do this, Emacs pops up a @file{*vc-log*} buffer; type the
534 535
desired log entry for the new revision, followed by @kbd{C-c C-c} to
commit (@pxref{Log Buffer}).
536 537

@item
538 539
If each file is locked by you, but you have not changed it, release
the lock and make the file read-only again.
540 541

@item
542 543 544 545
If each file is locked by another user, ask whether you want to
``steal the lock''.  If you say yes, the file becomes locked by you,
and a warning message is sent to the user who had formerly locked the
file.
546 547 548
@end itemize

  These rules also apply when you use CVS in locking mode, except
549
that CVS does not support stealing locks.
550 551 552 553

@node Advanced C-x v v
@subsubsection Advanced Control in @kbd{C-x v v}

554
@cindex revision ID in version control
555 556 557 558 559 560 561
  When you give a prefix argument to @code{vc-next-action} (@kbd{C-u
C-x v v}), it still performs the next logical version control
operation, but accepts additional arguments to specify precisely how
to do the operation.

@itemize @bullet
@item
562 563 564 565
@cindex specific version control system
You can specify the name of a version control system.  This is useful
if the fileset can be managed by more than one version control system,
and Emacs fails to detect the correct one.
566 567

@item
568
Otherwise, if using CVS or RCS, you can specify a revision ID.
569

570 571 572
If the fileset is modified (or locked), this makes Emacs commit with
that revision ID.  You can create a new branch by supplying an
appropriate revision ID (@pxref{Branches}).
573

574 575 576 577 578 579 580 581 582
If the fileset is unmodified (and unlocked), this checks the specified
revision into the working tree.  You can also specify a revision on
another branch by giving its revision or branch ID (@pxref{Switching
Branches}).  An empty argument (i.e.@: @kbd{C-u C-x v v @key{RET}})
checks out the latest (``head'') revision on the current branch.

This signals an error on a decentralized version control system.
Those systems do not let you specify your own revision IDs, nor do
they use the concept of ``checking out'' individual files.
583 584 585
@end itemize

@node Log Buffer
586 587
@subsection Features of the Log Entry Buffer

588 589 590
@cindex C-c C-c @r{(Log Edit mode)}
@findex log-edit-done
  When you tell VC to commit a change, it pops up a buffer named
591
@file{*vc-log*}.  In this buffer, you should write a @dfn{log entry}
592
describing the changes you have made (@pxref{Why Version Control?}).
593 594
After you are done, type @kbd{C-c C-c} (@code{log-edit-done}) to exit
the buffer and commit the change, together with your log entry.
595

596 597 598
@cindex Log Edit mode
@cindex mode, Log Edit
@vindex vc-log-mode-hook
599
  The major mode for the @file{*vc-log*} buffer is Log Edit mode, a
600 601 602 603
variant of Text mode (@pxref{Text Mode}).  On entering Log Edit mode,
Emacs runs the hooks @code{text-mode-hook} and @code{vc-log-mode-hook}
(@pxref{Hooks}).

604
  In the @file{*vc-log*} buffer, you can write one or more @dfn{header
605 606 607 608 609 610
lines}, specifying additional information to be supplied to the
version control system.  Each header line must occupy a single line at
the top of the buffer; the first line that is not a header line is
treated as the start of the log entry.  For example, the following
header line states that the present change was not written by you, but
by another developer:
611

612 613 614
@smallexample
Author: J. R. Hacker <jrh@@example.com>
@end smallexample
615

616 617 618 619 620
@noindent
Apart from the @samp{Author} header, Emacs recognizes the headers
@samp{Date} (a manually-specified commit time) and @samp{Fixes} (a
reference to a bug fixed by the change).  Not all version control
systems recognize all headers: Bazaar recognizes all three headers,
621
while Git, Mercurial, and Monotone recognize only @samp{Author} and
622 623
@samp{Date}.  If you specify a header for a system that does not
support it, the header is treated as part of the log entry.
624

625
@kindex C-c C-f @r{(Log Edit mode)}
626
@findex log-edit-show-files
627
@kindex C-c C-d @r{(Log Edit mode)}
628
@findex log-edit-show-diff
629
  While in the @file{*vc-log*} buffer, the ``current VC fileset'' is
630 631 632 633 634 635
considered to be the fileset that will be committed if you type
@w{@kbd{C-c C-c}}.  To view a list of the files in the VC fileset,
type @w{@kbd{C-c C-f}} (@code{log-edit-show-files}).  To view a diff
of changes between the VC fileset and the version from which you
started editing (@pxref{Old Revisions}), type @kbd{C-c C-d}
(@code{log-edit-show-diff}).
636

637 638
@kindex C-c C-a @r{(Log Edit mode)}
@findex log-edit-insert-changelog
639 640
  If the VC fileset includes one or more @file{ChangeLog} files
(@pxref{Change Log}), type @kbd{C-c C-a}
641
(@code{log-edit-insert-changelog}) to pull the relevant entries into
642
the @file{*vc-log*} buffer.  If the topmost item in each
643
@file{ChangeLog} was made under your user name on the current date,
644 645
this command searches that item for entries matching the file(s) to be
committed, and inserts them.
646
@ifnottex
647 648 649
If you are using CVS or RCS, see @ref{Change Logs and VC}, for the
opposite way of working---generating ChangeLog entries from the Log
Edit buffer.
650 651
@end ifnottex

652
  To abort a commit, just @strong{don't} type @kbd{C-c C-c} in that
653
buffer.  You can switch buffers and do other editing.  As long as you
654
don't try to make another commit, the entry you were editing remains
655
in the @file{*vc-log*} buffer, and you can go back to that buffer at
656 657 658 659 660 661
any time to complete the commit.

@kindex M-n @r{(Log Edit mode)}
@kindex M-p @r{(Log Edit mode)}
@kindex M-s @r{(Log Edit mode)}
@kindex M-r @r{(Log Edit mode)}
662
  You can also browse the history of previous log entries to duplicate
663 664 665 666 667
a commit comment.  This can be useful when you want to make several
commits with similar comments.  The commands @kbd{M-n}, @kbd{M-p},
@kbd{M-s} and @kbd{M-r} for doing this work just like the minibuffer
history commands (@pxref{Minibuffer History}), except that they are
used outside the minibuffer.
668

669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708
@node Registering
@subsection Registering a File for Version Control

@table @kbd
@item C-x v i
Register the visited file for version control.
@end table

@kindex C-x v i
@findex vc-register
  The command @kbd{C-x v i} (@code{vc-register}) @dfn{registers} each
file in the current VC fileset, placing it under version control.
This is essentially equivalent to the action of @kbd{C-x v v} on an
unregistered VC fileset (@pxref{Basic VC Editing}), except that if the
VC fileset is already registered, @kbd{C-x v i} signals an error
whereas @kbd{C-x v v} performs some other action.

  To register a file, Emacs must choose a version control system.  For
a multi-file VC fileset, the VC Directory buffer specifies the system
to use (@pxref{VC Directory Mode}).  For a single-file VC fileset, if
the file's directory already contains files registered in a version
control system, or if the directory is part of a directory tree
controlled by a version control system, Emacs chooses that system.  In
the event that more than one version control system is applicable,
Emacs uses the one that appears first in the variable
@iftex
@code{vc-handled-backends}.
@end iftex
@ifnottex
@code{vc-handled-backends} (@pxref{Customizing VC}).
@end ifnottex
If Emacs cannot find a version control system to register the file
under, it prompts for a repository type, creates a new repository, and
registers the file into that repository.

  On most version control systems, registering a file with @kbd{C-x v
i} or @kbd{C-x v v} adds it to the ``working tree'' but not to the
repository.  Such files are labeled as @samp{added} in the VC
Directory buffer, and show a revision ID of @samp{@@@@} in the mode
line.  To make the registration take effect in the repository, you
709 710
must perform a commit (@pxref{Basic VC Editing}).  Note that a single
commit can include both file additions and edits to existing files.
711 712 713 714

  On a locking-based version control system (@pxref{VCS Merging}),
registering a file leaves it unlocked and read-only.  Type @kbd{C-x v
v} if you wish to start editing it.
715 716 717 718 719 720

@node Old Revisions
@subsection Examining And Comparing Old Revisions

@table @kbd
@item C-x v =
721 722 723 724 725 726 727
Compare the work files in the current VC fileset with the versions you
started from (@code{vc-diff}).  With a prefix argument, prompt for two
revisions of the current VC fileset and compare them.  You can also
call this command from a Dired buffer (@pxref{Dired}).

@ifnottex
@item M-x vc-ediff
728
Like @kbd{C-x v =}, but using Ediff.  @xref{Top,, Ediff, ediff, The
729
Ediff Manual}.
730
@end ifnottex
731 732

@item C-x v D
733 734 735
Compare the entire working tree to the revision you started from
(@code{vc-root-diff}).  With a prefix argument, prompt for two
revisions and compare their trees.
736 737 738 739

@item C-x v ~
Prompt for a revision of the current file, and visit it in a separate
buffer (@code{vc-revision-other-window}).
740 741

@item C-x v g
742 743
Display an annotated version of the current file: for each line, show
the latest revision in which it was modified (@code{vc-annotate}).
744 745 746 747
@end table

@findex vc-diff
@kindex C-x v =
748 749 750 751 752 753 754
  @kbd{C-x v =} (@code{vc-diff}) displays a @dfn{diff} which compares
each work file in the current VC fileset to the version(s) from which
you started editing.  The diff is displayed in another window, in a
Diff mode buffer (@pxref{Diff Mode}) named @file{*vc-diff*}.  The
usual Diff mode commands are available in this buffer.  In particular,
the @kbd{g} (@code{revert-buffer}) command performs the file
comparison again, generating a new diff.
755

756 757 758
@kindex C-u C-x v =
  To compare two arbitrary revisions of the current VC fileset, call
@code{vc-diff} with a prefix argument: @kbd{C-u C-x v =}.  This
759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776
prompts for two revision IDs (@pxref{VCS Concepts}), and displays a
diff between those versions of the fileset.  This will not work
reliably for multi-file VC filesets, if the version control system is
file-based rather than changeset-based (e.g.@: CVS), since then
revision IDs for different files would not be related in any
meaningful way.

  Instead of the revision ID, some version control systems let you
specify revisions in other formats.  For instance, under Bazaar you
can enter @samp{date:yesterday} for the argument to @kbd{C-u C-x v =}
(and related commands) to specify the first revision committed after
yesterday.  See the documentation of the version control system for
details.

  If you invoke @kbd{C-x v =} or @kbd{C-u C-x v =} from a Dired buffer
(@pxref{Dired}), the file listed on the current line is treated as the
current VC fileset.

777
@ifnottex
778 779
@findex vc-ediff
  @kbd{M-x vc-ediff} works like @kbd{C-x v =}, except that it uses an
780
Ediff session.  @xref{Top,, Ediff, ediff, The Ediff Manual}.
781 782
@end ifnottex

783 784 785
@findex vc-root-diff
@kindex C-x v D
  @kbd{C-x v D} (@code{vc-root-diff}) is similar to @kbd{C-x v =}, but
786 787 788 789
it displays the changes in the entire current working tree (i.e.@: the
working tree containing the current VC fileset).  If you invoke this
command from a Dired buffer, it applies to the working tree containing
the directory.
790

791
@vindex vc-diff-switches
792 793 794 795 796
  You can customize the @command{diff} options that @kbd{C-x v =} and
@kbd{C-x v D} use for generating diffs.  The options used are taken
from the first non-@code{nil} value amongst the variables
@code{vc-@var{backend}-diff-switches}, @code{vc-diff-switches}, and
@code{diff-switches} (@pxref{Comparing Files}), in that order.  Here,
797
@var{backend} stands for the relevant version control system,
798 799 800 801
e.g.@: @code{bzr} for Bazaar.  Since @code{nil} means to check the
next variable in the sequence, either of the first two may use the
value @code{t} to mean no switches at all.  Most of the
@code{vc-@var{backend}-diff-switches} variables default to @code{nil},
802 803 804
but some default to @code{t}; these are for version control systems
whose @code{diff} implementations do not accept common diff options,
such as Subversion.
805 806 807 808 809 810 811 812 813

@findex vc-revision-other-window
@kindex C-x v ~
  To directly examine an older version of a file, visit the work file
and type @kbd{C-x v ~ @var{revision} @key{RET}}
(@code{vc-revision-other-window}).  This retrieves the file version
corresponding to @var{revision}, saves it to
@file{@var{filename}.~@var{revision}~}, and visits it in a separate
window.
814 815 816

@findex vc-annotate
@kindex C-x v g
817 818
  Many version control systems allow you to view files @dfn{annotated}
with per-line revision information, by typing @kbd{C-x v g}
819
(@code{vc-annotate}).  This creates a new buffer (the ``annotate
820 821 822 823 824
buffer'') displaying the file's text, with each line colored to show
how old it is.  Red text is new, blue is old, and intermediate colors
indicate intermediate ages.  By default, the color is scaled over the
full range of ages, such that the oldest changes are blue, and the
newest changes are red.
825 826

  When you give a prefix argument to this command, Emacs reads two
827 828 829
arguments using the minibuffer: the revision to display and annotate
(instead of the current file contents), and the time span in days the
color range should cover.
830 831 832 833 834 835 836 837

  From the annotate buffer, these and other color scaling options are
available from the @samp{VC-Annotate} menu.  In this buffer, you can
also use the following keys to browse the annotations of past revisions,
view diffs, or view log entries:

@table @kbd
@item p
838 839 840
Annotate the previous revision, i.e.@: the revision before the one
currently annotated.  A numeric prefix argument is a repeat count, so
@kbd{C-u 10 p} would take you back 10 revisions.
841 842

@item n
843 844
Annotate the next revision, i.e.@: the revision after the one
currently annotated.  A numeric prefix argument is a repeat count.
845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882

@item j
Annotate the revision indicated by the current line.

@item a
Annotate the revision before the one indicated by the current line.
This is useful to see the state the file was in before the change on
the current line was made.

@item f
Show in a buffer the file revision indicated by the current line.

@item d
Display the diff between the current line's revision and the previous
revision.  This is useful to see what the current line's revision
actually changed in the file.

@item D
Display the diff between the current line's revision and the previous
revision for all files in the changeset (for VC systems that support
changesets).  This is useful to see what the current line's revision
actually changed in the tree.

@item l
Show the log of the current line's revision.  This is useful to see
the author's description of the changes in the revision on the current
line.

@item w
Annotate the working revision--the one you are editing.  If you used
@kbd{p} and @kbd{n} to browse to other revisions, use this key to
return to your working revision.

@item v
Toggle the annotation visibility.  This is useful for looking just at
the file contents without distraction from the annotations.
@end table

883
@node VC Change Log
884
@subsection VC Change Log
885 886 887

@table @kbd
@item C-x v l
888
Display the change history for the current fileset
889 890 891 892 893
(@code{vc-print-log}).

@item C-x v L
Display the change history for the current repository
(@code{vc-print-root-log}).
894 895

@item C-x v I
896
Display the changes that a pull operation will retrieve
897 898 899 900 901
(@code{vc-log-incoming}).

@item C-x v O
Display the changes that will be sent by the next push operation
(@code{vc-log-outgoing}).
902 903 904 905
@end table

@kindex C-x v l
@findex vc-print-log
906
  The command @kbd{C-x v l} (@code{vc-print-log}) displays a buffer
907
named @file{*vc-change-log*}, showing the history of changes made to
908 909
the current file, including who made the changes, the dates, and the
log entry for each change (these are the same log entries you would
910
enter via the @file{*vc-log*} buffer; @pxref{Log Buffer}).  Point is
911 912 913 914 915 916 917
centered at the revision of the file currently being visited.  With a
prefix argument, the command prompts for the revision to center on,
and the maximum number of revisions to display.

  If you call @kbd{C-x v l} from a VC Directory buffer (@pxref{VC
Directory Mode}) or a Dired buffer (@pxref{Dired}), it applies to the
file listed on the current line.
918 919

@findex vc-print-root-log
920 921
@findex log-view-toggle-entry-display
  @kbd{C-x v L} (@code{vc-print-root-log}) displays a
922
@file{*vc-change-log*} buffer showing the history of the entire
923 924 925 926 927
version-controlled directory tree (RCS, SCCS, and CVS do not support
this feature).  With a prefix argument, the command prompts for the
maximum number of revisions to display.

  The @kbd{C-x v L} history is shown in a compact form, usually
928 929
showing only the first line of each log entry.  However, you can type
@key{RET} (@code{log-view-toggle-entry-display}) in the
930
@file{*vc-change-log*} buffer to reveal the entire log entry for the
931
revision at point.  A second @key{RET} hides it again.
932

933
  On a decentralized version control system, the @kbd{C-x v I}
934 935 936
(@code{vc-log-incoming}) command displays a log buffer showing the
changes that will be applied, the next time you run the version
control system's ``pull'' command to get new revisions from another
937 938 939 940 941 942 943
repository (@pxref{VC Pull}).  This other repository is the default
one from which changes are pulled, as defined by the version control
system; with a prefix argument, @code{vc-log-incoming} prompts for a
specific repository.  Similarly, @kbd{C-x v O}
(@code{vc-log-outgoing}) shows the changes that will be sent to
another repository, the next time you run the ``push'' command; with a
prefix argument, it prompts for a specific destination repository.
944

945
  In the @file{*vc-change-log*} buffer, you can use the following keys
946 947
to move between the logs of revisions and of files, and to examine and
compare past revisions (@pxref{Old Revisions}):
948 949 950

@table @kbd
@item p
951
Move to the previous revision entry.  (Revision entries in the log
952 953 954 955 956
buffer are usually in reverse-chronological order, so the previous
revision-item usually corresponds to a newer revision.)  A numeric
prefix argument is a repeat count.

@item n
957 958
Move to the next revision entry.  A numeric prefix argument is a
repeat count.
959 960

@item P
961 962 963
Move to the log of the previous file, if showing logs for a multi-file
VC fileset.  Otherwise, just move to the beginning of the log.  A
numeric prefix argument is a repeat count.
964 965

@item N
966 967
Move to the log of the next file, if showing logs for a multi-file VC
fileset.  A numeric prefix argument is a repeat count.
968 969

@item a
970
Annotate the revision on the current line (@pxref{Old Revisions}).
971 972 973 974 975 976

@item e
Modify the change comment displayed at point.  Note that not all VC
systems support modifying change comments.

@item f
977
Visit the revision indicated at the current line.
978 979

@item d
980 981
Display a diff between the revision at point and the next earlier
revision, for the specific file.
982 983

@item D
984 985 986 987 988 989 990 991
Display the changeset diff between the revision at point and the next
earlier revision.  This shows the changes to all files made in that
revision.

@item @key{RET}
In a compact-style log buffer (e.g.@: the one created by @kbd{C-x v
L}), toggle between showing and hiding the full log entry for the
revision at point.
992 993
@end table

994 995
@vindex vc-log-show-limit
Because fetching many log entries can be slow, the
996
@file{*vc-change-log*} buffer displays no more than 2000 revisions by
997 998 999
default.  The variable @code{vc-log-show-limit} specifies this limit;
if you set the value to zero, that removes the limit.  You can also
increase the number of revisions shown in an existing
1000
@file{*vc-change-log*} buffer by clicking on the @samp{Show 2X
1001 1002 1003
entries} or @samp{Show unlimited entries} buttons at the end of the
buffer.  However, RCS, SCCS, and CVS do not support this feature.

1004
@node VC Undo
1005
@subsection Undoing Version Control Actions
1006 1007 1008

@table @kbd
@item C-x v u
1009 1010
Revert the work file(s) in the current VC fileset to the last revision
(@code{vc-revert}).
1011 1012
@end table

1013 1014
@c `C-x v c' (vc-rollback) was removed, since it's RCS/SCCS specific.

1015
@kindex C-x v u
1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031
@findex vc-revert
@vindex vc-revert-show-diff
  If you want to discard all the changes you have made to the current
VC fileset, type @kbd{C-x v u} (@code{vc-revert-buffer}).  This shows
you a diff between the work file(s) and the revision from which you
started editing, and asks for confirmation for discarding the changes.
If you agree, the fileset is reverted.  If you don't want @kbd{C-x v
u} to show a diff, set the variable @code{vc-revert-show-diff} to
@code{nil} (you can still view the diff directly with @kbd{C-x v =};
@pxref{Old Revisions}).  Note that @kbd{C-x v u} cannot be reversed
with the usual undo commands (@pxref{Undo}), so use it with care.

  On locking-based version control systems, @kbd{C-x v u} leaves files
unlocked; you must lock again to resume editing.  You can also use
@kbd{C-x v u} to unlock a file if you lock it and then decide not to
change it.
1032 1033 1034 1035

@node VC Directory Mode
@subsection VC Directory Mode

1036 1037 1038 1039 1040 1041 1042
@cindex VC Directory buffer
  The @dfn{VC Directory buffer} is a specialized buffer for viewing
the version control statuses of the files in a directory tree, and
performing version control operations on those files.  In particular,
it is used to specify multi-file VC filesets for commands like
@w{@kbd{C-x v v}} to act on (@pxref{VC Directory Commands}).

1043 1044
@kindex C-x v d
@findex vc-dir
1045 1046 1047
  To