\input texinfo @c -*-texinfo-*-
@c %**start of header
@setfilename ../../info/pcl-cvs
-@settitle PCL-CVS --- Emacs Front-End to CVS
+@settitle PCL-CVS---Emacs Front-End to CVS
@syncodeindex vr fn
@c %**end of header
@copying
-Copyright @copyright{} 1991-2011
-Free Software Foundation, Inc.
+Copyright @copyright{} 1991--2013 Free Software Foundation, Inc.
@quotation
Permission is granted to copy, distribute and/or modify this document
is included in the section entitled ``GNU Free Documentation License''.
(a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
-modify this GNU manual. Buying copies from the FSF supports it in
-developing GNU and promoting software freedom.''
+modify this GNU manual.''
@end quotation
@end copying
@sp
@center @titlefont{to}
@sp
-@center @titlefont{PCL-CVS --- The Emacs Front-End to CVS}
+@center @titlefont{PCL-CVS---The Emacs Front-End to CVS}
@ignore
@sp 2
@center release 2.9
@c The real text starts here
@c ================================================================
-@node Top, About PCL-CVS, (dir), (dir)
@ifnottex
+@node Top
@top PCL-CVS
-This manual describes PCL-CVS, the GNU Emacs front-end to CVS. It
+This manual describes PCL-CVS, the GNU Emacs front-end to CVS@. It
is nowhere near complete, so you are advised to use @kbd{M-x
customize-group RET pcl-cvs @key{RET}} and to look at the documentation strings
of the various commands and major modes for further information.
@c This manual is updated to release 2.5 of PCL-CVS.
-@insertcopying
+@insertcopying
@end ifnottex
@end detailmenu
@end menu
-@node About PCL-CVS, Getting started, Top, Top
+@node About PCL-CVS
@chapter About PCL-CVS
@cindex About PCL-CVS
PCL-CVS is a front-end to CVS versions 1.9 and later.
It concisely shows the present status of a checked out module in an
Emacs buffer and provides single-key access to the most frequently used CVS
-commands.
-For Emacs users accustomed to VC, PCL-CVS can be thought of as a replacement
-for VC-dired (@pxref{VC Directory Mode, , , emacs, The GNU
-Emacs Manual}) specifically designed for CVS.
+commands. Note that the @code{vc-dir} command (@pxref{VC Directory
+Mode, , , emacs, The GNU Emacs Manual}) provides similar
+functionality, but for several version control systems, including CVS.
PCL-CVS was originally written many years ago by Per Cederqvist who
proudly maintained it until January 1996, at which point he released the
* Contributors:: Contributors to PCL-CVS.
@end menu
-@node Contributors,, About PCL-CVS, About PCL-CVS
+@node Contributors
@section Contributors to PCL-CVS
@cindex Contributors
@cindex Authors
the build and installation procedure.
@item
-@email{woods@@weird.com, Greg A.@: Woods} contributed code to implement
+@email{woods@@weird.com, Greg A. Woods} contributed code to implement
the use of per-file diff buffers, and vendor join diffs with emerge and
ediff, as well as various and sundry bug fixes and cleanups.
there would be no new releases of PCL-CVS.
-@node Getting started, Buffer contents, About PCL-CVS, Top
+@node Getting started
@chapter Getting started
@cindex Introduction
@cindex Example run
@cindex Sample session
This document assumes that you know what CVS is, and that you at least
-know the fundamental concepts of CVS. If that is not the case, you
+know the fundamental concepts of CVS@. If that is not the case, you
should read the CVS documentation. Type @kbd{info -f cvs} or @kbd{man
cvs}.
commands are available simply by pressing a key (@pxref{Getting info
about files}).
-@node Buffer contents, Selected files, Getting started, Top
+@node Buffer contents
@chapter Buffer contents
@cindex Buffer contents
@cindex @code{*cvs*} buffer contents
although it has not been @samp{cvs remove}d.
@end table
-@node Selected files, Commands, Buffer contents, Top
+@node Selected files
@chapter Selected files
@cindex Selected files
@cindex Marked files
For commands to mark and unmark files, see @ref{Marking files}.
-@node Commands, Log Edit Mode, Selected files, Top
+@node Commands
@chapter Commands
@iftex
@end iftex
@ifnottex
The nodes in this menu contains explanations about all the commands that
-you can use in PCL-CVS. They are grouped together by type.
+you can use in PCL-CVS@. They are grouped together by type.
@end ifnottex
@menu
@end menu
-@node Entering PCL-CVS, Setting flags, Commands, Commands
+@node Entering PCL-CVS
@section Entering PCL-CVS
@findex cvs-update
@findex cvs-examine
@kbd{C-u M-x cvs-update @key{RET} -l @key{RET}}).
-@node Setting flags, Updating the buffer, Entering PCL-CVS, Commands
+@node Setting flags
@section Setting flags for CVS commands
@cindex Optional switches to CVS
@cindex Command-line options to CVS
This section describes the convention used by nearly all PCL-CVS
-commands for setting optional flags sent to CVS. A single @kbd{C-u}
+commands for setting optional flags sent to CVS@. A single @kbd{C-u}
prefix argument is used to cause the command to prompt for flags to be
used for the current invocation of the command only. Two @kbd{C-u} prefix
arguments are used to prompt for flags which will be set permanently, for the
commands will use the previously prevailing flags.
As a second example, say you are about to perform a diff and want to see
-the result in unified diff format, i.e. you'd like to pass the flag
+the result in unified diff format, i.e., you'd like to pass the flag
@samp{-u} to both @samp{cvs diff} and @samp{diff}. You'd also like all
subsequent diffs to use this flag. You can type @kbd{C-u C-u = -u @key{RET}}
and the diff will be performed, and the default flags will be set to
to the ones PCL-CVS thinks are relevant.
@end table
-@node Updating the buffer, Movement commands, Setting flags, Commands
+@node Updating the buffer
@section Updating the @samp{*cvs*} buffer
@findex cvs-update
@findex cvs-examine
@end table
-@node Movement commands, Marking files, Updating the buffer, Commands
+@node Movement commands
@section Movement Commands
@cindex Movement Commands
@findex cvs-mode-next-line
@end table
-@node Marking files, Committing changes, Movement commands, Commands
+@node Marking files
@section Marking files
@cindex Selecting files (commands to mark files)
@cindex Marking files
@end table
-@node Committing changes, Editing files, Marking files, Commands
+@node Committing changes
@section Committing changes
@cindex Committing changes
@findex cvs-mode-commit
selected files has changed between the first step and the last. You can
change this last detail with @code{log-edit-confirm}.
-As for the difference between @kbd{c} (i.e. @code{cvs-mode-commit}) and
-@kbd{C} (i.e. @code{cvs-mode-commit-setup}) is that the first gets you
+As for the difference between @kbd{c} (i.e., @code{cvs-mode-commit}) and
+@kbd{C} (i.e., @code{cvs-mode-commit-setup}) is that the first gets you
straight to @samp{*cvs-commit*} without erasing it or changing anything
to its content, while the second first erases @samp{*cvs-commit*}
and tries to initialize it with a sane default (it does that by either
@samp{nil}.
-@node Editing files, Getting info about files, Committing changes, Commands
+@node Editing files
@section Editing files
@cindex Editing files
@cindex Finding files
@end table
-@node Getting info about files, Adding and removing files, Editing files, Commands
+@node Getting info about files
@section Getting info about files
@cindex Status (cvs command)
@cindex Log (RCS/cvs command)
@end table
-@node Adding and removing files, Undoing changes, Getting info about files, Commands
+@node Adding and removing files
@section Adding and removing files
@cindex Adding files
@cindex Removing files
@end table
-@node Undoing changes, Removing handled entries, Adding and removing files, Commands
+@node Undoing changes
@section Undoing changes
@cindex Undo changes
@cindex Flush changes
@end table
-@node Removing handled entries, Ignoring files, Undoing changes, Commands
+@node Removing handled entries
@section Removing handled entries
@cindex Expunging uninteresting entries
@cindex Uninteresting entries, getting rid of them
@end table
-@node Ignoring files, Viewing differences, Removing handled entries, Commands
+@node Ignoring files
@section Ignoring files
@cindex Ignoring files
@kindex i@r{--ignoring files}
This runs @code{cvs-mode-ignore}.
@end table
-@node Viewing differences, Invoking Ediff, Ignoring files, Commands
+@node Viewing differences
@section Viewing differences
@cindex Diff
@cindex Invoking @code{diff}
By default, @samp{diff} commands ignore the marks. This can be changed
with @code{cvs-invert-ignore-marks}.
-@node Invoking Ediff, Updating files, Viewing differences, Commands
+@node Invoking Ediff
@section Running ediff
@cindex Ediff
@cindex Invoking ediff
created will be overwritten.@refill
@end table
-@node Updating files, Tagging files, Invoking Ediff, Commands
+@node Updating files
@section Updating files
@findex cvs-mode-update
@cindex Updating files
@end table
-@node Tagging files, Miscellaneous commands, Updating files, Commands
+@node Tagging files
@section Tagging files
@findex cvs-mode-tag
@findex cvs-mode-untag
to change this behavior.
-@node Miscellaneous commands, , Tagging files, Commands
+@node Miscellaneous commands
@section Miscellaneous commands
@findex cvs-mode-byte-compile-files
@cindex Recompiling elisp files
Quit PCL-CVS, killing the @samp{*cvs*} buffer.
@end table
-@node Log Edit Mode, Log View Mode, Commands, Top
+@node Log Edit Mode
@chapter Editing a Log Message
@cindex Log Edit mode
@findex log-edit-insert-changelog
If you work by writing entries in the @file{ChangeLog}
-(@pxref{(emacs)Change Log}) and then commit the change under revision
+(@pxref{Change Log,,, emacs, The GNU Emacs Manual}) and then commit the change under revision
control, you can generate the Log Edit text from the ChangeLog using
@kbd{C-c C-a} (@kbd{log-edit-insert-changelog}). This looks for
entries for the file(s) concerned in the top entry in the ChangeLog
and uses those paragraphs as the log text. This text is only inserted
if the top entry was made under your user name on the current date.
-@xref{(emacs)Change Logs and VC}, for the opposite way of
+@xref{Change Logs and VC,,, emacs, The GNU Emacs Manual}, for the opposite way of
working---generating ChangeLog entries from the revision control log.
In the Log Edit buffer, @kbd{C-c C-f} (@kbd{M-x log-edit-show-files})
@c Fixme: customization variables
-@node Log View Mode, Customization, Log Edit Mode, Top
+@node Log View Mode
@chapter Browsing a Log of Changes
@cindex Log View mode
@c @node CVS Status Mode
@c @chapter Viewing CVS' Status output
-@node Customization, Bugs, Log View Mode, Top
+@node Customization
@chapter Customization
@vindex log-edit-changelog-full-paragraphs@r{ (variable)}
@vindex cvs-auto-remove-handled@r{ (variable)}
useful if your site has several repositories.
@item log-edit-require-final-newline
-@c wordy to avoid unhderfull hbox
+@c wordy to avoid underfull hbox
When you enter a log message by typing into the
@samp{*cvs-commit-message*} buffer, PCL-CVS normally automatically
inserts a trailing newline, unless there already is one. This behavior
* Customizing Faces::
@end menu
-@node Customizing Faces, , Customization, Customization
+@node Customizing Faces
@section Customizing Faces
@vindex cvs-header (face)
@vindex cvs-filename (face)
@end table
-@node Bugs, GNU Free Documentation License, Customization, Top
+@node Bugs
@chapter Bugs (known and unknown)
@cindex Reporting bugs and ideas
@cindex Bugs, how to report them
@table @asis
@item Unexpected output from CVS
-Unexpected output from CVS may confuse PCL-CVS. It will create
+Unexpected output from CVS may confuse PCL-CVS@. It will create
warning messages in the @samp{*cvs*} buffer alerting you to any parse errors.
If you get these messages, please send a bug report to the email
addresses listed above. Include the contents of the @samp{*cvs*} buffer, the
buffer), and the versions of Emacs, PCL-CVS and CVS you are using.
@end table
-@node GNU Free Documentation License, Function and Variable Index, Bugs, Top
+@node GNU Free Documentation License
@appendix GNU Free Documentation License
@include doclicense.texi
-@node Function and Variable Index, Concept Index, GNU Free Documentation License, Top
+@node Function and Variable Index
@unnumbered Function and Variable Index
This is an index of all the functions and variables documented in this
@printindex fn
-@node Concept Index, Key Index, Function and Variable Index, Top
+@node Concept Index
@unnumbered Concept Index
This is an index of concepts discussed in this manual.
@printindex cp
-@node Key Index, , Concept Index, Top
+@node Key Index
@unnumbered Key Index
This index includes an entry for each PCL-CVS key sequence documented in