Add 2013 to more copyright years
[emacs.git] / doc / misc / pcl-cvs.texi
blobcfce2604be1a64bbe16b7ea1b8826b823d76783d
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--2013 Free Software Foundation, Inc.
11 @quotation
12 Permission is granted to copy, distribute and/or modify this document
13 under the terms of the GNU Free Documentation License, Version 1.3 or
14 any later version published by the Free Software Foundation; with no
15 Invariant Sections, with the Front-Cover texts being ``A GNU Manual'',
16 and with the Back-Cover Texts as in (a) below.  A copy of the license
17 is included in the section entitled ``GNU Free Documentation License''.
19 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
20 modify this GNU manual.''
21 @end quotation
22 @end copying
24 @dircategory Emacs misc features
25 @direntry
26 * PCL-CVS: (pcl-cvs).           Emacs front-end to CVS.
27 @end direntry
29 @c The titlepage section does not appear in the Info file.
30 @titlepage
31 @sp 4
32 @c The title is printed in a large font.
33 @center @titlefont{User's Guide}
34 @sp
35 @center @titlefont{to}
36 @sp
37 @center @titlefont{PCL-CVS---The Emacs Front-End to CVS}
38 @ignore
39 @sp 2
40 @center release 2.9
41 @c -release-
42 @end ignore
43 @sp 3
44 @center Per Cederqvist
45 @center Stefan Monnier
46 @c -date-
48 @c  The following two commands start the copyright page
49 @c  for the printed manual.  This will not appear in the Info file.
50 @page
51 @vskip 0pt plus 1filll
52 @insertcopying
53 @end titlepage
55 @contents
57 @c ================================================================
58 @c                   The real text starts here
59 @c ================================================================
61 @node Top, About PCL-CVS, (dir), (dir)
62 @ifnottex
63 @top PCL-CVS
65 This manual describes PCL-CVS, the GNU Emacs front-end to CVS@.  It
66 is nowhere near complete, so you are advised to use @kbd{M-x
67 customize-group RET pcl-cvs @key{RET}} and to look at the documentation strings
68 of the various commands and major modes for further information.
69 @c This manual is updated to release 2.5 of PCL-CVS.
71 @insertcopying
73 @end ifnottex
75 @menu
76 * About PCL-CVS::               Credits, history, @dots{}
78 * Getting started::             An introduction with a walk-through example.
79 * Buffer contents::             An explanation of the buffer contents.
80 * Selected files::              To which files are commands applied.
81 * Commands::                    All commands, grouped by type.
83 * Log Edit Mode::               Major mode to edit log messages.
84 * Log View Mode::               Major mode to browse log changes.
85 @c * CVS Status Mode::             Major mode to view CVS' status output.
86 * Customization::               How you can tailor PCL-CVS to suit your needs.
87 * Bugs::                        Bugs (known and unknown).
89 * GNU Free Documentation License:: The license for this documentation.
90 * Function and Variable Index::  List of functions and variables.
91 * Concept Index::               List of concepts.
92 * Key Index::                   List of keystrokes.
94 @detailmenu
95  --- The Detailed Node Listing ---
97 About PCL-CVS
99 * Contributors::                Contributors to PCL-CVS.
101 Commands
103 * Entering PCL-CVS::            Commands to invoke PCL-CVS
104 * Setting flags::               Setting flags for CVS commands
105 * Updating the buffer::
106 * Movement commands::           How to move up and down in the buffer
107 * Marking files::               How to mark files that other commands
108                                 will later operate on.
109 * Committing changes::          Checking in your modifications to the
110                                 CVS repository.
111 * Editing files::               Loading files into Emacs.
112 * Getting info about files::    Display the log and status of files.
113 * Adding and removing files::   Adding and removing files
114 * Undoing changes::             Undoing changes
115 * Removing handled entries::    Uninteresting lines can easily be removed.
116 * Ignoring files::              Telling CVS to ignore generated files.
117 * Viewing differences::         Commands to @samp{diff} different versions.
118 * Invoking Ediff::              Running @samp{ediff} from @samp{*cvs*} buffer.
119 * Updating files::              Updating files that Need-update.
120 * Tagging files::               Tagging files.
121 * Miscellaneous commands::      Miscellaneous commands.
123 Customization
125 * Customizing Faces::
127 @end detailmenu
128 @end menu
130 @node     About PCL-CVS, Getting started, Top, Top
131 @chapter About PCL-CVS
132 @cindex About PCL-CVS
134 PCL-CVS is a front-end to CVS versions 1.9 and later.
135 It concisely shows the present status of a checked out module in an
136 Emacs buffer and provides single-key access to the most frequently used CVS
137 commands.  Note that the @code{vc-dir} command (@pxref{VC Directory
138 Mode, , , emacs, The GNU Emacs Manual}) provides similar
139 functionality, but for several version control systems, including CVS.
141 PCL-CVS was originally written many years ago by Per Cederqvist who
142 proudly maintained it until January 1996, at which point he released the
143 beta version 2.0b2 and passed on the maintainership to Greg A Woods.
144 Development stayed mostly dormant for a few years during which
145 version 2.0 never seemed to be able to leave the ``beta'' stage while a
146 separate XEmacs version was slowly splitting away.  In late 1998,
147 Stefan Monnier picked up development again, adding some major new
148 functionality and taking over the maintenance.
150 @menu
151 * Contributors::                Contributors to PCL-CVS.
152 @end menu
154 @node     Contributors,, About PCL-CVS, About PCL-CVS
155 @section Contributors to PCL-CVS
156 @cindex Contributors
157 @cindex Authors
159 Contributions to the package are welcome.  I have limited time to work
160 on this project, but I will gladly add any code that you contribute to
161 me to this package (@pxref{Bugs}).
163 The following persons have made contributions to PCL-CVS.
165 @itemize @bullet
166 @item
167 Brian Berliner wrote CVS, together with some other contributors.
168 Without his work on CVS this package would be useless@dots{}
170 @item
171 Per Cederqvist wrote most of the otherwise unattributed functions in
172 PCL-CVS as well as all the documentation.
174 @item
175 @email{inge@@lysator.liu.se, Inge Wallin} wrote the skeleton of
176 @file{pcl-cvs.texi}, and gave useful comments on it.  He also wrote
177 the files @file{elib-node.el} and @file{compile-all.el}.  The file
178 @file{cookie.el} was inspired by Inge.@refill
180 @item
181 @email{linus@@lysator.liu.se, Linus Tolke} contributed useful comments
182 on both the functionality and the documentation.@refill
184 @item
185 @email{jwz@@jwz.com, Jamie Zawinski} contributed
186 @file{pcl-cvs-lucid.el}, which was later renamed to
187 @file{pcl-cvs-xemacs.el}.@refill
189 @item
190 Leif Lonnblad contributed RCVS support (since superseded by the new
191 remote CVS support).
193 @item
194 @email{jimb@@cyclic.com, Jim Blandy} contributed hooks to automatically
195 guess CVS log entries from @file{ChangeLog} contents, and initial support of
196 the new Cygnus / Cyclic remote CVS, as well as various sundry bug fixes
197 and cleanups.
199 @item
200 @email{kingdon@@cyclic.com, Jim Kingdon} contributed lots of fixes to
201 the build and installation procedure.
203 @item
204 @email{woods@@weird.com, Greg A. Woods} contributed code to implement
205 the use of per-file diff buffers, and vendor join diffs with emerge and
206 ediff, as well as various and sundry bug fixes and cleanups.
208 @item
209 @email{greg.klanderman@@alum.mit.edu, Greg Klanderman} implemented
210 toggling of marked files, setting of CVS command flags via prefix
211 arguments, updated the XEmacs support, updated the manual, and fixed
212 numerous bugs.
214 @item
215 @email{monnier@@gnu.org, Stefan Monnier} added a slew of other
216 features and introduced even more new bugs.  If there's any bug left,
217 you can be sure it's his.
219 @item
220 @c wordy to avoid an underfull hbox
221 @email{masata-y@@is.aist-nara.ac.jp, Masatake YAMATO} made a gracious
222 contribution of his cvstree code to display a tree of tags which was later
223 superseded by the new @code{cvs-status-mode}.
224 @end itemize
226 Apart from these, a lot of people have sent us suggestions, ideas,
227 requests, bug reports and encouragement.  Thanks a lot!  Without you
228 there would be no new releases of PCL-CVS.
231 @node Getting started, Buffer contents, About PCL-CVS, Top
232 @chapter Getting started
233 @cindex Introduction
234 @cindex Example run
235 @cindex Sample session
237 This document assumes that you know what CVS is, and that you at least
238 know the fundamental concepts of CVS@.  If that is not the case, you
239 should read the CVS documentation.  Type @kbd{info -f cvs} or @kbd{man
240 cvs}.
242 PCL-CVS is only useful once you have checked out a module.  So before
243 you invoke it, you must have a copy of a module somewhere in the file
244 system.
246 You can invoke PCL-CVS by typing @kbd{M-x cvs-examine @key{RET}}.
247 You can also invoke it via the menu bar, under @samp{Tools}.
248 Or, if you prefer, you can also invoke PCL-CVS by simply visiting the
249 CVS administrative subdirectory of your module, with a prefix argument.
250 For example, to invoke PCL-CVS in a separate frame, type @kbd{C-u C-x 5
251 f ~/my/project/CVS @key{RET}}.
253 The function @code{cvs-examine} will ask for a directory.  The command
254 @samp{cvs -n update} will be run in that directory.  (It should contain
255 files that have been checked out from a CVS archive.)  The output from
256 @code{cvs} will be parsed and presented in a table in a buffer called
257 @samp{*cvs*}.  It might look something like this:
259 @example
260 Repository : /usr/CVSroot
261 Module     : test
262 Working dir: /users/ceder/FOO/test
265 In directory .:
266            Need-Update            bar
267            Need-Update            file.txt
268            Modified               namechange
269            Need-Update            newer
270 In directory sub:
271            Modified               ChangeLog
273 --------------------- End ---------------------
274 -- last cmd: cvs -f -z6 -n update -d -P --
275 @end example
277 In this example, your repository is in @file{/usr/CVSroot} and CVS has
278 been run in the directory @file{/users/ceder/FOO/test}.  The three files
279 (@file{bar}, @file{file.txt} and
280 @file{newer}) that are marked with @samp{Need-Update} have been changed
281 by someone else in the CVS repository.  Two files (@file{namechange}
282 and @file{sub/ChangeLog}) have been modified locally, and need to be
283 checked in.
285 You can move the cursor up and down in the buffer with @kbd{C-n} and
286 @kbd{C-p} or @kbd{n} and @kbd{p}.  If you press @kbd{c} on one of the
287 @samp{Modified} files, that file will be checked in to the CVS
288 repository. @xref{Committing changes}.  You can also press @kbd{O} to
289 update any of the files that are marked @samp{Need-Update}.  You can
290 also run @kbd{M-x cvs-update @key{RET}} (bound to @kbd{M-u} in the
291 @samp{*cvs*} buffer) to update all the files.@refill
293 You can then press @kbd{=} to easily get a @samp{diff} between your
294 modified file and the base version that you started from, or you can
295 press @kbd{l} to get the output from @samp{cvs log}.  Many more such
296 commands are available simply by pressing a key (@pxref{Getting info
297 about files}).
299 @node Buffer contents, Selected files, Getting started, Top
300 @chapter Buffer contents
301 @cindex Buffer contents
302 @cindex @code{*cvs*} buffer contents
304 The display contains several columns, some of which are optional.
305 These columns are, from left to right:
307 @itemize @bullet
309 @item
310 Optionally, the head revision of the file.  This is the latest version
311 found in the repository.  It might also contain (instead of the head
312 revision) a sub status which typically gives further information about
313 how we got to the current state, for example @samp{patched},
314 @samp{merged}, @dots{}
316 @item
317 An asterisk when the file is @dfn{marked} (@pxref{Selected
318 files}).@refill
320 @item
321 The actual status of the file wrt the repository.  See below.
323 @item
324 Optionally, the base revision of the file.  This is the version
325 which the copy in your working directory is based upon.
327 @item
328 The file name.
330 @end itemize
332 The @samp{file status} field can have the following values:
334 @table @samp
335 @item Modified
336 The file is modified in your working directory, and there was no
337 modification to the same file in the repository.  This status can have
338 the following substatus:
340 @table @samp
341 @item merged
342 The file was modified in your working directory, and there were
343 modifications in the repository as well, but they were merged
344 successfully, without conflict, in your working directory.@refill
345 @end table
347 @item Conflict
348 A conflict was detected while trying to merge your changes to @var{file}
349 with changes from the repository.  @var{file} (the copy in your
350 working directory) is now the output of the @code{rcsmerge} command on
351 the two versions; an unmodified copy of your file is also in your
352 working directory, with the name @file{.#@var{file}.@var{version}},
353 where @var{version} is the RCS revision that your modified file started
354 from.  @xref{Viewing differences}, for more details.@refill
356 A conflict can also come from a disagreement on the existence of the file
357 rather than on its content.  This case is indicated by the following
358 possible substatus:
360 @table @samp
361 @item removed
362 The file is locally removed but a new revision has been committed to
363 the repository by someone else.
365 @item added
366 The file is locally added and has also been added to the repository
367 by someone else.
369 @item modified
370 The file is locally modified but someone else has removed it from the
371 repository.
372 @end table
374 @item Added
375 The file has been added by you, but it still needs to be checked in to
376 the repository.@refill
378 @item Removed
379 The file has been removed by you, but it still needs to be checked in to
380 the repository.  You can resurrect it by typing @kbd{a} (@pxref{Adding
381 and removing files}).@refill
383 @item Unknown
384 A file that was detected in your directory, but that neither appears in
385 the repository, nor is present on the list of files that CVS should
386 ignore.@refill
388 @item Up-to-date
389 The file is up to date with respect to the version in the repository.
390 This status can have a substatus of:
392 @table @samp
393 @item added
394 You have just added the file to the repository.@refill
396 @item updated
397 The file was brought up to date with respect to the repository.  This is
398 done for any file that exists in the repository but not in your source,
399 and for files that you haven't changed but are not the most recent
400 versions available in the repository.@refill
402 @item patched
403 The file was brought up to date with respect to the remote repository by
404 way of fetching and applying a patch to the file in your source.  This
405 is equivalent to @samp{updated} except that CVS decided to use a hopefully
406 more efficient method.@refill
408 @item committed
409 You just committed the file.@refill
410 @end table
412 @item Need-Update
413 Either a newer version than the one in your source is available in the
414 repository and you have not modified your checked out version, or the
415 file exists in the repository but not in your source.  Use
416 @samp{cvs-mode-update} bound to @kbd{O} to update the file.@refill
418 @item Need-Merge
419 You have modified the checked out version of the file, and a newer
420 version is available in the repository.  A merge will take place when
421 you run a @samp{cvs-update}.
423 @item Missing
424 The file has been unexpectedly removed from your working directory
425 although it has not been @samp{cvs remove}d.
426 @end table
428 @node Selected files, Commands, Buffer contents, Top
429 @chapter Selected files
430 @cindex Selected files
431 @cindex Marked files
432 @cindex File selection
433 @cindex Active files
434 @cindex Applicable
436 Many of the commands work on the current set of @dfn{selected} files
437 which can be either the set of marked files (if any file is marked and
438 marks are not ignored) or whichever file or directory the cursor is on.
440 If a directory is selected but the command cannot be applied to a
441 directory, then it will be applied to the set of files under this
442 directory which are in the @samp{*cvs*} buffer.
444 @findex cvs-mode-force-command
445 @findex cvs-allow-dir-commit
446 Furthermore, each command only operates on a subset of the selected
447 files, depending on whether or not the command is @dfn{applicable} to
448 each file (based on the file's status).  For example,
449 @code{cvs-mode-commit} is not applicable to a file whose status is
450 @samp{Need-Update}.  If it should happen that PCL-CVS guesses the
451 applicability wrong, you can override it with the special prefix
452 @code{cvs-mode-force-command} normally bound to @kbd{M-f} (and file a
453 bug report).  The applicability rule can be slightly changed with
454 @code{cvs-allow-dir-commit} and @code{cvs-force-dir-tag}.
456 By default, marks are always in effect (you may change this, however, by
457 setting the variable @code{cvs-default-ignore-marks}) except for the
458 commands that @samp{tag} or @samp{diff} a file (which can be changed
459 with the variable @code{cvs-invert-ignore-marks}).
461 In addition, you may use the special prefix @code{cvs-mode-toggle-marks}
462 normally bound to @key{T} to toggle the use of marks for the following
463 command.
465 This scheme might seem a little complicated, but once one gets used to
466 it, it is quite powerful.
468 For commands to mark and unmark files, see @ref{Marking files}.
470 @node Commands, Log Edit Mode, Selected files, Top
471 @chapter Commands
473 @iftex
474 This chapter describes all the commands that you can use in PCL-CVS.
475 @end iftex
476 @ifnottex
477 The nodes in this menu contains explanations about all the commands that
478 you can use in PCL-CVS@.  They are grouped together by type.
479 @end ifnottex
481 @menu
482 * Entering PCL-CVS::            Commands to invoke PCL-CVS
483 * Setting flags::               Setting flags for CVS commands
484 * Updating the buffer::
485 * Movement commands::           How to move up and down in the buffer
486 * Marking files::               How to mark files that other commands
487                                 will later operate on.
488 * Committing changes::          Checking in your modifications to the
489                                 CVS repository.
490 * Editing files::               Loading files into Emacs.
491 * Getting info about files::    Display the log and status of files.
492 * Adding and removing files::   Adding and removing files
493 * Undoing changes::             Undoing changes
494 * Removing handled entries::    Uninteresting lines can easily be removed.
495 * Ignoring files::              Telling CVS to ignore generated files.
496 * Viewing differences::         Commands to @samp{diff} different versions.
497 * Invoking Ediff::              Running @samp{ediff} from @samp{*cvs*} buffer.
498 * Updating files::              Updating files that Need-update.
499 * Tagging files::               Tagging files.
500 * Miscellaneous commands::      Miscellaneous commands.
501 @end menu
504 @node Entering PCL-CVS, Setting flags, Commands, Commands
505 @section Entering PCL-CVS
506 @findex cvs-update
507 @findex cvs-examine
508 @findex cvs-status
509 @findex cvs-checkout
510 @findex cvs-quickdir
511 @cindex Creating the *cvs* buffer
513 Most commands in PCL-CVS require that you have a @samp{*cvs*}
514 buffer.  The commands that you use to get one are listed below.
515 For each, a @samp{cvs} process will be run, the output will be parsed by
516 PCL-CVS, and the result will be printed in the @samp{*cvs*} buffer (see
517 @ref{Buffer contents}, for a description of the buffer's contents).
519 @table @kbd
520 @item M-x cvs-update
521 Run a @samp{cvs update} command.  You will be asked for the directory
522 in which the @samp{cvs update} will be run.
524 @item M-x cvs-examine
525 Run a @samp{cvs -n update} command.  This is identical to the previous
526 command, except that it will only check what needs to be done but will
527 not change anything.  You will be asked for the directory in
528 which the @samp{cvs -n update} will be run.
530 @item M-x cvs-status
531 Run a @samp{cvs status} command.  You will be asked for the directory
532 in which the @samp{cvs status} will be run.
534 @item M-x cvs-checkout
535 Run a @samp{cvs checkout} command.  You will be asked for the directory
536 in which the @samp{cvs update} will be run and the module to be checked
537 out.
539 @item M-x cvs-quickdir
540 Populate the @samp{*cvs*} buffer by just looking at the @file{CVS/Entries}
541 files.  This is very much like @code{cvs-examine} except that it does
542 not access the CVS repository, which is a major advantage when the
543 repository is far away.  But of course, it will not be able to detect
544 when a file needs to be updated or merged.
545 @end table
547 @findex cvs-dired-action
548 @findex cvs-dired-use-hook
549 The first four of
550 those commands are also reachable from the menu bar
551 under @samp{Tools->PCL-CVS}.  Finally, an alternative way is to visit
552 the CVS administrative subdirectory in your work area with a simple
553 prefix argument.  For example @kbd{C-u C-x C-f ~/my/work/CVS @key{RET}}.  This
554 by default runs @code{cvs-quickdir} but the specific behavior can be
555 changed with @code{cvs-dired-action} and @code{cvs-dired-use-hook}.
557 By default, the commands above will descend recursively into
558 subdirectories.  You can avoid that behavior by including @samp{-l} in
559 the flags for the command.  These flags can be set by giving a prefix
560 argument to the command (e.g., by typing
561 @kbd{C-u M-x cvs-update @key{RET} -l @key{RET}}).
564 @node Setting flags, Updating the buffer, Entering PCL-CVS, Commands
565 @section Setting flags for CVS commands
566 @cindex Optional switches to CVS
567 @cindex Command-line options to CVS
569 This section describes the convention used by nearly all PCL-CVS
570 commands for setting optional flags sent to CVS@.  A single @kbd{C-u}
571 prefix argument is used to cause the command to prompt for flags to be
572 used for the current invocation of the command only.  Two @kbd{C-u} prefix
573 arguments are used to prompt for flags which will be set permanently, for the
574 current invocation and all that follow, until the flags are changed, or
575 unless temporary flags are set which override them.
577 Perhaps an example or two is in order.  Say you are about to add a
578 binary file to the repository, and want to specify the flags @samp{-kb}
579 to @samp{cvs add}.  You can type @kbd{C-u a -kb @key{RET}},
580 and the file will be added.  Subsequent @samp{cvs add}
581 commands will use the previously prevailing flags.
583 As a second example, say you are about to perform a diff and want to see
584 the result in unified diff format, i.e., you'd like to pass the flag
585 @samp{-u} to both @samp{cvs diff} and @samp{diff}.  You'd also like all
586 subsequent diffs to use this flag.  You can type @kbd{C-u C-u = -u @key{RET}}
587 and the diff will be performed, and the default flags will be set to
588 @code{("-u")}.  You can of course override this flag for a single diff
589 by using a single @kbd{C-u} prefix argument.
591 @cindex Special prefix
592 In addition to this, some commands can take @dfn{special prefix} arguments.
593 These work as follows: When called with a @kbd{C-u} prefix, the user is
594 prompted for a new value of the special prefix and the special prefix is
595 activated for the next command.  When called without the @kbd{C-u}
596 prefix, the special prefix is re-activated (with the same value as last
597 time) for the next command.  Calling the prefix command again when it's
598 already activated deactivates it.  Calling it with the @kbd{C-u C-u}
599 prefix activates it for all subsequent commands until you deactivate it
600 explicitly.  The special prefixes are:
602 @table @kbd
603 @item T
604 Toggles whether or not marks will be active in the next command.@refill
606 @item b
607 Provide the next command with a branch (can be any version
608 specifier) to work on.@refill
610 @item B
611 Secondary branch argument.  Only meaningful if @kbd{b} is also used.
612 It can be used to provide a second branch argument to
613 @code{cvs-mode-diff} or to @code{cvs-mode-update}.
615 @item M-f
616 Forces the next command to apply to every selected file rather than only
617 to the ones PCL-CVS thinks are relevant.
618 @end table
620 @node Updating the buffer, Movement commands, Setting flags, Commands
621 @section Updating the @samp{*cvs*} buffer
622 @findex cvs-update
623 @findex cvs-examine
624 @findex cvs-status
625 @findex cvs-mode-update
626 @findex cvs-mode-examine
627 @findex cvs-mode-status
629 The following commands can be used from within the @samp{*cvs*} buffer
630 to update the display:
632 @table @kbd
633 @item M-u
634 Runs the command @samp{cvs-update}.@refill
636 @item M-e
637 Runs the command @samp{cvs-examine}.@refill
639 @item M-s
640 Runs the command @samp{cvs-status}.@refill
641 @end table
643 In addition to the above commands which operate on the whole module,
644 you can run the equivalent CVS command on just a subset of the
645 files/directories with these keys:
647 @table @kbd
648 @item O
649 Runs @code{cvs-mode-update} on the selected files.  When run on the
650 top-level directory, this is equivalent to @kbd{M-u}.@refill
652 @item e
653 Runs @code{cvs-mode-examine} on the selected files.  When run on the
654 top-level directory, this is equivalent to @kbd{M-e}.@refill
656 @findex cvs-status-mode
657 @item s
658 Runs @code{cvs-mode-status} on the selected files.  When run on the
659 top-level directory, this is equivalent to @kbd{M-s}, except that
660 CVS output will be shown in a @samp{*cvs-info*} buffer that will be
661 put in @samp{cvs-status-mode}.@refill
662 @end table
665 @node Movement commands, Marking files, Updating the buffer, Commands
666 @section Movement Commands
667 @cindex Movement Commands
668 @findex cvs-mode-next-line
669 @findex cvs-mode-previous-line
670 @kindex SPC@r{--Move down one file}
671 @kindex n@r{--Move down one file}
672 @kindex p@r{--Move up one file}
674 You can use most normal Emacs commands to move forward and backward in
675 the buffer.  Some keys are rebound to functions that take advantage of
676 the fact that the buffer is a PCL-CVS buffer:
679 @table @kbd
680 @item @key{SPC}
681 @itemx n
682 These keys move the cursor one file forward, towards the end of the
683 buffer (@code{cvs-mode-next-line}).@refill
685 @itemx p
686 This key moves one file backward, towards the beginning of the buffer
687 (@code{cvs-mode-previous-line}).
688 @end table
691 @node Marking files, Committing changes, Movement commands, Commands
692 @section Marking files
693 @cindex Selecting files (commands to mark files)
694 @cindex Marking files
695 @kindex m@r{--marking a file}
696 @kindex M@r{--marking all files}
697 @kindex u@r{--unmark a file}
698 @kindex ESC DEL@r{--unmark all files}
699 @kindex DEL@r{--unmark previous file}
700 @kindex %@r{--mark files matching regexp}
701 @kindex S@r{--mark files in a particular state}
702 @kindex T@r{--toggle marks}
703 @findex cvs-mode-mark
704 @findex cvs-mode-unmark
705 @findex cvs-mode-mark-all-files
706 @findex cvs-mode-unmark-all-files
707 @findex cvs-mode-unmark-up
708 @findex cvs-mode-mark-matching-files
709 @findex cvs-mode-mark-on-state
710 @findex cvs-mode-toggle-marks
712 PCL-CVS works on a set of @dfn{selected files} (@pxref{Selected files}).
713 You can mark and unmark files with these commands:
715 @table @kbd
716 @item m
717 This marks the file that the cursor is positioned on.  If the cursor is
718 positioned on a directory all files in that directory are marked
719 (@code{cvs-mode-mark}).@refill
721 @item u
722 Unmark the file that the cursor is positioned on. If the cursor is on a
723 directory, all files in that directory are unmarked
724 (@code{cvs-mode-unmark}).@refill
726 @item M
727 Mark @emph{all} files in the buffer (@code{cvs-mode-mark-all-files}).
729 @item M-@key{DEL}
730 Unmark @emph{all} files (@code{cvs-mode-unmark-all-files}).
732 @item @key{DEL}
733 Unmark the file on the previous line, and move point to that line
734 (@code{cvs-mode-unmark-up}).
736 @item %
737 Mark all files matching a regular expression
738 (@code{cvs-mode-mark-matching-files}).
740 @item S
741 Mark all files in a particular state, such as ``Modified'' or
742 ``Removed'' (@code{cvs-mode-mark-on-state}).
744 @item T
745 Toggle use of marks for the next command (@code{cvs-mode-toggle-marks}).
746 @end table
749 @node Committing changes, Editing files, Marking files, Commands
750 @section Committing changes
751 @cindex Committing changes
752 @findex cvs-mode-commit
753 @findex cvs-mode-commit-setup
754 @kindex c@r{--commit files}
755 @kindex C@r{--commit files with @file{ChangeLog} message}
756 @vindex cvs-auto-revert@r{ (variable)}
757 @cindex Commit buffer
758 @cindex Edit buffer
759 @cindex Erasing commit message
760 @cindex Reverting buffers after commit
762 Committing changes basically works as follows:
764 @enumerate
765 @item
766 After having selected the files you want to commit, you type either
767 @kbd{c} or @kbd{C} which brings up a special buffer
768 @samp{*cvs-commit*}.@refill
770 @item
771 You type in the log message describing the changes you're about to
772 commit (@pxref{Log Edit Mode}).
774 @item
775 When you're happy with it, you type @kbd{C-c C-c} to do the actual
776 commit.@refill
777 @end enumerate
779 There's no hidden state, so you can abort the process or pick it up
780 again at any time.
782 @vindex log-edit-confirm@r{ (variable)}
783 The set of files actually committed is really decided only during the
784 very last step, which is a mixed blessing.  It allows you to go back and
785 change your mind about which files to commit, but it also means that you
786 might inadvertently change the set of selected files.  To reduce the
787 risk of error, @kbd{C-c C-c} will ask for confirmation if the set of
788 selected files has changed between the first step and the last.  You can
789 change this last detail with @code{log-edit-confirm}.
791 As for the difference between @kbd{c} (i.e., @code{cvs-mode-commit}) and
792 @kbd{C} (i.e., @code{cvs-mode-commit-setup}) is that the first gets you
793 straight to @samp{*cvs-commit*} without erasing it or changing anything
794 to its content, while the second first erases @samp{*cvs-commit*}
795 and tries to initialize it with a sane default (it does that by either
796 using a template provided by the CVS administrator or by extracting a
797 relevant log message from a @file{ChangeLog} file).
799 If you are editing the files in your Emacs, an automatic
800 @samp{revert-buffer} will be performed.  (If the file contains
801 @samp{$@asis{Id}$} keywords, @samp{cvs commit} will write a new file with
802 the new values substituted.  The auto-revert makes sure that you get
803 them into your buffer.)  The revert will not occur if you have modified
804 your buffer, or if @samp{cvs-auto-revert} is set to
805 @samp{nil}.
808 @node Editing files, Getting info about files, Committing changes, Commands
809 @section Editing files
810 @cindex Editing files
811 @cindex Finding files
812 @cindex Loading files
813 @cindex Dired
814 @cindex Invoking dired
815 @findex cvs-mode-find-file
816 @findex cvs-mode-find-file-other-window
817 @findex cvs-mode-add-change-log-entry-other-window
818 @kindex f@r{--find file or directory}
819 @kindex o@r{--find file in other window}
820 @kindex A@r{--add @file{ChangeLog} entry}
822 There are currently three commands that can be used to find a file (that
823 is, load it into a buffer and start editing it there).  These commands
824 work on the line that the cursor is situated at.  They always ignore any marked
825 files.
827 @table @kbd
828 @item f
829 Find the file that the cursor points to (@code{cvs-mode-find-file}).  If
830 the cursor points to a directory, run @code{dired} on that directory;
831 @inforef{Dired, , emacs}.
833 @item o
834 Like @kbd{f}, but use another window
835 (@code{cvs-mode-find-file-other-window}).@refill
837 @item A
838 Invoke @samp{add-change-log-entry-other-window} to edit a
839 @file{ChangeLog} file.  The @file{ChangeLog} file will be found in the
840 directory of the file the cursor points to, or in a parent of that
841 directory (@code{cvs-mode-add-change-log-entry-other-window}).@refill
842 @end table
845 @node Getting info about files, Adding and removing files, Editing files, Commands
846 @section Getting info about files
847 @cindex Status (cvs command)
848 @cindex Log (RCS/cvs command)
849 @cindex Getting status
850 @kindex l@r{--run @samp{cvs log}}
851 @kindex s@r{--run @samp{cvs status}}
852 @findex cvs-mode-log
853 @findex cvs-mode-status
855 @table @kbd
856 @item l
857 Call the command @code{cvs-mode-log} which runs @samp{cvs log} on all
858 selected files, and show the result in a temporary buffer
859 @samp{*cvs-info*} (@pxref{Log View Mode}).
861 @item s
862 Call the command @code{cvs-mode-status} which runs @samp{cvs status} on
863 all selected files, and show the result in a temporary buffer
864 @samp{*cvs-info*}.
865 @c Fixme: reinstate when node is written:
866 @c (@pxref{CVS Status Mode}).
867 @end table
870 @node Adding and removing files, Undoing changes, Getting info about files, Commands
871 @section Adding and removing files
872 @cindex Adding files
873 @cindex Removing files
874 @cindex Resurrecting files
875 @cindex Deleting files
876 @cindex Putting files under CVS control
877 @kindex a@r{--add a file}
878 @kindex r@r{--remove a file}
879 @findex cvs-mode-add
880 @findex cvs-mode-remove-file
882 The following commands are available to make it easy to add files to
883 and remove them from the CVS repository.
885 @table @kbd
886 @item a
887 Add all selected files.  This command can be used on @samp{Unknown}
888 files (@pxref{Buffer contents}).  The status of the file will change to
889 @samp{Added}, and you will have to use @kbd{c} (@samp{cvs-mode-commit}
890 @pxref{Committing changes}), to really add the file to the
891 repository.@refill
893 This command can also be used on @samp{Removed} files (before you commit
894 them) to resurrect them.
896 The command that is run is @code{cvs-mode-add}.
898 @item r
899 This command removes the selected files (after prompting for
900 confirmation).  The files are deleted from your directory and
901 (unless the status was @samp{Unknown}; @pxref{Buffer contents}) they will
902 also be @samp{cvs remove}d.  If the files' status was @samp{Unknown}
903 they will disappear from the buffer.  Otherwise their status will change to
904 @samp{Removed}, and you must use @kbd{c} (@samp{cvs-mode-commit},
905 @pxref{Committing changes}) to commit the removal.@refill
907 The command that is run is @code{cvs-mode-remove-file}.
908 @end table
911 @node Undoing changes, Removing handled entries, Adding and removing files, Commands
912 @section Undoing changes
913 @cindex Undo changes
914 @cindex Flush changes
915 @kindex U@r{--undo changes}
916 @findex cvs-mode-undo-local-changes
918 @table @kbd
919 @item U
920 If you have modified a file, and for some reason decide that you don't
921 want to keep the changes, you can undo them with this command.  It works
922 by removing your working copy of the file and then getting the latest
923 version from the repository (@code{cvs-mode-undo-local-changes}).
924 @end table
927 @node Removing handled entries, Ignoring files, Undoing changes, Commands
928 @section Removing handled entries
929 @cindex Expunging uninteresting entries
930 @cindex Uninteresting entries, getting rid of them
931 @cindex Getting rid of uninteresting lines
932 @cindex Removing uninteresting (processed) lines
933 @cindex Handled lines, removing them
934 @kindex x@r{--remove processed entries}
935 @kindex C-k@r{--remove selected entries}
936 @findex cvs-mode-remove-handled
937 @findex cvs-mode-acknowledge
938 @findex cvs-mode-ignore
940 @table @kbd
941 @item x
942 This command allows you to remove all entries that you have processed.
943 More specifically, the lines for @samp{Up-to-date} files (@pxref{Buffer
944 contents}) are removed from the buffer.  If a directory becomes empty
945 the heading for that directory is also removed.  This makes it easier to
946 get an overview of what needs to be done.
948 @vindex cvs-mode-remove-handled@r{ (variable)}
949 @kbd{x} invokes @code{cvs-mode-remove-handled}.  If
950 @samp{cvs-auto-remove-handled} is set to non-@code{nil}, this will
951 automatically be performed after every commit.@refill
953 @item C-k
954 This command can be used for lines that @samp{cvs-mode-remove-handled} would
955 not delete, but that you want to delete (@code{cvs-mode-acknowledge}).
956 @end table
959 @node Ignoring files, Viewing differences, Removing handled entries, Commands
960 @section Ignoring files
961 @cindex Ignoring files
962 @kindex i@r{--ignoring files}
963 @findex cvs-mode-ignore
965 @table @kbd
966 @item i
967 Arrange so that CVS will ignore the selected files.  The file names are
968 added to the @file{.cvsignore} file in the corresponding directory.  If
969 the @file{.cvsignore} file doesn't exist, it will be created.
971 The @file{.cvsignore} file should normally be added to the repository,
972 but you could ignore it as well, if you like it better that way.
974 This runs @code{cvs-mode-ignore}.
975 @end table
977 @node Viewing differences, Invoking Ediff, Ignoring files, Commands
978 @section Viewing differences
979 @cindex Diff
980 @cindex Invoking @code{diff}
981 @cindex Conflicts, how to resolve them
982 @cindex Viewing differences
983 @kindex d=@r{--run @samp{cvs diff}}
984 @kindex =@r{--run @samp{cvs diff}}
985 @kindex db@r{--diff against base version}
986 @kindex dh@r{--diff against head of repository}
987 @kindex dr@r{--diff between base and head of repository}
988 @kindex dv@r{--diff against vendor branch}
989 @kindex dy@r{--diff against yesterday's head}
990 @findex cvs-mode-diff
991 @findex cvs-mode-diff-backup
992 @findex cvs-mode-diff-head
993 @findex cvs-mode-diff-repository
994 @findex cvs-mode-diff-vendor
995 @findex cvs-mode-diff-yesterday
996 @vindex cvs-invert-ignore-marks@r{ (variable)}
998 @table @kbd
999 @item =
1000 @itemx d =
1001 Display a @samp{cvs diff} between the selected files and the version
1002 that they are based on (@code{cvs-mode-diff}).@refill
1004 @item d b
1005 If CVS finds a conflict while merging two versions of a file (during a
1006 @samp{cvs update}, @pxref{Updating the buffer}) it will save the
1007 original file in a file called @file{.#@var{file}.@var{version}} where
1008 @var{file} is the name of the file, and @var{version} is the revision
1009 number that @var{file} was based on.@refill
1011 With the @kbd{d b} command you can run a @samp{diff} on the files
1012 @file{.#@var{file}.@var{version}} and @file{@var{file}}.@refill
1014 @item d h
1015 Display a @samp{cvs diff} between the selected files and the head
1016 revision (the most recent version on the current
1017 branch) in the repository (@code{cvs-mode-diff-head}).@refill
1019 @item d r
1020 Display a @samp{cvs diff} between the base revision of the selected
1021 files and the head revision in the repository.  This displays the
1022 changes anyone has committed to the repository since you last executed
1023 a checkout, update or commit operation
1024 (@code{cvs-mode-diff-repository}).
1026 @item d v
1027 Display a @samp{cvs diff} between the selected files and the head
1028 revision of the vendor branch in the repository
1029 (@code{cvs-mode-diff-vendor}).@refill
1031 @item d y
1032 Display a @samp{cvs diff} between the selected files and yesterday's
1033 head revision in the repository
1034 (@code{cvs-mode-diff-yesterday}).@refill
1035 @end table
1037 By default, @samp{diff} commands ignore the marks.  This can be changed
1038 with @code{cvs-invert-ignore-marks}.
1040 @node Invoking Ediff, Updating files, Viewing differences, Commands
1041 @section Running ediff
1042 @cindex Ediff
1043 @cindex Invoking ediff
1044 @cindex Viewing differences
1045 @cindex Conflicts, how to resolve them
1046 @cindex Resolving conflicts
1047 @kindex e@r{--invoke @samp{ediff}}
1048 @findex cvs-mode-idiff
1049 @findex cvs-mode-imerge
1051 @table @kbd
1052 @vindex cvs-idiff-imerge-handlers@r{ (variable)}
1053 @item d e
1054 This uses @code{ediff} (or @code{emerge}, depending on
1055 @samp{cvs-idiff-imerge-handlers}) to allow you to view diffs.
1056 If a prefix argument is given, PCL-CVS will prompt for a revision against
1057 which the diff should be made, else the default will be to use the BASE
1058 revision.
1060 @cindex Merging with @code{ediff} and @code{emerge}
1061 @item d E
1062 This command use @code{ediff} (or @code{emerge}, see above) to allow you
1063 to do an interactive 3-way merge.
1065 @strong{Please note:}  when the file status is @samp{Conflict},
1066 CVS has already performed a merge.  The resulting file is not used in
1067 any way if you use this command.  If you use the @kbd{q} command inside
1068 @samp{ediff} (to successfully terminate a merge) the file that CVS
1069 created will be overwritten.@refill
1070 @end table
1072 @node Updating files, Tagging files, Invoking Ediff, Commands
1073 @section Updating files
1074 @findex cvs-mode-update
1075 @cindex Updating files
1076 @kindex O@r{--update files}
1078 @table @kbd
1079 @item O
1080 Update all selected files with status @samp{Need-update} by running
1081 @samp{cvs update} on them (@code{cvs-mode-update}).
1082 @end table
1085 @node Tagging files, Miscellaneous commands, Updating files, Commands
1086 @section Tagging files
1087 @findex cvs-mode-tag
1088 @findex cvs-mode-untag
1089 @findex cvs-rtag
1090 @cindex Tagging files
1091 @kindex M-t@r{--repository tag files}
1092 @kindex t@r{--tag files}
1093 @vindex cvs-invert-ignore-marks@r{ (variable)}
1094 @vindex cvs-force-dir-tag@r{ (variable)}
1096 @table @kbd
1097 @item t
1098 Tag all selected files by running @samp{cvs tag} on
1099 them (@code{cvs-mode-tag}).  It's usually preferable to tag a directory
1100 at a time.  Rather than selecting all files (which too often doesn't
1101 select all files but only the few that are displayed), clear the
1102 selection with @kbd{M-DEL} (@code{cvs-mode-unmark-all-files}), position
1103 the cursor on the directory you want to tag and hit @kbd{t}.
1104 @end table
1106 By default, @samp{tag} commands ignore the marks.  This can be changed
1107 with @code{cvs-invert-ignore-marks}.  Also, by default @samp{tag} can
1108 only be applied to directories, see @code{cvs-force-dir-tag} if you want
1109 to change this behavior.
1112 @node Miscellaneous commands,  , Tagging files, Commands
1113 @section Miscellaneous commands
1114 @findex cvs-mode-byte-compile-files
1115 @cindex Recompiling elisp files
1116 @cindex Byte compilation
1117 @findex cvs-mode-delete-lock
1118 @cindex Getting rid of lock files
1119 @cindex Lock files
1120 @kindex q@r{--bury the PCL-CVS buffer}
1121 @findex cvs-bury-buffer
1122 @findex cvs-mode-quit
1123 @cindex Quitting
1124 @kindex h@r{--help}
1125 @kindex ?@r{--help}
1126 @findex cvs-help
1127 @cindex Help
1129 @table @kbd
1130 @item M-x cvs-mode-byte-compile-files
1131 Byte compile all selected files that end in @file{.el}.
1133 @item M-x cvs-mode-delete-lock
1134 This command deletes the lock files that
1135 the @samp{*cvs*} buffer informs you about.  You should normally never have to
1136 use this command, since CVS tries very carefully to always remove the
1137 lock files itself.
1139 You can only use this command when a message in the @samp{*cvs*} buffer tells
1140 you so.  You should wait a while before using this command in case
1141 someone else is running a @code{cvs} command.
1143 Also note that this only works if the repository is local.
1145 @item ?
1146 @itemx h
1147 Show a summary of common command key bindings in the echo
1148 area (@code{cvs-help}).
1150 @item q
1151 Bury the PCL-CVS buffer (@code{cvs-bury-buffer}).
1153 @item M-x cvs-mode-quit
1154 Quit PCL-CVS, killing the @samp{*cvs*} buffer.
1155 @end table
1157 @node Log Edit Mode, Log View Mode, Commands, Top
1158 @chapter Editing a Log Message
1160 @cindex Log Edit mode
1161 @cindex mode, Log Edit
1162 Buffers for entering/editing log messages for changes which are about
1163 to be committed are put into Log Edit mode.
1165 Sometimes the log buffer contains default text when you enter it,
1166 typically the last log message entered.  If it does, mark and point
1167 are set around the entire contents of the buffer so that it is easy to
1168 kill the contents of the buffer with @kbd{C-w}.
1170 @findex log-edit-insert-changelog
1171 If you work by writing entries in the @file{ChangeLog}
1172 (@pxref{Change Log,,, emacs, The GNU Emacs Manual}) and then commit the change under revision
1173 control, you can generate the Log Edit text from the ChangeLog using
1174 @kbd{C-c C-a} (@kbd{log-edit-insert-changelog}).  This looks for
1175 entries for the file(s) concerned in the top entry in the ChangeLog
1176 and uses those paragraphs as the log text.  This text is only inserted
1177 if the top entry was made under your user name on the current date.
1178 @xref{Change Logs and VC,,, emacs, The GNU Emacs Manual}, for the opposite way of
1179 working---generating ChangeLog entries from the revision control log.
1181 In the Log Edit buffer, @kbd{C-c C-f} (@kbd{M-x log-edit-show-files})
1182 shows the list of files to be committed in case you need to check
1183 that.
1185 When you have finished editing the log message, type @kbd{C-c C-c} to
1186 exit the buffer and commit the change.
1188 @c Fixme: customization variables
1190 @node Log View Mode, Customization, Log Edit Mode, Top
1191 @chapter Browsing a Log of Changes
1193 @cindex Log View mode
1194 @cindex mode, Log View
1195 @cindex output, logs
1197 @findex cvs-mode-log
1198 @findex vc-print-log
1199 Log View mode provides a few useful commands for navigating revision
1200 control log output.  It is used for the output buffers of both
1201 @code{cvs-mode-log} and @code{vc-print-log}.
1203 In this mode, @kbd{n} goes to the next message and @kbd{p} goes to the
1204 previous message and @kbd{N} and @kbd{P} go to the next and previous
1205 files, respectively, in multi-file output.  With a numeric prefix
1206 argument, these commands move that many messages of files.
1208 @c @node CVS Status Mode
1209 @c @chapter Viewing CVS' Status output
1211 @node Customization, Bugs, Log View Mode, Top
1212 @chapter Customization
1213 @vindex log-edit-changelog-full-paragraphs@r{ (variable)}
1214 @vindex cvs-auto-remove-handled@r{ (variable)}
1215 @vindex cvs-auto-remove-directories@r{ (variable)}
1216 @vindex cvs-update-prog-output-skip-regexp@r{ (variable)}
1217 @vindex cvs-cvsroot@r{ (variable)}
1218 @vindex cvs-auto-revert@r{ (variable)}
1219 @vindex log-edit-require-final-newline@r{ (variable)}
1220 @vindex cvs-sort-ignore-file@r{ (variable)}
1221 @cindex Customization
1222 @cindex Variables, list of all
1223 @cindex Erasing input buffer
1224 @cindex Context diff, how to get
1225 @cindex Unidiff, how to get
1226 @cindex Automatically remove handled files
1227 @cindex @samp{-u} option in modules file
1228 @cindex Modules file (@samp{-u} option)
1229 @cindex Update program (@samp{-u} option in modules file)
1230 @cindex Reverting buffers after commit
1231 @cindex Require final newline
1232 @cindex Automatically inserting newline
1233 @cindex Commit message, inserting newline
1234 @cindex Sorting @file{.cvsignore} file
1235 @cindex @file{.cvsignore} file, sorting
1236 @cindex Automatically sorting @file{.cvsignore}
1237 @cindex @samp{CVSROOT}, overriding
1239 If you have an idea about any customization that would be handy but
1240 isn't present in this list, please tell us!
1241 For info on how to reach us, see @ref{Bugs}.@refill
1243 @table @samp
1244 @item cvs-auto-remove-handled
1245 If this variable is set to any non-@code{nil} value,
1246 @samp{cvs-mode-remove-handled} will be called every time you check in
1247 files, after the check-in is ready.  @xref{Removing handled
1248 entries}.@refill
1250 @item cvs-auto-remove-directories
1251 If this variable is set to any non-@code{nil} value, directories that do
1252 not contain any files to be checked in will not be listed in the
1253 @samp{*cvs*} buffer.@refill
1255 @item cvs-auto-revert
1256 If this variable is set to any non-@samp{nil} value any buffers you have
1257 that visit a file that is committed will be automatically reverted.
1258 This variable defaults to @samp{t}. @xref{Committing changes}.@refill
1260 @item cvs-update-prog-output-skip-regexp
1261 The @samp{-u} flag in the @file{modules} file can be used to run a command
1262 whenever a @samp{cvs update} is performed (see @code{cvs(5)}).  This regexp
1263 is used to search for the last line in that output.  It is normally set
1264 to @samp{$}.  That setting is only correct if the command outputs
1265 nothing.  Note that PCL-CVS will get very confused if the command
1266 outputs @emph{anything} to @code{stderr}.
1268 @item cvs-cvsroot
1269 This variable can be set to override @samp{CVSROOT}.  It should be a
1270 string.  If it is set, then every time a @code{cvs} command is run, it
1271 will be called as @samp{cvs -d @var{cvs-cvsroot}@dots{}}.  This can be
1272 useful if your site has several repositories.
1274 @item log-edit-require-final-newline
1275 @c wordy to avoid underfull hbox
1276 When you enter a log message by typing into the
1277 @samp{*cvs-commit-message*} buffer, PCL-CVS normally automatically
1278 inserts a trailing newline, unless there already is one.  This behavior
1279 can be controlled via @samp{cvs-commit-buffer-require-final-newline}.
1280 If it is @samp{t} (the default behavior), a newline will always be
1281 appended.  If it is @samp{nil}, newlines will never be appended.  Any
1282 other value causes PCL-CVS to ask the user whenever there is no trailing
1283 newline in the commit message buffer.
1285 @findex cvs-mode-changelog-commit
1286 @item log-edit-changelog-full-paragraphs
1287 If this variable is non-@code{nil}, include full @file{ChangeLog}
1288 paragraphs in the CVS log created by @samp{cvs-mode-changelog-commit}.
1289 This may be set in the local variables section of a @file{ChangeLog}
1290 file, to indicate the policy for that @file{ChangeLog}.
1292 @cindex @file{ChangeLog} paragraphs
1293 A @dfn{@file{ChangeLog} paragraph} is a bunch of log text containing no
1294 blank lines; a paragraph usually describes a set of changes with a
1295 single purpose, but perhaps spanning several functions in several files.
1296 Changes in different paragraphs are unrelated.
1298 You could argue that the CVS log entry for a file should contain the
1299 full @file{ChangeLog} paragraph mentioning the change to the file, even though
1300 it may mention other files, because that gives you the full context you
1301 need to understand the change.  This is the behavior you get when this
1302 variable is set to @code{t}, the default.
1304 On the other hand, you could argue that the CVS log entry for a change
1305 should contain only the text for the changes which occurred in that
1306 file, because the CVS log is per-file.  This is the behavior you get
1307 when this variable is set to @code{nil}.
1309 @findex cvs-mode-ignore@r{, and @file{.cvsignore} sorting}
1310 @item cvs-sort-ignore-file
1311 If this variable is set to any non-@samp{nil} value, the
1312 @file{.cvsignore} file will always be sorted whenever you use
1313 @samp{cvs-mode-ignore} to add a file to it.  This option is on by
1314 default.
1315 @end table
1318 @menu
1319 * Customizing Faces::
1320 @end menu
1322 @node Customizing Faces,  , Customization, Customization
1323 @section Customizing Faces
1324 @vindex cvs-header (face)
1325 @vindex cvs-filename (face)
1326 @vindex cvs-unknown (face)
1327 @vindex cvs-handled (face)
1328 @vindex cvs-need-action (face)
1329 @vindex cvs-marked (face)
1330 @vindex cvs-msg (face)
1332 PCL-CVS adds a few extra features, including menus, mouse bindings, and
1333 fontification of the @samp{*cvs*} buffer.  The faces defined for
1334 fontification are listed below:
1336 @table @samp
1337 @item cvs-header
1338 used to highlight directory changes.
1340 @item cvs-filename
1341 Used to highlight file names.
1343 @item cvs-unknown
1344 Used to highlight the status of files which are @samp{Unknown}.
1346 @item cvs-handled
1347 Used to highlight the status of files which are handled and
1348 need no further action.
1350 @item cvs-need-action
1351 Used to highlight the status of files which still need action.
1353 @item cvs-marked
1354 Used to highlight the marked file indicator (@samp{*}).
1356 @item cvs-msg
1357 Used to highlight CVS messages.
1358 @end table
1361 @node   Bugs, GNU Free Documentation License, Customization, Top
1362 @chapter Bugs (known and unknown)
1363 @cindex Reporting bugs and ideas
1364 @cindex Bugs, how to report them
1365 @cindex Author, how to reach
1366 @cindex Email to the author
1367 @cindex Known bugs
1368 @cindex Bugs, known
1369 @cindex FAQ
1370 @cindex Problems, list of common
1372 If you find a bug or misfeature, don't hesitate to tell us!  Send email
1373 to @email{bug-gnu-emacs@@gnu.org} which is gatewayed to the newsgroup
1374 @samp{gnu.emacs.bugs}.  Feature requests should also be sent there.  We
1375 prefer discussing one thing at a time.  If you find several unrelated
1376 bugs, please report them separately.  If you are running PCL-CVS under
1377 XEmacs, you should also send a copy of bug reports to
1378 @email{xemacs-beta@@xemacs.org}.
1380 If you have problems using PCL-CVS or other questions, send them to
1381 @email{help-gnu-emacs@@gnu.org}, which is gatewayed to the
1382 @samp{gnu.emacs.help} newsgroup.  This is a good place to get help, as
1383 is @email{cvs-info@@gnu.org}, gatewayed to @samp{gnu.cvs.help}.
1385 If you have ideas for improvements, or if you have written some
1386 extensions to this package, we would like to hear from you.  We hope that
1387 you find this package useful!
1389 Below is a partial list of currently known problems with PCL-CVS.
1391 @table @asis
1392 @item Unexpected output from CVS
1393 Unexpected output from CVS may confuse PCL-CVS@.  It will create
1394 warning messages in the @samp{*cvs*} buffer alerting you to any parse errors.
1395 If you get these messages, please send a bug report to the email
1396 addresses listed above.  Include the contents of the @samp{*cvs*} buffer, the
1397 output of the CVS process (which should be found in the @samp{ *cvs-tmp*}
1398 buffer), and the versions of Emacs, PCL-CVS and CVS you are using.
1399 @end table
1401 @node GNU Free Documentation License, Function and Variable Index, Bugs, Top
1402 @appendix GNU Free Documentation License
1403 @include doclicense.texi
1407 @node Function and Variable Index, Concept Index, GNU Free Documentation License, Top
1408 @unnumbered Function and Variable Index
1410 This is an index of all the functions and variables documented in this
1411 manual.
1413 @printindex fn
1415 @node     Concept Index, Key Index, Function and Variable Index, Top
1416 @unnumbered Concept Index
1418 This is an index of concepts discussed in this manual.
1420 @printindex cp
1422 @node     Key Index,  , Concept Index, Top
1423 @unnumbered Key Index
1425 This index includes an entry for each PCL-CVS key sequence documented in
1426 this manual.
1428 @printindex ky
1430 @bye