Various small changes in addition to:
[emacs.git] / man / pcl-cvs.texi
bloba99cd39a8d93e9b2133cc775ec653215573a93e4
1 \input texinfo  @c -*-texinfo-*-
2 @c %**start of header
3 @setfilename ../info/pcl-cvs
4 @settitle PCL-CVS --- Emacs Front-End to CVS
5 @syncodeindex vr fn
6 @c %**end of header
8 @copying
9 Copyright @copyright{} 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
10 1999, 2000, 2002, 2004 Free Software Foundation, Inc.
12 @quotation
13 Permission is granted to copy, distribute and/or modify this document
14 under the terms of the GNU Free Documentation License, Version 1.1 or
15 any later version published by the Free Software Foundation; with the
16 Invariant Sections being ``The GNU Manifesto'', ``Distribution'' and
17 ``GNU GENERAL PUBLIC LICENSE'', with the Front-Cover texts being ``A GNU
18 Manual'', and with the Back-Cover Texts as in (a) below.  A copy of the
19 license is included in the section entitled ``GNU Free Documentation
20 License'' in the Emacs manual.
22 This document is part of a collection distributed under the GNU Free
23 Documentation License.  If you want to distribute this document
24 separately from the collection, you can do so by adding a copy of the
25 license to the document, as described in section 6 of the license.
27 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
28 this GNU Manual, like GNU software.  Copies published by the Free
29 Software Foundation raise funds for GNU development.''
30 @end quotation
31 @end copying
33 @dircategory Emacs
34 @direntry
35 * PCL-CVS: (pcl-cvs).   Emacs front-end to CVS.
36 @end direntry
38 @c The titlepage section does not appear in the Info file.
39 @titlepage
40 @sp 4
41 @c The title is printed in a large font.
42 @center @titlefont{User's Guide}
43 @sp
44 @center @titlefont{to}
45 @sp
46 @center @titlefont{PCL-CVS --- The Emacs Front-End to CVS}
47 @ignore
48 @sp 2
49 @center release 2.9
50 @c -release-
51 @end ignore
52 @sp 3
53 @center Per Cederqvist
54 @center Stefan Monnier
55 @c -date-
57 @c  The following two commands start the copyright page
58 @c  for the printed manual.  This will not appear in the Info file.
59 @page
60 @vskip 0pt plus 1filll
61 @insertcopying
62 @end titlepage
64 @c ================================================================
65 @c                   The real text starts here
66 @c ================================================================
68 @node Top, About PCL-CVS, (dir), (dir)
69 @ifnottex
70 @top PCL-CVS
72 This manual describes PCL-CVS, the GNU Emacs front-end to CVS.  It
73 is nowhere near complete, so you are advised to use @kbd{M-x
74 customize-group RET pcl-cvs @key{RET}} and to look at the documentation strings
75 of the various commands and major modes for further information.
76 @c This manual is updated to release 2.5 of PCL-CVS.
77 @end ifnottex
79 @menu
80 * About PCL-CVS::               Installation, credits, history, @dots{}
82 * Getting started::             An introduction with a walk-through example.
83 * Buffer contents::             An explanation of the buffer contents.
84 * Selected files::              To which files are commands applied.
85 * Commands::                    All commands, grouped by type.
87 * Log Edit Mode::               Major mode to edit log messages.
88 * Log View Mode::               Major mode to browse log changes.
89 @c * CVS Status Mode::             Major mode to view CVS' status output.
90 * Customization::               How you can tailor PCL-CVS to suit your needs.
91 * Bugs::                        Bugs (known and unknown).
93 * Function and Variable Index::  List of functions and variables.
94 * Concept Index::               List of concepts.
95 * Key Index::                   List of keystrokes.
97 @detailmenu
98  --- The Detailed Node Listing ---
100 About PCL-CVS
102 * Contributors::                Contributors to PCL-CVS.
103 * Installation::
105 Commands
107 * Entering PCL-CVS::            Commands to invoke PCL-CVS
108 * Setting flags::               Setting flags for CVS commands
109 * Updating the buffer::
110 * Movement commands::           How to move up and down in the buffer
111 * Marking files::               How to mark files that other commands
112                                 will later operate on.
113 * Committing changes::          Checking in your modifications to the
114                                 CVS repository.
115 * Editing files::               Loading files into Emacs.
116 * Getting info about files::    Display the log and status of files.
117 * Adding and removing files::   Adding and removing files
118 * Undoing changes::             Undoing changes
119 * Removing handled entries::    Uninteresting lines can easily be removed.
120 * Ignoring files::              Telling CVS to ignore generated files.
121 * Viewing differences::         Commands to @samp{diff} different versions.
122 * Invoking Ediff::              Running @samp{ediff} from @samp{*cvs*} buffer.
123 * Updating files::              Updating files that Need-update.
124 * Tagging files::               Tagging files.
125 * Miscellaneous commands::      Miscellaneous commands.
127 Customization
129 * Customizing Faces::
131 @end detailmenu
132 @end menu
134 @node     About PCL-CVS, Getting started, Top, Top
135 @chapter About PCL-CVS
136 @cindex About PCL-CVS
138 PCL-CVS is a front-end to CVS versions 1.9 and later.
139 It concisely shows the present status of a checked out module in an
140 Emacs buffer and provides single-key access to the most frequently used CVS
141 commands.
142 For Emacs users accustomed to VC, PCL-CVS can be thought of as a replacement
143 for VC-dired (@pxref{VC Dired Mode, , Dired under VC, emacs, The GNU
144 Emacs Manual}) specifically designed for CVS.
146 PCL-CVS was originally written many years ago by Per Cederqvist who
147 proudly maintained it until January 1996, at which point he released the
148 beta version 2.0b2 and passed on the maintainership to Greg A Woods.
149 Development stayed mostly dormant for a few years during which
150 version 2.0 never seemed to be able to leave the ``beta'' stage while a
151 separate XEmacs version was slowly splitting away.  In late 1998,
152 Stefan Monnier picked up development again, adding some major new
153 functionality and taking over the maintenance.
155 As of Emacs 21, PCL-CVS is part of the standard Emacs distribution.
157 @menu
158 * Contributors::                Contributors to PCL-CVS.
159 * Installation::
160 @end menu
162 @node     Contributors, Installation, About PCL-CVS, About PCL-CVS
163 @section Contributors to PCL-CVS
164 @cindex Contributors
165 @cindex Authors
167 Contributions to the package are welcome.  I have limited time to work
168 on this project, but I will gladly add any code that you contribute to
169 me to this package (@pxref{Bugs}).
171 The following persons have made contributions to PCL-CVS.
173 @itemize @bullet
174 @item
175 Brian Berliner wrote CVS, together with some other contributors.
176 Without his work on CVS this package would be useless@dots{}
178 @item
179 Per Cederqvist wrote most of the otherwise unattributed functions in
180 PCL-CVS as well as all the documentation.
182 @item
183 @email{inge@@lysator.liu.se, Inge Wallin} wrote the skeleton of
184 @file{pcl-cvs.texi}, and gave useful comments on it.  He also wrote
185 the files @file{elib-node.el} and @file{compile-all.el}.  The file
186 @file{cookie.el} was inspired by Inge.@refill
188 @item
189 @email{linus@@lysator.liu.se, Linus Tolke} contributed useful comments
190 on both the functionality and the documentation.@refill
192 @item
193 @email{jwz@@jwz.com, Jamie Zawinski} contributed
194 @file{pcl-cvs-lucid.el}, which was later renamed to
195 @file{pcl-cvs-xemacs.el}.@refill
197 @item
198 Leif Lonnblad contributed RCVS support (since superseded by the new
199 remote CVS support).
201 @item
202 @email{jimb@@cyclic.com, Jim Blandy} contributed hooks to automatically
203 guess CVS log entries from @file{ChangeLog} contents, and initial support of
204 the new Cygnus / Cyclic remote CVS, as well as various sundry bug fixes
205 and cleanups.
207 @item
208 @email{kingdon@@cyclic.com, Jim Kingdon} contributed lots of fixes to
209 the build and installation procedure.
211 @item
212 @email{woods@@weird.com, Greg A.@: Woods} contributed code to implement
213 the use of per-file diff buffers, and vendor join diffs with emerge and
214 ediff, as well as various and sundry bug fixes and cleanups.
216 @item
217 @email{greg.klanderman@@alum.mit.edu, Greg Klanderman} implemented
218 toggling of marked files, setting of CVS command flags via prefix
219 arguments, updated the XEmacs support, updated the manual, and fixed
220 numerous bugs.
222 @item
223 @email{monnier@@cs.yale.edu, Stefan Monnier} added a slew of other
224 features and introduced even more new bugs.  If there's any bug left,
225 you can be sure it's his.
227 @item
228 @c wordy to avoid an underfull hbox
229 @email{masata-y@@is.aist-nara.ac.jp, Masatake YAMATO} made a gracious
230 contribution of his cvstree code to display a tree of tags which was later
231 superseded by the new @code{cvs-status-mode}.
232 @end itemize
234 Apart from these, a lot of people have sent us suggestions, ideas,
235 requests, bug reports and encouragement.  Thanks a lot!  Without you
236 there would be no new releases of PCL-CVS.
239 @node   Installation,  , Contributors, About PCL-CVS
240 @section Installation
241 @cindex Installation
243 As mentioned above, PCL-CVS comes bundled with Emacs version 21.1 and
244 later.  If you're using Emacs 20, you can download an older version of
245 PCL-CVS from @uref{ftp://flint.cs.yale.edu/pub/monnier/pcl-cvs}.  That
246 version also works on XEmacs.
248 If you are running XEmacs 21.0 or later, PCL-CVS is available in
249 pre-compiled package form.  Please refer to the XEmacs manual for
250 instructions regarding package selection and installation.  Currently,
251 that PCL-CVS package also requires you to have installed the
252 @file{xemacs-base}, @file{elib}, and @file{dired} packages.
254 If you have @TeX{} installed at your site, you can make a typeset manual
255 from @file{pcl-cvs.texi}.
257 @enumerate
258 @item
259 If PCL-CVS came with the Emacs distribution, type @kbd{make pcl-cvs.dvi}
260 in the @file{man} subdirectory of the Emacs source tree.
261 @item
262 Alternatively, run @TeX{} by typing @kbd{texi2dvi pcl-cvs.texi}.
263 @item
264 Convert the resulting device independent file @file{pcl-cvs.dvi} to a
265 form which your printer can output and print it.  If you have a
266 PostScript printer, there is a program, @code{dvi2ps}, which does.  There
267 is also a program which comes together with @TeX{}, @code{dvips}, which
268 you can use.
269 @end enumerate
272 @node Getting started, Buffer contents, About PCL-CVS, Top
273 @chapter Getting started
274 @cindex Introduction
275 @cindex Example run
276 @cindex Sample session
278 This document assumes that you know what CVS is, and that you at least
279 know the fundamental concepts of CVS.  If that is not the case, you
280 should read the CVS documentation.  Type @kbd{info -f cvs} or @kbd{man
281 cvs}.
283 PCL-CVS is only useful once you have checked out a module.  So before
284 you invoke it, you must have a copy of a module somewhere in the file
285 system.
287 You can invoke PCL-CVS by typing @kbd{M-x cvs-examine @key{RET}}.
288 You can also invoke it via the menu bar, under @samp{Tools}.
289 Or, if you prefer, you can also invoke PCL-CVS by simply visiting the
290 CVS administrative subdirectory of your module, with a prefix argument.
291 For example, to invoke PCL-CVS in a separate frame, type @kbd{C-u C-x 5
292 f ~/my/project/CVS @key{RET}}.
294 The function @code{cvs-examine} will ask for a directory.  The command
295 @samp{cvs -n update} will be run in that directory.  (It should contain
296 files that have been checked out from a CVS archive.)  The output from
297 @code{cvs} will be parsed and presented in a table in a buffer called
298 @samp{*cvs*}.  It might look something like this:
300 @example
301 Repository : /usr/CVSroot
302 Module     : test
303 Working dir: /users/ceder/FOO/test
306 In directory .:
307            Need-Update            bar
308            Need-Update            file.txt
309            Modified               namechange
310            Need-Update            newer
311 In directory sub:
312            Modified               ChangeLog
314 --------------------- End ---------------------
315 -- last cmd: cvs -f -z6 -n update -d -P --
316 @end example
318 In this example, your repository is in @file{/usr/CVSroot} and CVS has
319 been run in the directory @file{/users/ceder/FOO/test}.  The three files
320 (@file{bar}, @file{file.txt} and
321 @file{newer}) that are marked with @samp{Need-Update} have been changed
322 by someone else in the CVS repository.  Two files (@file{namechange}
323 and @file{sub/ChangeLog}) have been modified locally, and need to be
324 checked in.
326 You can move the cursor up and down in the buffer with @kbd{C-n} and
327 @kbd{C-p} or @kbd{n} and @kbd{p}.  If you press @kbd{c} on one of the
328 @samp{Modified} files, that file will be checked in to the CVS
329 repository. @xref{Committing changes}.  You can also press @kbd{O} to
330 update any of the files that are marked @samp{Need-Update}.  You can
331 also run @kbd{M-x cvs-update @key{RET}} (bound to @kbd{M-u} in the
332 @samp{*cvs*} buffer) to update all the files.@refill
334 You can then press @kbd{=} to easily get a @samp{diff} between your
335 modified file and the base version that you started from, or you can
336 press @kbd{l} to get the output from @samp{cvs log}.  Many more such
337 commands are available simply by pressing a key (@pxref{Getting info
338 about files}).
340 @node Buffer contents, Selected files, Getting started, Top
341 @chapter Buffer contents
342 @cindex Buffer contents
343 @cindex @code{*cvs*} buffer contents
345 The display contains several columns, some of which are optional.
346 These columns are, from left to right:
348 @itemize @bullet
350 @item
351 Optionally, the head revision of the file.  This is the latest version
352 found in the repository.  It might also contain (instead of the head
353 revision) a sub status which typically gives further information about
354 how we got to the current state, for example @samp{patched},
355 @samp{merged}, @dots{}
357 @item
358 An asterisk when the file is @dfn{marked} (@pxref{Selected
359 files}).@refill
361 @item
362 The actual status of the file wrt the repository.  See below.
364 @item
365 Optionally, the base revision of the file.  This is the version
366 which the copy in your working directory is based upon.
368 @item
369 The file name.
371 @end itemize
373 The @samp{file status} field can have the following values:
375 @table @samp
376 @item Modified
377 The file is modified in your working directory, and there was no
378 modification to the same file in the repository.  This status can have
379 the following substatus:
381 @table @samp
382 @item merged
383 The file was modified in your working directory, and there were
384 modifications in the repository as well, but they were merged
385 successfully, without conflict, in your working directory.@refill
386 @end table
388 @item Conflict
389 A conflict was detected while trying to merge your changes to @var{file}
390 with changes from the repository.  @var{file} (the copy in your
391 working directory) is now the output of the @code{rcsmerge} command on
392 the two versions; an unmodified copy of your file is also in your
393 working directory, with the name @file{.#@var{file}.@var{version}},
394 where @var{version} is the RCS revision that your modified file started
395 from.  @xref{Viewing differences}, for more details.@refill
397 A conflict can also come from a disagreement on the existence of the file
398 rather than on its content.  This case is indicated by the following
399 possible substatus:
401 @table @samp
402 @item removed
403 The file is locally removed but a new revision has been committed to
404 the repository by someone else.
406 @item added
407 The file is locally added and has also been added to the repository
408 by someone else.
410 @item modified
411 The file is locally modified but someone else has removed it from the
412 repository.
413 @end table
415 @item Added
416 The file has been added by you, but it still needs to be checked in to
417 the repository.@refill
419 @item Removed
420 The file has been removed by you, but it still needs to be checked in to
421 the repository.  You can resurrect it by typing @kbd{a} (@pxref{Adding
422 and removing files}).@refill
424 @item Unknown
425 A file that was detected in your directory, but that neither appears in
426 the repository, nor is present on the list of files that CVS should
427 ignore.@refill
429 @item Up-to-date
430 The file is up to date with respect to the version in the repository.
431 This status can have a substatus of:
433 @table @samp
434 @item added
435 You have just added the file to the repository.@refill
437 @item updated
438 The file was brought up to date with respect to the repository.  This is
439 done for any file that exists in the repository but not in your source,
440 and for files that you haven't changed but are not the most recent
441 versions available in the repository.@refill
443 @item patched
444 The file was brought up to date with respect to the remote repository by
445 way of fetching and applying a patch to the file in your source.  This
446 is equivalent to @samp{updated} except that CVS decided to use a hopefully
447 more efficient method.@refill
449 @item committed
450 You just committed the file.@refill
451 @end table
453 @item Need-Update
454 Either a newer version than the one in your source is available in the
455 repository and you have not modified your checked out version, or the
456 file exists in the repository but not in your source.  Use
457 @samp{cvs-mode-update} bound to @kbd{O} to update the file.@refill
459 @item Need-Merge
460 You have modified the checked out version of the file, and a newer
461 version is available in the repository.  A merge will take place when
462 you run a @samp{cvs-update}.
464 @item Missing
465 The file has been unexpectedly removed from your working directory
466 although it has not been @samp{cvs remove}d.
467 @end table
469 @node Selected files, Commands, Buffer contents, Top
470 @chapter Selected files
471 @cindex Selected files
472 @cindex Marked files
473 @cindex File selection
474 @cindex Active files
475 @cindex Applicable
477 Many of the commands work on the current set of @dfn{selected} files
478 which can be either the set of marked files (if any file is marked and
479 marks are not ignored) or whichever file or directory the cursor is on.
481 If a directory is selected but the command cannot be applied to a
482 directory, then it will be applied to the set of files under this
483 directory which are in the @samp{*cvs*} buffer.
485 @findex cvs-mode-force-command
486 @findex cvs-allow-dir-commit
487 Furthermore, each command only operates on a subset of the selected
488 files, depending on whether or not the command is @dfn{applicable} to
489 each file (based on the file's status).  For example,
490 @code{cvs-mode-commit} is not applicable to a file whose status is
491 @samp{Need-Update}.  If it should happen that PCL-CVS guesses the
492 applicability wrong, you can override it with the special prefix
493 @code{cvs-mode-force-command} normally bound to @kbd{M-f} (and file a
494 bug report).  The applicability rule can be slightly changed with
495 @code{cvs-allow-dir-commit} and @code{cvs-force-dir-tag}.
497 By default, marks are always in effect (you may change this, however, by
498 setting the variable @code{cvs-default-ignore-marks}) except for the
499 commands that @samp{tag} or @samp{diff} a file (which can be changed
500 with the variable @code{cvs-invert-ignore-marks}).
502 In addition, you may use the special prefix @code{cvs-mode-toggle-marks}
503 normally bound to @key{T} to toggle the use of marks for the following
504 command.
506 This scheme might seem a little complicated, but once one gets used to
507 it, it is quite powerful.
509 For commands to mark and unmark files, see @ref{Marking files}.
511 @node Commands, Log Edit Mode, Selected files, Top
512 @chapter Commands
514 @iftex
515 This chapter describes all the commands that you can use in PCL-CVS.
516 @end iftex
517 @ifnottex
518 The nodes in this menu contains explanations about all the commands that
519 you can use in PCL-CVS.  They are grouped together by type.
520 @end ifnottex
522 @menu
523 * Entering PCL-CVS::            Commands to invoke PCL-CVS
524 * Setting flags::               Setting flags for CVS commands
525 * Updating the buffer::
526 * Movement commands::           How to move up and down in the buffer
527 * Marking files::               How to mark files that other commands
528                                 will later operate on.
529 * Committing changes::          Checking in your modifications to the
530                                 CVS repository.
531 * Editing files::               Loading files into Emacs.
532 * Getting info about files::    Display the log and status of files.
533 * Adding and removing files::   Adding and removing files
534 * Undoing changes::             Undoing changes
535 * Removing handled entries::    Uninteresting lines can easily be removed.
536 * Ignoring files::              Telling CVS to ignore generated files.
537 * Viewing differences::         Commands to @samp{diff} different versions.
538 * Invoking Ediff::              Running @samp{ediff} from @samp{*cvs*} buffer.
539 * Updating files::              Updating files that Need-update.
540 * Tagging files::               Tagging files.
541 * Miscellaneous commands::      Miscellaneous commands.
542 @end menu
545 @node Entering PCL-CVS, Setting flags, Commands, Commands
546 @section Entering PCL-CVS
547 @findex cvs-update
548 @findex cvs-examine
549 @findex cvs-status
550 @findex cvs-checkout
551 @findex cvs-quickdir
552 @cindex Creating the *cvs* buffer
554 Most commands in PCL-CVS require that you have a @samp{*cvs*}
555 buffer.  The commands that you use to get one are listed below.
556 For each, a @samp{cvs} process will be run, the output will be parsed by
557 PCL-CVS, and the result will be printed in the @samp{*cvs*} buffer (see
558 @ref{Buffer contents}, for a description of the buffer's contents).
560 @table @kbd
561 @item M-x cvs-update
562 Run a @samp{cvs update} command.  You will be asked for the directory
563 in which the @samp{cvs update} will be run.
565 @item M-x cvs-examine
566 Run a @samp{cvs -n update} command.  This is identical to the previous
567 command, except that it will only check what needs to be done but will
568 not change anything.  You will be asked for the directory in
569 which the @samp{cvs -n update} will be run.
571 @item M-x cvs-status
572 Run a @samp{cvs status} command.  You will be asked for the directory
573 in which the @samp{cvs status} will be run.
575 @item M-x cvs-checkout
576 Run a @samp{cvs checkout} command.  You will be asked for the directory
577 in which the @samp{cvs update} will be run and the module to be checked
578 out.
580 @item M-x cvs-quickdir
581 Populate the @samp{*cvs*} buffer by just looking at the @file{CVS/Entries}
582 files.  This is very much like @code{cvs-examine} except that it does
583 not access the CVS repository, which is a major advantage when the
584 repository is far away.  But of course, it will not be able to detect
585 when a file needs to be updated or merged.
586 @end table
588 @findex cvs-dired-action
589 @findex cvs-dired-use-hook
590 The first four of
591 those commands are also reachable from the menu bar
592 under @samp{Tools->PCL-CVS}.  Finally, an alternative way is to visit
593 the CVS administrative subdirectory in your work area with a simple
594 prefix argument.  For example @kbd{C-u C-x C-f ~/my/work/CVS @key{RET}}.  This
595 by default runs @code{cvs-quickdir} but the specific behavior can be
596 changed with @code{cvs-dired-action} and @code{cvs-dired-use-hook}.
598 By default, the commands above will descend recursively into
599 subdirectories.  You can avoid that behavior by including @samp{-l} in
600 the flags for the command.  These flags can be set by giving a prefix
601 argument to the command (e.g., by typing
602 @kbd{C-u M-x cvs-update @key{RET} -l @key{RET}}).
605 @node Setting flags, Updating the buffer, Entering PCL-CVS, Commands
606 @section Setting flags for CVS commands
607 @cindex Optional switches to CVS
608 @cindex Command-line options to CVS
610 This section describes the convention used by nearly all PCL-CVS
611 commands for setting optional flags sent to CVS.  A single @kbd{C-u}
612 prefix argument is used to cause the command to prompt for flags to be
613 used for the current invocation of the command only.  Two @kbd{C-u} prefix
614 arguments are used to prompt for flags which will be set permanently, for the
615 current invocation and all that follow, until the flags are changed, or
616 unless temporary flags are set which override them.
618 Perhaps an example or two is in order.  Say you are about to add a
619 binary file to the repository, and want to specify the flags @samp{-kb}
620 to @samp{cvs add}.  You can type @kbd{C-u a -kb @key{RET}},
621 and the file will be added.  Subsequent @samp{cvs add}
622 commands will use the previously prevailing flags.
624 As a second example, say you are about to perform a diff and want to see
625 the result in unified diff format, i.e. you'd like to pass the flag
626 @samp{-u} to both @samp{cvs diff} and @samp{diff}.  You'd also like all
627 subsequent diffs to use this flag.  You can type @kbd{C-u C-u = -u @key{RET}}
628 and the diff will be performed, and the default flags will be set to
629 @code{("-u")}.  You can of course override this flag for a single diff
630 by using a single @kbd{C-u} prefix argument.
632 @cindex Special prefix
633 In addition to this, some commands can take @dfn{special prefix} arguments.
634 These work as follows: When called with a @kbd{C-u} prefix, the user is
635 prompted for a new value of the special prefix and the special prefix is
636 activated for the next command.  When called without the @kbd{C-u}
637 prefix, the special prefix is re-activated (with the same value as last
638 time) for the next command.  Calling the prefix command again when it's
639 already activated deactivates it.  Calling it with the @kbd{C-u C-u}
640 prefix activates it for all subsequent commands until you deactivate it
641 explicitly.  The special prefixes are:
643 @table @kbd
644 @item T
645 Toggles whether or not marks will be active in the next command.@refill
647 @item b
648 Provide the next command with a branch (can be any version
649 specifier) to work on.@refill
651 @item B
652 Secondary branch argument.  Only meaningful if @kbd{b} is also used.
653 It can be used to provide a second branch argument to
654 @code{cvs-mode-diff} or to @code{cvs-mode-update}.
656 @item M-f
657 Forces the next command to apply to every selected file rather than only
658 to the ones PCL-CVS thinks are relevant.
659 @end table
661 @node Updating the buffer, Movement commands, Setting flags, Commands
662 @section Updating the @samp{*cvs*} buffer
663 @findex cvs-update
664 @findex cvs-examine
665 @findex cvs-status
666 @findex cvs-mode-update
667 @findex cvs-mode-examine
668 @findex cvs-mode-status
670 The following commands can be used from within the @samp{*cvs*} buffer
671 to update the display:
673 @table @kbd
674 @item M-u
675 Runs the command @samp{cvs-update}.@refill
677 @item M-e
678 Runs the command @samp{cvs-examine}.@refill
680 @item M-s
681 Runs the command @samp{cvs-status}.@refill
682 @end table
684 In addition to the above commands which operate on the whole module,
685 you can run the equivalent CVS command on just a subset of the
686 files/directories with these keys:
688 @table @kbd
689 @item O
690 Runs @code{cvs-mode-update} on the selected files.  When run on the
691 top-level directory, this is equivalent to @kbd{M-u}.@refill
693 @item e
694 Runs @code{cvs-mode-examine} on the selected files.  When run on the
695 top-level directory, this is equivalent to @kbd{M-e}.@refill
697 @findex cvs-status-mode
698 @item s
699 Runs @code{cvs-mode-status} on the selected files.  When run on the
700 top-level directory, this is equivalent to @kbd{M-s}, except that
701 CVS output will be shown in a @samp{*cvs-info*} buffer that will be
702 put in @samp{cvs-status-mode}.@refill
703 @end table
706 @node Movement commands, Marking files, Updating the buffer, Commands
707 @section Movement Commands
708 @cindex Movement Commands
709 @findex cvs-mode-next-line
710 @findex cvs-mode-previous-line
711 @kindex SPC@r{--Move down one file}
712 @kindex n@r{--Move down one file}
713 @kindex p@r{--Move up one file}
715 You can use most normal Emacs commands to move forward and backward in
716 the buffer.  Some keys are rebound to functions that take advantage of
717 the fact that the buffer is a PCL-CVS buffer:
720 @table @kbd
721 @item @key{SPC}
722 @itemx n
723 These keys move the cursor one file forward, towards the end of the
724 buffer (@code{cvs-mode-next-line}).@refill
726 @itemx p
727 This key moves one file backward, towards the beginning of the buffer
728 (@code{cvs-mode-previous-line}).
729 @end table
732 @node Marking files, Committing changes, Movement commands, Commands
733 @section Marking files
734 @cindex Selecting files (commands to mark files)
735 @cindex Marking files
736 @kindex m@r{--marking a file}
737 @kindex M@r{--marking all files}
738 @kindex u@r{--unmark a file}
739 @kindex ESC DEL@r{--unmark all files}
740 @kindex DEL@r{--unmark previous file}
741 @kindex %@r{--mark files matching regexp}
742 @kindex S@r{--mark files in a particular state}
743 @kindex T@r{--toggle marks}
744 @findex cvs-mode-mark
745 @findex cvs-mode-unmark
746 @findex cvs-mode-mark-all-files
747 @findex cvs-mode-unmark-all-files
748 @findex cvs-mode-unmark-up
749 @findex cvs-mode-mark-matching-files
750 @findex cvs-mode-mark-on-state
751 @findex cvs-mode-toggle-marks
753 PCL-CVS works on a set of @dfn{selected files} (@pxref{Selected files}).
754 You can mark and unmark files with these commands:
756 @table @kbd
757 @item m
758 This marks the file that the cursor is positioned on.  If the cursor is
759 positioned on a directory all files in that directory are marked.
760 (@code{cvs-mode-mark}).@refill
762 @item u
763 Unmark the file that the cursor is positioned on. If the cursor is on a
764 directory, all files in that directory are unmarked.
765 (@code{cvs-mode-unmark}).@refill
767 @item M
768 Mark @emph{all} files in the buffer (@code{cvs-mode-mark-all-files}).
770 @item M-@key{DEL}
771 Unmark @emph{all} files (@code{cvs-mode-unmark-all-files}).
773 @item @key{DEL}
774 Unmark the file on the previous line, and move point to that line
775 (@code{cvs-mode-unmark-up}).
777 @item %
778 Mark all files matching a regular expression
779 (@code{cvs-mode-mark-matching-files}).
781 @item S
782 Mark all files in a particular state, such as ``Modified'' or
783 ``Removed''.  (@code{cvs-mode-mark-on-state}).
785 @item T
786 Toggle use of marks for the next command (@code{cvs-mode-toggle-marks}).
787 @end table
790 @node Committing changes, Editing files, Marking files, Commands
791 @section Committing changes
792 @cindex Committing changes
793 @findex cvs-mode-commit
794 @findex cvs-mode-commit-setup
795 @kindex c@r{--commit files}
796 @kindex C@r{--commit files with @file{ChangeLog} message}
797 @vindex cvs-auto-revert@r{ (variable)}
798 @cindex Commit buffer
799 @cindex Edit buffer
800 @cindex Erasing commit message
801 @cindex Reverting buffers after commit
803 Committing changes basically works as follows:
805 @enumerate
806 @item
807 After having selected the files you want to commit, you type either
808 @kbd{c} or @kbd{C} which brings up a special buffer
809 @samp{*cvs-commit*}.@refill
811 @item
812 You type in the log message describing the changes you're about to
813 commit (@pxref{Log Edit Mode}).
815 @item
816 When you're happy with it, you type @kbd{C-c C-c} to do the actual
817 commit.@refill
818 @end enumerate
820 There's no hidden state, so you can abort the process or pick it up
821 again at any time.
823 @vindex log-edit-confirm@r{ (variable)}
824 The set of files actually committed is really decided only during the
825 very last step, which is a mixed blessing.  It allows you to go back and
826 change your mind about which files to commit, but it also means that you
827 might inadvertently change the set of selected files.  To reduce the
828 risk of error, @kbd{C-c C-c} will ask for confirmation if the set of
829 selected files has changed between the first step and the last.  You can
830 change this last detail with @code{log-edit-confirm}.
832 As for the difference between @kbd{c} (i.e. @code{cvs-mode-commit}) and
833 @kbd{C} (i.e. @code{cvs-mode-commit-setup}) is that the first gets you
834 straight to @samp{*cvs-commit*} without erasing it or changing anything
835 to its content, while the second first erases @samp{*cvs-commit*}
836 and tries to initialize it with a sane default (it does that by either
837 using a template provided by the CVS administrator or by extracting a
838 relevant log message from a @file{ChangeLog} file).
840 If you are editing the files in your Emacs, an automatic
841 @samp{revert-buffer} will be performed.  (If the file contains
842 @samp{$@asis{Id}$} keywords, @samp{cvs commit} will write a new file with
843 the new values substituted.  The auto-revert makes sure that you get
844 them into your buffer).  The revert will not occur if you have modified
845 your buffer, or if @samp{cvs-auto-revert} is set to
846 @samp{nil}.
849 @node Editing files, Getting info about files, Committing changes, Commands
850 @section Editing files
851 @cindex Editing files
852 @cindex Finding files
853 @cindex Loading files
854 @cindex Dired
855 @cindex Invoking dired
856 @findex cvs-mode-find-file
857 @findex cvs-mode-find-file-other-window
858 @findex cvs-mode-add-change-log-entry-other-window
859 @kindex f@r{--find file or directory}
860 @kindex o@r{--find file in other window}
861 @kindex A@r{--add @file{ChangeLog} entry}
863 There are currently three commands that can be used to find a file (that
864 is, load it into a buffer and start editing it there).  These commands
865 work on the line that the cursor is situated at.  They always ignore any marked
866 files.
868 @table @kbd
869 @item f
870 Find the file that the cursor points to (@code{cvs-mode-find-file}).  If
871 the cursor points to a directory, run @code{dired} on that directory;
872 @inforef{Dired, , emacs}.
874 @item o
875 Like @kbd{f}, but use another window
876 (@code{cvs-mode-find-file-other-window}).@refill
878 @item A
879 Invoke @samp{add-change-log-entry-other-window} to edit a
880 @file{ChangeLog} file.  The @file{ChangeLog} file will be found in the
881 directory of the file the cursor points to, or in a parent of that
882 directory.  (@code{cvs-mode-add-change-log-entry-other-window}).@refill
883 @end table
886 @node Getting info about files, Adding and removing files, Editing files, Commands
887 @section Getting info about files
888 @cindex Status (cvs command)
889 @cindex Log (RCS/cvs command)
890 @cindex Getting status
891 @kindex l@r{--run @samp{cvs log}}
892 @kindex s@r{--run @samp{cvs status}}
893 @findex cvs-mode-log
894 @findex cvs-mode-status
896 @table @kbd
897 @item l
898 Call the command @code{cvs-mode-log} which runs @samp{cvs log} on all
899 selected files, and show the result in a temporary buffer
900 @samp{*cvs-info*} (@pxref{Log View Mode}).
902 @item s
903 Call the command @code{cvs-mode-status} which runs @samp{cvs status} on
904 all selected files, and show the result in a temporary buffer
905 @samp{*cvs-info*}.
906 @c Fixme: reinstate when node is written:
907 @c (@pxref{CVS Status Mode}).
908 @end table
911 @node Adding and removing files, Undoing changes, Getting info about files, Commands
912 @section Adding and removing files
913 @cindex Adding files
914 @cindex Removing files
915 @cindex Resurrecting files
916 @cindex Deleting files
917 @cindex Putting files under CVS control
918 @kindex a@r{--add a file}
919 @kindex r@r{--remove a file}
920 @findex cvs-mode-add
921 @findex cvs-mode-remove-file
923 The following commands are available to make it easy to add files to
924 and remove them from the CVS repository.
926 @table @kbd
927 @item a
928 Add all selected files.  This command can be used on @samp{Unknown}
929 files (@pxref{Buffer contents}).  The status of the file will change to
930 @samp{Added}, and you will have to use @kbd{c} (@samp{cvs-mode-commit}
931 @pxref{Committing changes}), to really add the file to the
932 repository.@refill
934 This command can also be used on @samp{Removed} files (before you commit
935 them) to resurrect them.
937 The command that is run is @code{cvs-mode-add}.
939 @item r
940 This command removes the selected files (after prompting for
941 confirmation).  The files are deleted from your directory and
942 (unless the status was @samp{Unknown}; @pxref{Buffer contents}) they will
943 also be @samp{cvs remove}d.  If the files' status was @samp{Unknown}
944 they will disappear from the buffer.  Otherwise their status will change to
945 @samp{Removed}, and you must use @kbd{c} (@samp{cvs-mode-commit},
946 @pxref{Committing changes}) to commit the removal.@refill
948 The command that is run is @code{cvs-mode-remove-file}.
949 @end table
952 @node Undoing changes, Removing handled entries, Adding and removing files, Commands
953 @section Undoing changes
954 @cindex Undo changes
955 @cindex Flush changes
956 @kindex U@r{--undo changes}
957 @findex cvs-mode-undo-local-changes
959 @table @kbd
960 @item U
961 If you have modified a file, and for some reason decide that you don't
962 want to keep the changes, you can undo them with this command.  It works
963 by removing your working copy of the file and then getting the latest
964 version from the repository (@code{cvs-mode-undo-local-changes}.
965 @end table
968 @node Removing handled entries, Ignoring files, Undoing changes, Commands
969 @section Removing handled entries
970 @cindex Expunging uninteresting entries
971 @cindex Uninteresting entries, getting rid of them
972 @cindex Getting rid of uninteresting lines
973 @cindex Removing uninteresting (processed) lines
974 @cindex Handled lines, removing them
975 @kindex x@r{--remove processed entries}
976 @kindex C-k@r{--remove selected entries}
977 @findex cvs-mode-remove-handled
978 @findex cvs-mode-acknowledge
979 @findex cvs-mode-ignore
981 @table @kbd
982 @item x
983 This command allows you to remove all entries that you have processed.
984 More specifically, the lines for @samp{Up-to-date} files (@pxref{Buffer
985 contents}) are removed from the buffer.  If a directory becomes empty
986 the heading for that directory is also removed.  This makes it easier to
987 get an overview of what needs to be done.
989 @vindex cvs-mode-remove-handled@r{ (variable)}
990 @kbd{x} invokes @code{cvs-mode-remove-handled}.  If
991 @samp{cvs-auto-remove-handled} is set to non-@code{nil}, this will
992 automatically be performed after every commit.@refill
994 @item C-k
995 This command can be used for lines that @samp{cvs-mode-remove-handled} would
996 not delete, but that you want to delete (@code{cvs-mode-acknowledge}).
997 @end table
1000 @node Ignoring files, Viewing differences, Removing handled entries, Commands
1001 @section Ignoring files
1002 @cindex Ignoring files
1003 @kindex i@r{--ignoring files}
1004 @findex cvs-mode-ignore
1006 @table @kbd
1007 @item i
1008 Arrange so that CVS will ignore the selected files.  The file names are
1009 added to the @file{.cvsignore} file in the corresponding directory.  If
1010 the @file{.cvsignore} file doesn't exist, it will be created.
1012 The @file{.cvsignore} file should normally be added to the repository,
1013 but you could ignore it as well, if you like it better that way.
1015 This runs @code{cvs-mode-ignore}.
1016 @end table
1018 @node Viewing differences, Invoking Ediff, Ignoring files, Commands
1019 @section Viewing differences
1020 @cindex Diff
1021 @cindex Invoking @code{diff}
1022 @cindex Conflicts, how to resolve them
1023 @cindex Viewing differences
1024 @kindex d=@r{--run @samp{cvs diff}}
1025 @kindex =@r{--run @samp{cvs diff}}
1026 @kindex db@r{--diff against base version}
1027 @kindex dh@r{--diff against head of repository}
1028 @kindex dr@r{--diff between base and head of repository}
1029 @kindex dv@r{--diff against vendor branch}
1030 @kindex dy@r{--diff against yesterday's head}
1031 @findex cvs-mode-diff
1032 @findex cvs-mode-diff-backup
1033 @findex cvs-mode-diff-head
1034 @findex cvs-mode-diff-repository
1035 @findex cvs-mode-diff-vendor
1036 @findex cvs-mode-diff-yesterday
1037 @vindex cvs-invert-ignore-marks@r{ (variable)}
1039 @table @kbd
1040 @item =
1041 @itemx d =
1042 Display a @samp{cvs diff} between the selected files and the version
1043 that they are based on. (@code{cvs-mode-diff}).@refill
1045 @item d b
1046 If CVS finds a conflict while merging two versions of a file (during a
1047 @samp{cvs update}, @pxref{Updating the buffer}) it will save the
1048 original file in a file called @file{.#@var{file}.@var{version}} where
1049 @var{file} is the name of the file, and @var{version} is the revision
1050 number that @var{file} was based on.@refill
1052 With the @kbd{d b} command you can run a @samp{diff} on the files
1053 @file{.#@var{file}.@var{version}} and @file{@var{file}}.@refill
1055 @item d h
1056 Display a @samp{cvs diff} between the selected files and the head
1057 revision in the repository (the most recent version on the current
1058 branch) (@code{cvs-mode-diff-head}).@refill
1060 @item d r
1061 Display a @samp{cvs diff} between the base revision of the selected
1062 files and the head revision in the repository.  This displays the
1063 changes anyone has committed to the repository since you last executed
1064 "checkout", "update" or "commit".
1065 (@code{cvs-mode-diff-repository}).@refill
1067 @item d v
1068 Display a @samp{cvs diff} between the selected files and the head
1069 revision of the vendor branch in the repository.
1070 (@code{cvs-mode-diff-vendor}).@refill
1072 @item d y
1073 Display a @samp{cvs diff} between the selected files and yesterday's
1074 head revision in the repository.
1075 (@code{cvs-mode-diff-yesterday}).@refill
1076 @end table
1078 By default, @samp{diff} commands ignore the marks.  This can be changed
1079 with @code{cvs-invert-ignore-marks}.
1081 @node Invoking Ediff, Updating files, Viewing differences, Commands
1082 @section Running ediff
1083 @cindex Ediff
1084 @cindex Invoking ediff
1085 @cindex Viewing differences
1086 @cindex Conflicts, how to resolve them
1087 @cindex Resolving conflicts
1088 @kindex e@r{--invoke @samp{ediff}}
1089 @findex cvs-mode-idiff
1090 @findex cvs-mode-imerge
1092 @table @kbd
1093 @vindex cvs-idiff-imerge-handlers@r{ (variable)}
1094 @item d e
1095 This uses @code{ediff} (or @code{emerge}, depending on
1096 @samp{cvs-idiff-imerge-handlers}) to allow you to view diffs.
1097 If a prefix argument is given, PCL-CVS will prompt for a revision against
1098 which the diff should be made, else the default will be to use the BASE
1099 revision.
1101 @cindex Merging with @code{ediff} and @code{emerge}
1102 @item d E
1103 This command use @code{ediff} (or @code{emerge}, see above) to allow you
1104 to do an interactive 3-way merge.
1106 @strong{Please note:}  when the file status is @samp{Conflict},
1107 CVS has already performed a merge.  The resulting file is not used in
1108 any way if you use this command.  If you use the @kbd{q} command inside
1109 @samp{ediff} (to successfully terminate a merge) the file that CVS
1110 created will be overwritten.@refill
1111 @end table
1113 @node Updating files, Tagging files, Invoking Ediff, Commands
1114 @section Updating files
1115 @findex cvs-mode-update
1116 @cindex Updating files
1117 @kindex O@r{--update files}
1119 @table @kbd
1120 @item O
1121 Update all selected files with status @samp{Need-update} by running
1122 @samp{cvs update} on them.  (@code{cvs-mode-update}).
1123 @end table
1126 @node Tagging files, Miscellaneous commands, Updating files, Commands
1127 @section Tagging files
1128 @findex cvs-mode-tag
1129 @findex cvs-mode-untag
1130 @findex cvs-rtag
1131 @cindex Tagging files
1132 @kindex M-t@r{--repository tag files}
1133 @kindex t@r{--tag files}
1134 @vindex cvs-invert-ignore-marks@r{ (variable)}
1135 @vindex cvs-force-dir-tag@r{ (variable)}
1137 @table @kbd
1138 @item t
1139 Tag all selected files by running @samp{cvs tag} on
1140 them (@code{cvs-mode-tag}).  It's usually preferable to tag a directory
1141 at a time.  Rather than selecting all files (which too often doesn't
1142 select all files but only the few that are displayed), clear the
1143 selection with @kbd{M-DEL} (@code{cvs-mode-unmark-all-files}), position
1144 the cursor on the directory you want to tag and hit @kbd{t}.
1145 @end table
1147 By default, @samp{tag} commands ignore the marks.  This can be changed
1148 with @code{cvs-invert-ignore-marks}.  Also, by default @samp{tag} can
1149 only be applied to directories, see @code{cvs-force-dir-tag} if you want
1150 to change this behavior.
1153 @node Miscellaneous commands,  , Tagging files, Commands
1154 @section Miscellaneous commands
1155 @findex cvs-mode-byte-compile-files
1156 @cindex Recompiling elisp files
1157 @cindex Byte compilation
1158 @findex cvs-mode-delete-lock
1159 @cindex Getting rid of lock files
1160 @cindex Lock files
1161 @kindex q@r{--quit PCL-CVS}
1162 @findex cvs-mode-quit
1163 @cindex Quitting
1164 @kindex h@r{--help}
1165 @kindex ?@r{--help}
1166 @findex cvs-help
1167 @cindex Help
1169 @table @kbd
1170 @item M-x cvs-mode-byte-compile-files
1171 Byte compile all selected files that end in @file{.el}.
1173 @item M-x cvs-mode-delete-lock
1174 This command deletes the lock files that
1175 the @samp{*cvs*} buffer informs you about.  You should normally never have to
1176 use this command, since CVS tries very carefully to always remove the
1177 lock files itself.
1179 You can only use this command when a message in the @samp{*cvs*} buffer tells
1180 you so.  You should wait a while before using this command in case
1181 someone else is running a @code{cvs} command.
1183 Also note that this only works if the repository is local.
1185 @item ?
1186 @itemx h
1187 Show a summary of common command key bindings in the echo
1188 area (@code{cvs-help}).
1190 @item q
1191 Quit PCL-CVS, killing the @samp{*cvs*} buffer (@code{cvs-mode-quit}).
1192 @end table
1194 @node Log Edit Mode, Log View Mode, Commands, Top
1195 @chapter Editing a Log Message
1197 @cindex Log Edit mode
1198 @cindex mode, Log Edit
1199 Buffers for entering/editing log messages for changes which are about
1200 to be committed are put into Log Edit mode.
1202 Sometimes the log buffer contains default text when you enter it,
1203 typically the last log message entered.  If it does, mark and point
1204 are set around the entire contents of the buffer so that it is easy to
1205 kill the contents of the buffer with @kbd{C-w}.
1207 @findex log-edit-insert-changelog
1208 If you work by writing entries in the @file{ChangeLog}
1209 (@pxref{(emacs)Change Log}) and then commit the change under revision
1210 control, you can generate the Log Edit text from the ChangeLog using
1211 @kbd{C-c C-a} (@kbd{log-edit-insert-changelog}).  This looks for
1212 entries for the file(s) concerned in the top entry in the ChangeLog
1213 and uses those paragraphs as the log text.  This text is only inserted
1214 if the top entry was made under your user name on the current date.
1215 @xref{(emacs)Change Logs and VC}, for the opposite way of
1216 working---generating ChangeLog entries from the revision control log.
1218 In the Log Edit buffer, @kbd{C-c C-f} (@kbd{M-x log-edit-show-files})
1219 shows the list of files to be committed in case you need to check
1220 that.
1222 When you have finished editing the log message, type @kbd{C-c C-c} to
1223 exit the buffer and commit the change.
1225 @c Fixme: customization variables
1227 @node Log View Mode, Customization, Log Edit Mode, Top
1228 @chapter Browsing a Log of Changes
1230 @cindex Log View mode
1231 @cindex mode, Log View
1232 @cindex output, logs
1234 @findex cvs-mode-log
1235 @findex vc-print-log
1236 Log View mode provides a few useful commands for navigating revision
1237 control log output.  It is used for the output buffers of both
1238 @code{cvs-mode-log} and @code{vc-print-log}.
1240 In this mode, @kbd{n} goes to the next message and @kbd{p} goes to the
1241 previous message and @kbd{N} and @kbd{P} go to the next and previous
1242 files, respectively, in multi-file output.  With a numeric prefix
1243 argument, these commands move that many messages of files.
1245 @c @node CVS Status Mode
1246 @c @chapter Viewing CVS' Status output
1248 @node Customization, Bugs, Log View Mode, Top
1249 @chapter Customization
1250 @vindex log-edit-changelog-full-paragraphs@r{ (variable)}
1251 @vindex cvs-auto-remove-handled@r{ (variable)}
1252 @vindex cvs-auto-remove-directories@r{ (variable)}
1253 @vindex cvs-update-prog-output-skip-regexp@r{ (variable)}
1254 @vindex cvs-cvsroot@r{ (variable)}
1255 @vindex cvs-auto-revert@r{ (variable)}
1256 @vindex log-edit-require-final-newline@r{ (variable)}
1257 @vindex cvs-sort-ignore-file@r{ (variable)}
1258 @cindex Customization
1259 @cindex Variables, list of all
1260 @cindex Erasing input buffer
1261 @cindex Context diff, how to get
1262 @cindex Unidiff, how to get
1263 @cindex Automatically remove handled files
1264 @cindex @samp{-u} option in modules file
1265 @cindex Modules file (@samp{-u} option)
1266 @cindex Update program (@samp{-u} option in modules file)
1267 @cindex Reverting buffers after commit
1268 @cindex Require final newline
1269 @cindex Automatically inserting newline
1270 @cindex Commit message, inserting newline
1271 @cindex Sorting @file{.cvsignore} file
1272 @cindex @file{.cvsignore} file, sorting
1273 @cindex Automatically sorting @file{.cvsignore}
1274 @cindex @samp{CVSROOT}, overriding
1276 If you have an idea about any customization that would be handy but
1277 isn't present in this list, please tell me!
1278 For info on how to reach me, see @ref{Bugs}.@refill
1280 @table @samp
1281 @item cvs-auto-remove-handled
1282 If this variable is set to any non-@code{nil} value,
1283 @samp{cvs-mode-remove-handled} will be called every time you check in
1284 files, after the check-in is ready.  @xref{Removing handled
1285 entries}.@refill
1287 @item cvs-auto-remove-directories
1288 If this variable is set to any non-@code{nil} value, directories that do
1289 not contain any files to be checked in will not be listed in the
1290 @samp{*cvs*} buffer.@refill
1292 @item cvs-auto-revert
1293 If this variable is set to any non-@samp{nil} value any buffers you have
1294 that visit a file that is committed will be automatically reverted.
1295 This variable defaults to @samp{t}. @xref{Committing changes}.@refill
1297 @item cvs-update-prog-output-skip-regexp
1298 The @samp{-u} flag in the @file{modules} file can be used to run a command
1299 whenever a @samp{cvs update} is performed (see @code{cvs(5)}).  This regexp
1300 is used to search for the last line in that output.  It is normally set
1301 to @samp{$}.  That setting is only correct if the command outputs
1302 nothing.  Note that PCL-CVS will get very confused if the command
1303 outputs @emph{anything} to @code{stderr}.
1305 @item cvs-cvsroot
1306 This variable can be set to override @samp{CVSROOT}.  It should be a
1307 string.  If it is set, then every time a @code{cvs} command is run, it
1308 will be called as @samp{cvs -d @var{cvs-cvsroot}@dots{}}.  This can be
1309 useful if your site has several repositories.
1311 @item log-edit-require-final-newline
1312 @c wordy to avoid unhderfull hbox
1313 When you enter a log message by typing into the
1314 @samp{*cvs-commit-message*} buffer, PCL-CVS normally automatically
1315 inserts a trailing newline, unless there already is one.  This behavior
1316 can be controlled via @samp{cvs-commit-buffer-require-final-newline}.
1317 If it is @samp{t} (the default behavior), a newline will always be
1318 appended.  If it is @samp{nil}, newlines will never be appended.  Any
1319 other value causes PCL-CVS to ask the user whenever there is no trailing
1320 newline in the commit message buffer.
1322 @findex cvs-mode-changelog-commit
1323 @item log-edit-changelog-full-paragraphs
1324 If this variable is non-@code{nil}, include full @file{ChangeLog}
1325 paragraphs in the CVS log created by @samp{cvs-mode-changelog-commit}.
1326 This may be set in the local variables section of a @file{ChangeLog}
1327 file, to indicate the policy for that @file{ChangeLog}.
1329 @cindex @file{ChangeLog} paragraphs
1330 A @dfn{@file{ChangeLog} paragraph} is a bunch of log text containing no
1331 blank lines; a paragraph usually describes a set of changes with a
1332 single purpose, but perhaps spanning several functions in several files.
1333 Changes in different paragraphs are unrelated.
1335 You could argue that the CVS log entry for a file should contain the
1336 full @file{ChangeLog} paragraph mentioning the change to the file, even though
1337 it may mention other files, because that gives you the full context you
1338 need to understand the change.  This is the behavior you get when this
1339 variable is set to @code{t}, the default.
1341 On the other hand, you could argue that the CVS log entry for a change
1342 should contain only the text for the changes which occurred in that
1343 file, because the CVS log is per-file.  This is the behavior you get
1344 when this variable is set to @code{nil}.
1346 @findex cvs-mode-ignore@r{, and @file{.cvsignore} sorting}
1347 @item cvs-sort-ignore-file
1348 If this variable is set to any non-@samp{nil} value, the
1349 @file{.cvsignore} file will always be sorted whenever you use
1350 @samp{cvs-mode-ignore} to add a file to it.  This option is on by
1351 default.
1352 @end table
1355 @menu
1356 * Customizing Faces::
1357 @end menu
1359 @node Customizing Faces,  , Customization, Customization
1360 @section Customizing Faces
1361 @vindex cvs-header-face (face)
1362 @vindex cvs-filename-face (face)
1363 @vindex cvs-unknown-face (face)
1364 @vindex cvs-handled-face (face)
1365 @vindex cvs-need-action-face (face)
1366 @vindex cvs-marked-face (face)
1368 PCL-CVS adds a few extra features, including menus, mouse bindings, and
1369 fontification the @samp{*cvs*} buffer.  The faces defined for
1370 fontification are listed below:
1372 @table @samp
1373 @item cvs-header-face
1374 used to highlight directory changes.
1376 @item cvs-filename-face
1377 used to highlight file names.
1379 @item cvs-unknown-face
1380 used to highlight the status of files which are @samp{Unknown}.
1382 @item cvs-handled-face
1383 used to highlight the status of files which are handled and
1384 need no further action.
1386 @item cvs-need-action-face
1387 used to highlight the status of files which still need action.
1389 @item cvs-marked-face
1390 used to highlight the marked file indicator (@samp{*}).
1391 @end table
1394 @node   Bugs, Function and Variable Index, Customization, Top
1395 @chapter Bugs (known and unknown)
1396 @cindex Reporting bugs and ideas
1397 @cindex Bugs, how to report them
1398 @cindex Author, how to reach
1399 @cindex Email to the author
1400 @cindex Known bugs
1401 @cindex Bugs, known
1402 @cindex FAQ
1403 @cindex Problems, list of common
1405 If you find a bug or misfeature, don't hesitate to tell us!  Send email
1406 to @email{bug-gnu-emacs@@gnu.org} which is gatewayed to the newsgroup
1407 @samp{gnu.emacs.bugs}.  Feature requests should also be sent there.  We
1408 prefer discussing one thing at a time.  If you find several unrelated
1409 bugs, please report them separately.  If you are running PCL-CVS under
1410 XEmacs, you should also send a copy of bug reports to
1411 @email{xemacs-beta@@xemacs.org}.
1413 If you have problems using PCL-CVS or other questions, send them to
1414 @email{help-gnu-emacs@@gnu.org}, which is gatewayed to the
1415 @samp{gnu.emacs.help} newsgroup.  This is a good place to get help, as
1416 is @email{cvs-info@@gnu.org}, gatewayed to @samp{gnu.cvs.help}.
1418 If you have ideas for improvements, or if you have written some
1419 extensions to this package, we would like to hear from you.  We hope that
1420 you find this package useful!
1422 Below is a partial list of currently known problems with PCL-CVS.
1424 @table @asis
1425 @item Unexpected output from CVS
1426 Unexpected output from CVS may confuse PCL-CVS.  It will create
1427 warning messages in the @samp{*cvs*} buffer alerting you to any parse errors.
1428 If you get these messages, please send a bug report to the email
1429 addresses listed above.  Include the contents of the @samp{*cvs*} buffer, the
1430 output of the CVS process (which should be found in the @samp{ *cvs-tmp*}
1431 buffer), and the versions of Emacs, PCL-CVS and CVS you are using.
1432 @end table
1434 @node Function and Variable Index, Concept Index, Bugs, Top
1435 @unnumbered Function and Variable Index
1437 This is an index of all the functions and variables documented in this
1438 manual.
1440 @printindex fn
1442 @node     Concept Index, Key Index, Function and Variable Index, Top
1443 @unnumbered Concept Index
1445 This is an index of concepts discussed in this manual.
1447 @printindex cp
1449 @node     Key Index,  , Concept Index, Top
1450 @unnumbered Key Index
1452 This index includes an entry for each PCL-CVS key sequence documented in
1453 this manual.
1455 @printindex ky
1457 @setchapternewpage odd
1458 @summarycontents
1459 @contents
1460 @bye
1462 @ignore
1463    arch-tag: 5c7178ce-56fa-40b0-abd7-f4a09758b235
1464 @end ignore