Mercurial > emacs
changeset 34180:4cd2e11b3aca
Fix markup, add index entries, make the DVI output prettier.
author | Eli Zaretskii <eliz@gnu.org> |
---|---|
date | Mon, 04 Dec 2000 16:17:49 +0000 |
parents | 82306439b33d |
children | 8f8830861b15 |
files | man/pcl-cvs.texi |
diffstat | 1 files changed, 266 insertions(+), 262 deletions(-) [+] |
line wrap: on
line diff
--- a/man/pcl-cvs.texi Mon Dec 04 16:15:18 2000 +0000 +++ b/man/pcl-cvs.texi Mon Dec 04 16:17:49 2000 +0000 @@ -1,6 +1,6 @@ \input texinfo @c -*-texinfo-*- -@c "@(#)$Name: $:$Id: pcl-cvs.texi,v 1.6 2000/10/07 19:15:54 eliz Exp $" +@c "@(#)$Name: $:$Id: pcl-cvs.texi,v 1.7 2000/11/21 11:39:43 fx Exp $" @c Documentation for the GNU Emacs CVS mode. @c Copyright (C) 1991-2000 Free Software Foundation, Inc. @@ -23,7 +23,7 @@ @c %**start of header @setfilename ../info/pcl-cvs -@settitle PCL-CVS - Emacs Front-End to CVS +@settitle PCL-CVS--Emacs Front-End to CVS @c %**end of header @dircategory Emacs @@ -54,7 +54,7 @@ Software Foundation raise funds for GNU development.'' @end ifinfo -@synindex vr fn +@syncodeindex vr fn @c The titlepage section does not appear in the Info file. @titlepage @sp 4 @@ -107,15 +107,15 @@ @ifinfo @top PCL-CVS -This info 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 RET} and to look at the documentation strings +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. @end ifinfo @menu -* About PCL-CVS:: Installation, credits, history, ... +* About PCL-CVS:: Installation, credits, history, @dots{} * Getting started:: An introduction with a walk-through example. * Buffer contents:: An explanation of the buffer contents. @@ -178,18 +178,19 @@ 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{(emacs)VC Dired Mode}) specifically designed for CVS. +for VC-dired (@pxref{VC Dired Mode, , Dired under VC, emacs, The GNU +Emacs Manual}) specifically designed for 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 beta version 2.0b2 and passed on the maintainership to Greg A Woods. -Development stayed mostly dormant for a few years during which the +Development stayed mostly dormant for a few years during which version 2.0 never seemed to be able to leave the ``beta'' stage while a separate XEmacs version was slowly splitting away. In late 1998, Stefan Monnier picked up development again, adding some major new -functionality and taking over maintenance. +functionality and taking over the maintenance. -As of Emacs-21, PCL-CVS is part of the standard Emacs distribution. +As of Emacs 21, PCL-CVS is part of the standard Emacs distribution. @menu * Contributors:: Contributors to PCL-CVS. @@ -214,58 +215,58 @@ @item Per Cederqvist wrote most of the otherwise unattributed functions in -PCL-CVS as well as all documentation. +PCL-CVS as well as all the documentation. @item -Inge Wallin (@samp{inge@@lysator.liu.se}) wrote the skeleton to +@email{inge@@lysator.liu.se, Inge Wallin} wrote the skeleton of @file{pcl-cvs.texi}, and gave useful comments on it. He also wrote the files @file{elib-node.el} and @file{compile-all.el}. The file @file{cookie.el} was inspired by Inge.@refill @item -Linus Tolke (@samp{linus@@lysator.liu.se}) contributed useful comments +@email{linus@@lysator.liu.se, Linus Tolke} contributed useful comments on both the functionality and the documentation.@refill @item -Jamie Zawinski (@samp{jwz@@jwz.com}) contributed +@email{jwz@@jwz.com, Jamie Zawinski} contributed @file{pcl-cvs-lucid.el}, which was later renamed to @file{pcl-cvs-xemacs.el}.@refill @item -Leif Lonnblad contributed RCVS support. (Since superceded by the new -remote CVS support.) +Leif Lonnblad contributed RCVS support (since superceded by the new +remote CVS support). @item -Jim Blandy (@samp{jimb@@cyclic.com}) contributed hooks to automatically -guess CVS log entries from ChangeLog contents; and initial support of -the new Cygnus / Cyclic remote CVS; as well as various sundry bug fixes +@email{jimb@@cyclic.com, Jim Blandy} contributed hooks to automatically +guess CVS log entries from @file{ChangeLog} contents, and initial support of +the new Cygnus / Cyclic remote CVS, as well as various sundry bug fixes and cleanups. @item -Jim Kingdon (@samp{kingdon@@cyclic.com}) contributed lots of fixes to -the build and install procedure. +@email{kingdon@@cyclic.com, Jim Kingdon} contributed lots of fixes to +the build and installation procedure. @item -Greg A. Woods (@samp{woods@@weird.com}) 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. +@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. @item -Greg Klanderman (@samp{greg.klanderman@@alum.mit.edu}) implemented -toggling of marked files; setting of CVS command flags via prefix -arguments; updated the XEmacs support; updated the manual; and fixed +@email{greg.klanderman@@alum.mit.edu, Greg Klanderman} implemented +toggling of marked files, setting of CVS command flags via prefix +arguments, updated the XEmacs support, updated the manual, and fixed numerous bugs. @item -Stefan Monnier (@samp{monnier@@cs.yale.edu}) added a slew of other +@email{monnier@@cs.yale.edu, Stefan Monnier} added a slew of other features and introduced even more new bugs. If there's any bug left, you can be sure it's his. @item -Masatake YAMATO (@samp{masata-y@@is.aist-nara.ac.jp}) graciously -contributed the cvstree code to display a tree of tags which was later -superseded by the new cvs-status-mode. - +@c wordy to avoid an underfull hbox +@email{masata-y@@is.aist-nara.ac.jp, Masatake YAMATO} made a gracious +contribution of his cvstree code to display a tree of tags which was later +superseded by the new @code{cvs-status-mode}. @end itemize Apart from these, a lot of people have sent us suggestions, ideas, @@ -277,27 +278,30 @@ @section Installation @cindex Installation -As mentioned above, PCL-CVS comes preinstalled since Emacs-21. -If you're using Emacs 20, you can download an older version of PCL-CVS -from @url{ftp://flint.cs.yale.edu/pub/monnier/pcl-cvs}. That version -also works on XEmacs. +As mentioned above, PCL-CVS comes bundled with Emacs version 21.1 and +later. If you're using Emacs 20, you can download an older version of +PCL-CVS from @uref{ftp://flint.cs.yale.edu/pub/monnier/pcl-cvs}. That +version also works on XEmacs. If you are running XEmacs 21.0 or later, PCL-CVS is available in pre-compiled package form. Please refer to the XEmacs manual for instructions regarding package selection and installation. Currently, -that PCL-CVS package also requires you to have installed the xemacs-base, -elib, and dired packages. +that PCL-CVS package also requires you to have installed the +@file{xemacs-base}, @file{elib}, and @file{dired} packages. If you have @TeX{} installed at your site, you can make a typeset manual from @file{pcl-cvs.texi}. @enumerate @item -Run @TeX{} by typing @samp{texi2dvi pcl-cvs.texi}. +If PCL-CVS came with the Emacs distribution, type @kbd{make pcl-cvs.dvi} +in the @file{man} subdirectory of the Emacs source tree. +@item +Alternatively, run @TeX{} by typing @kbd{texi2dvi pcl-cvs.texi}. @item Convert the resulting device independent file @file{pcl-cvs.dvi} to a form which your printer can output and print it. If you have a -postscript printer there is a program, @code{dvi2ps}, which does. There +PostScript printer, there is a program, @code{dvi2ps}, which does. There is also a program which comes together with @TeX{}, @code{dvips}, which you can use. @end enumerate @@ -307,20 +311,23 @@ @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 -should read the man page for CVS. +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}. PCL-CVS is only useful once you have checked out a module. So before -you invoke it you must have a copy of a module somewhere in the file +you invoke it, you must have a copy of a module somewhere in the file system. -You can invoke PCL-CVS by typing @kbd{M-x cvs-examine RET}. -You can also invoke it via the menubar, under Tools. -Or if you prefer, you can also invoke PCL-CVS by simply visiting the +You can invoke PCL-CVS by typing @kbd{M-x cvs-examine @key{RET}}. +You can also invoke it via the menu bar, under @samp{Tools}. +Or, if you prefer, you can also invoke PCL-CVS by simply visiting the CVS administrative subdirectory of your module, with a prefix argument. -F.ex. @kbd{C-u C-x 5 f ~/my/project/CVS RET}. +For example, to invoke PCL-CVS in a separate frame, type @kbd{C-u C-x 5 +f ~/my/project/CVS @key{RET}}. The function @code{cvs-examine} will ask for a directory. The command @samp{cvs -n update} will be run in that directory. (It should contain @@ -356,14 +363,14 @@ You can move the cursor up and down in the buffer with @kbd{C-n} and @kbd{C-p} or @kbd{n} and @kbd{p}. If you press @kbd{c} on one of the -@samp{Modified} files that file will be checked in to the CVS +@samp{Modified} files, that file will be checked in to the CVS repository. @xref{Committing changes}. You can also press @kbd{O} to update any of the files that are marked @samp{Need-Update}. You can -also run @kbd{M-x cvs-update RET} (bound to @kbd{M-u} in the +also run @kbd{M-x cvs-update @key{RET}} (bound to @kbd{M-u} in the @samp{*cvs*} buffer) to update all the files.@refill You can then press @kbd{=} to easily get a @samp{diff} between your -modified file and the base version that you started from or you can +modified file and the base version that you started from, or you can press @kbd{l} to get the output from @samp{cvs log}. Many more such commands are available simply by pressing a key (@pxref{Getting info about files}). @@ -371,9 +378,10 @@ @node Buffer contents, Selected files, Getting started, Top @chapter Buffer contents @cindex Buffer contents +@cindex @code{*cvs*} buffer contents The display contains several columns, some of which are optional. -They contain, from left to right: +These columns are, from left to right: @itemize @bullet @@ -382,15 +390,14 @@ found in the repository. It might also contain (instead of the head revision) a sub status which typically gives further information about how we got to the current state, for example @samp{patched}, -@samp{merged}, ... +@samp{merged}, @dots{} @item An asterisk when the file is @dfn{marked} (@pxref{Selected files}).@refill @item -The actual status of the file wrt to the repository. @xref{Buffer -contents}, for more information.@refill +The actual status of the file wrt the repository. See below. @item Optionally, the base revision of the file. This is the version @@ -404,25 +411,22 @@ The @samp{file status} field can have the following values: @table @samp - @item Modified The file is modified in your working directory, and there was no modification to the same file in the repository. This status can have the following substatus: @table @samp - @item merged The file was modified in your working directory, and there were modifications in the repository as well, but they were merged successfully, without conflict, in your working directory.@refill - @end table @item Conflict A conflict was detected while trying to merge your changes to @var{file} with changes from the repository. @var{file} (the copy in your -working directory) is now the output of the @samp{rcsmerge} command on +working directory) is now the output of the @code{rcsmerge} command on the two versions; an unmodified copy of your file is also in your working directory, with the name @file{.#@var{file}.@var{version}}, where @var{version} is the RCS revision that your modified file started @@ -433,7 +437,6 @@ possible substatus: @table @samp - @item removed The file is locally removed but a new revision has been committed to the repository by someone else. @@ -445,7 +448,6 @@ @item modified The file is locally modified but someone else has removed it from the repository. - @end table @item Added @@ -467,7 +469,6 @@ This status can have a substatus of: @table @samp - @item added You have just added the file to the repository.@refill @@ -485,7 +486,6 @@ @item committed You just committed the file.@refill - @end table @item Need-Update @@ -502,7 +502,6 @@ @item Missing The file has been unexpectedly removed from your working directory although it has not been @samp{cvs remove}d. - @end table @node Selected files, Commands, Buffer contents, Top @@ -521,6 +520,8 @@ directory, then it will be applied to the set of files under this directory which are in the @samp{*cvs*} buffer. +@findex cvs-mode-force-command +@findex cvs-allow-dir-commit Furthermore, each command only operates on a subset of the selected files, depending on whether or not the command is @dfn{applicable} to each file (based on the file's status). For example, @@ -543,7 +544,7 @@ This scheme might seem a little complicated, but once one gets used to it, it is quite powerful. -For commands to mark and unmark files, see @xref{Marking files}. +For commands to mark and unmark files, see @ref{Marking files}. @node Commands, Log Edit Mode, Selected files, Top @chapter Commands @@ -551,10 +552,10 @@ @iftex This chapter describes all the commands that you can use in PCL-CVS. @end iftex -@ifinfo +@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. -@end ifinfo +@end ifnottex @menu * Entering PCL-CVS:: Commands to invoke PCL-CVS @@ -592,10 +593,9 @@ buffer. The commands that you use to get one are listed below. For each, a @samp{cvs} process will be run, the output will be parsed by PCL-CVS, and the result will be printed in the @samp{*cvs*} buffer (see -@pxref{Buffer contents} for a description of the contents). +@ref{Buffer contents}, for a description of the buffer's contents). @table @kbd - @item M-x cvs-update Run a @samp{cvs update} command. You will be asked for the directory in which the @samp{cvs update} will be run. @@ -618,30 +618,32 @@ @item M-x cvs-quickdir Populate the @samp{*cvs*} buffer by just looking at the @file{CVS/Entries} files. This is very much like @code{cvs-examine} except that it does -not access the CVS repository which is a major advantage when the +not access the CVS repository, which is a major advantage when the repository is far away. But of course, it will not be able to detect when a file needs to be updated or merged. - @end table +@findex cvs-dired-action +@findex cvs-dired-use-hook The first four of -those commands are also reachable from the menubar -under @samp{Tools->PCL-CVS}. Finally an alternative way is to visit +those commands are also reachable from the menu bar +under @samp{Tools->PCL-CVS}. Finally, an alternative way is to visit the CVS administrative subdirectory in your work area with a simple -prefix argument. For example @kbd{C-u C-x C-f ~/my/work/CVS RET}. This -will by default run @code{cvs-quickdir} but the specific behavior can be +prefix argument. For example @kbd{C-u C-x C-f ~/my/work/CVS @key{RET}}. This +by default runs @code{cvs-quickdir} but the specific behavior can be changed with @code{cvs-dired-action} and @code{cvs-dired-use-hook}. By default, the commands above will descend recursively into subdirectories. You can avoid that behavior by including @samp{-l} in the flags for the command. These flags can be set by giving a prefix argument to the command (e.g., by typing -@kbd{C-u M-x cvs-update RET -l RET}). +@kbd{C-u M-x cvs-update @key{RET} -l @key{RET}}). @node Setting flags, Updating the buffer, Entering PCL-CVS, Commands @section Setting flags for CVS commands -@cindex Special prefix +@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} @@ -653,20 +655,21 @@ Perhaps an example or two is in order. Say you are about to add a binary file to the repository, and want to specify the flags @samp{-kb} -to @samp{cvs add}. You can type @kbd{C-u a -kb RET}, enter the -description, and the file will be added. Subsequent adds will use the -previously prevailing flags. +to @samp{cvs add}. You can type @kbd{C-u a -kb @key{RET}}, enter the +description, and the file will be added. Subsequent @samp{cvs add} +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 @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 RET} +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 @code{("-u")}. You can of course override this flag for a single diff by using a single @kbd{C-u} prefix argument. -Additionally to this, some commands can take @dfn{special prefix} arguments. -These work as follows: when called with a @kbd{C-u} prefix, the user is +@cindex Special prefix +In addition to this, some commands can take @dfn{special prefix} arguments. +These work as follows: When called with a @kbd{C-u} prefix, the user is prompted for a new value of the special prefix and the special prefix is activated for the next command. When called without the @kbd{C-u} prefix, the special prefix is re-activated (with the same value as last @@ -676,7 +679,6 @@ explicitly. The special prefixes are: @table @kbd - @item T Toggles whether or not marks will be active in the next command.@refill @@ -685,14 +687,13 @@ specifier) to work on.@refill @item B -Secondary branch argument. Only meaningful if `b' is also used. +Secondary branch argument. Only meaningful if @kbd{b} is also used. It can be used to provide a second branch argument to @code{cvs-mode-diff} or to @code{cvs-mode-update}. @item M-f Forces the next command to apply to every selected file rather than only to the ones PCL-CVS thinks are relevant. - @end table @node Updating the buffer, Movement commands, Setting flags, Commands @@ -708,38 +709,35 @@ to update the display: @table @kbd - @item M-u -This runs the command @samp{cvs-update}.@refill +Runs the command @samp{cvs-update}.@refill @item M-e -This runs the command @samp{cvs-examine}.@refill +Runs the command @samp{cvs-examine}.@refill @item M-s -This runs the command @samp{cvs-status}.@refill - +Runs the command @samp{cvs-status}.@refill @end table -Additionally to the above commands which operate on the whole module, +In addition to the above commands which operate on the whole module, you can run the equivalent CVS command on just a subset of the -files/directories with +files/directories with these keys: @table @kbd - @item O Runs @code{cvs-mode-update} on the selected files. When run on the -top level directory, this is equivalent to @kbd{M-u}.@refill +top-level directory, this is equivalent to @kbd{M-u}.@refill @item e Runs @code{cvs-mode-examine} on the selected files. When run on the -top level directory, this is equivalent to @kbd{M-e}.@refill +top-level directory, this is equivalent to @kbd{M-e}.@refill +@findex cvs-status-mode @item s Runs @code{cvs-mode-status} on the selected files. When run on the -top level directory, this is equivalent to @kbd{M-s} except that +top-level directory, this is equivalent to @kbd{M-s}, except that CVS output will be shown in a @samp{*cvs-info*} buffer that will be put in @samp{cvs-status-mode}.@refill - @end table @@ -748,9 +746,9 @@ @cindex Movement Commands @findex cvs-mode-next-line @findex cvs-mode-previous-line -@kindex SPC - Move down one file -@kindex n - Move down one file -@kindex p - Move up one file +@kindex SPC@r{--Move down one file} +@kindex n@r{--Move down one file} +@kindex p@r{--Move up one file} You can use most normal Emacs commands to move forward and backward in the buffer. Some keys are rebound to functions that take advantage of @@ -758,13 +756,13 @@ @table @kbd -@item SPC +@item @key{SPC} @itemx n These keys move the cursor one file forward, towards the end of the buffer (@code{cvs-mode-next-line}).@refill @itemx p -This key move one file backward, towards the beginning of the buffer +This key moves one file backward, towards the beginning of the buffer (@code{cvs-mode-previous-line}). @end table @@ -773,13 +771,13 @@ @section Marking files @cindex Selecting files (commands to mark files) @cindex Marking files -@kindex m - marking a file -@kindex M - marking all files -@kindex u - unmark a file -@kindex ESC DEL - unmark all files -@kindex DEL - unmark previous file -@kindex % - mark files matching regexp -@kindex T - toggle marks +@kindex m@r{--marking a file} +@kindex M@r{--marking all files} +@kindex u@r{--unmark a file} +@kindex ESC DEL@r{--unmark all files} +@kindex DEL@r{--unmark previous file} +@kindex %@r{--mark files matching regexp} +@kindex T@r{--toggle marks} @findex cvs-mode-mark @findex cvs-mode-unmark @findex cvs-mode-mark-all-files @@ -794,12 +792,12 @@ @table @kbd @item m This marks the file that the cursor is positioned on. If the cursor is -positioned on a directory all files in that directory will be marked. +positioned on a directory all files in that directory are marked. (@code{cvs-mode-mark}).@refill @item u Unmark the file that the cursor is positioned on. If the cursor is on a -directory, all files in that directory will be unmarked. +directory, all files in that directory are unmarked. (@code{cvs-mode-unmark}).@refill @item M @@ -824,12 +822,11 @@ @node Committing changes, Editing files, Marking files, Commands @section Committing changes @cindex Committing changes -@cindex Ci @findex cvs-mode-commit @findex cvs-mode-commit-setup -@kindex c - commit files -@kindex C - commit files with ChangeLog message -@vindex cvs-auto-revert (variable) +@kindex c@r{--commit files} +@kindex C@r{--commit files with @file{ChangeLog} message} +@vindex cvs-auto-revert@r{ (variable)} @cindex Commit buffer @cindex Edit buffer @cindex Erasing commit message @@ -850,14 +847,14 @@ @item When you're happy with it, you type @kbd{C-c C-c} to do the actual commit.@refill - @end enumerate There's no hidden state, so you can abort the process or pick it up again at any time. +@vindex log-edit-confirm@r{ (variable)} The set of files actually committed is really decided only during the -very last step, which is mixed blessing. It allows you to go back and +very last step, which is a mixed blessing. It allows you to go back and change your mind about which files to commit, but it also means that you might inadvertently change the set of selected files. To reduce the risk of error, @kbd{C-c C-c} will ask for confirmation if the set of @@ -867,14 +864,14 @@ 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 will first erase @samp{*cvs-commit*} -and try to initialize it with a sane default (it will do that by either +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 using a template provided by the CVS administrator or by extracting a -relevant log message from a ChangeLog file). +relevant log message from a @file{ChangeLog} file). -If you are editing the files in your Emacs an automatic +If you are editing the files in your Emacs, an automatic @samp{revert-buffer} will be performed. (If the file contains -@samp{$@asis{Id}$} keywords @samp{cvs commit} will write a new file with +@samp{$@asis{Id}$} keywords, @samp{cvs commit} will write a new file with the new values substituted. The auto-revert makes sure that you get them into your buffer). The revert will not occur if you have modified your buffer, or if @samp{cvs-auto-revert} is set to @@ -891,9 +888,9 @@ @findex cvs-mode-find-file @findex cvs-mode-find-file-other-window @findex cvs-mode-add-change-log-entry-other-window -@kindex f - find file or directory -@kindex o - find file in other window -@kindex A - add ChangeLog entry +@kindex f@r{--find file or directory} +@kindex o@r{--find file in other window} +@kindex A@r{--add @file{ChangeLog} entry} There are currently three commands that can be used to find a file (that is, load it into a buffer and start editing it there). These commands @@ -902,11 +899,9 @@ @table @kbd @item f -Find the file that the cursor points to. Run @samp{dired} -@ifinfo -(@pxref{Dired,,,Emacs}) -@end ifinfo -if the cursor points to a directory (@code{cvs-mode-find-file}).@refill +Find the file that the cursor points to (@code{cvs-mode-find-file}). If +the cursor points to a directory, run @code{dired} on that directory; +@inforef{Dired, , emacs}. @item o Like @kbd{f}, but use another window @@ -914,9 +909,9 @@ @item A Invoke @samp{add-change-log-entry-other-window} to edit a -@samp{ChangeLog} file. The @samp{ChangeLog} will be found in the -directory or a parent of the directory of the file the cursor points to. -(@code{cvs-mode-add-change-log-entry-other-window}).@refill +@file{ChangeLog} file. The @file{ChangeLog} file will be found in the +directory of the file the cursor points to, or in a parent of that +directory. (@code{cvs-mode-add-change-log-entry-other-window}).@refill @end table @@ -925,21 +920,21 @@ @cindex Status (cvs command) @cindex Log (RCS/cvs command) @cindex Getting status -@kindex l - run @samp{cvs log} -@kindex s - run @samp{cvs status} +@kindex l@r{--run @samp{cvs log}} +@kindex s@r{--run @samp{cvs status}} @findex cvs-mode-log @findex cvs-mode-status @table @kbd @item l Call the command @code{cvs-mode-log} which runs @samp{cvs log} on all -selected files, and show the result in a temporary @samp{*cvs-info*} -buffer (@pxref{Log View Mode}). +selected files, and show the result in a temporary buffer +@samp{*cvs-info*} (@pxref{Log View Mode}). @item s Call the command @code{cvs-mode-status} which runs @samp{cvs status} on -all selected files, and show the result in a temporary @samp{*cvs-info*} -buffer (@pxref{CVS Status Mode}). +all selected files, and show the result in a temporary buffer +@samp{*cvs-info*} (@pxref{CVS Status Mode}). @end table @@ -950,20 +945,20 @@ @cindex Resurrecting files @cindex Deleting files @cindex Putting files under CVS control -@kindex a - add a file -@kindex r - remove a file +@kindex a@r{--add a file} +@kindex r@r{--remove a file} @findex cvs-mode-add @findex cvs-mode-remove-file -The following commands are available to make it easy to add and remove -files from the CVS repository. +The following commands are available to make it easy to add fuiles to +and remove them from the CVS repository. @table @kbd @item a Add all selected files. This command can be used on @samp{Unknown} files (@pxref{Buffer contents}). The status of the file will change to -@samp{Added}, and you will have to use @kbd{c} (@samp{cvs-mode-commit}, -@pxref{Committing changes}) to really add the file to the +@samp{Added}, and you will have to use @kbd{c} (@samp{cvs-mode-commit} +@pxref{Committing changes}), to really add the file to the repository.@refill This command can also be used on @samp{Removed} files (before you commit @@ -973,10 +968,10 @@ @item r This command removes the selected files (after prompting for -confirmation). The files are @samp{rm}ed from your directory and +confirmation). The files are deleted from your directory and (unless the status was @samp{Unknown}; @pxref{Buffer contents}) they will -also be @samp{cvs remove}d. If the files were @samp{Unknown} they will -disappear from the buffer. Otherwise their status will change to +also be @samp{cvs remove}d. If the files' status was @samp{Unknown} +they will disappear from the buffer. Otherwise their status will change to @samp{Removed}, and you must use @kbd{c} (@samp{cvs-mode-commit}, @pxref{Committing changes}) to commit the removal.@refill @@ -988,7 +983,7 @@ @section Undoing changes @cindex Undo changes @cindex Flush changes -@kindex U - undo changes +@kindex U@r{--undo changes} @findex cvs-mode-undo-local-changes @table @kbd @@ -1007,8 +1002,8 @@ @cindex Getting rid of uninteresting lines @cindex Removing uninteresting (processed) lines @cindex Handled lines, removing them -@kindex x - remove processed entries -@kindex C-k - remove selected entries +@kindex x@r{--remove processed entries} +@kindex C-k@r{--remove selected entries} @findex cvs-mode-remove-handled @findex cvs-mode-acknowledge @findex cvs-mode-ignore @@ -1017,12 +1012,13 @@ @item x This command allows you to remove all entries that you have processed. More specifically, the lines for @samp{Up-to-date} files (@pxref{Buffer -contents} are removed from the buffer. If a directory becomes empty the heading -for that directory is also removed. This makes it easier to get an -overview of what needs to be done. +contents}) are removed from the buffer. If a directory becomes empty +the heading for that directory is also removed. This makes it easier to +get an overview of what needs to be done. -The command is called @code{cvs-mode-remove-handled}. If -@samp{cvs-auto-remove-handled} is set to non-@code{nil} this will +@vindex cvs-mode-remove-handled@r{ (variable)} +@kbd{x} invokes @code{cvs-mode-remove-handled}. If +@samp{cvs-auto-remove-handled} is set to non-@code{nil}, this will automatically be performed after every commit.@refill @item C-k @@ -1033,17 +1029,18 @@ @node Ignoring files, Viewing differences, Removing handled entries, Commands @section Ignoring files -@kindex i - ignoring files +@cindex Ignoring files +@kindex i@r{--ignoring files} @findex cvs-mode-ignore @table @kbd @item i Arrange so that CVS will ignore the selected files. The file names are added to the @file{.cvsignore} file in the corresponding directory. If -the @file{.cvsignore} doesn't exist it will be created. +the @file{.cvsignore} file doesn't exist, it will be created. The @file{.cvsignore} file should normally be added to the repository, -but you could ignore it also if you like it better that way. +but you could ignore it as well, if you like it better that way. This runs @code{cvs-mode-ignore}. @end table @@ -1051,18 +1048,19 @@ @node Viewing differences, Invoking Ediff, Ignoring files, Commands @section Viewing differences @cindex Diff -@cindex Invoking ediff +@cindex Invoking @code{diff} @cindex Conflicts, how to resolve them @cindex Viewing differences -@kindex d= - run @samp{cvs diff} -@kindex = - run @samp{cvs diff} -@kindex dh - diff against head of repository -@kindex dv - diff against vendor branch +@kindex d=@r{--run @samp{cvs diff}} +@kindex =@r{--run @samp{cvs diff}} +@kindex db@r{--diff against base version} +@kindex dh@r{--diff against head of repository} +@kindex dv@r{--diff against vendor branch} @findex cvs-mode-diff @findex cvs-mode-diff-backup @findex cvs-mode-diff-head @findex cvs-mode-diff-vendor -@vindex cvs-invert-ignore-marks +@vindex cvs-invert-ignore-marks@r{ (variable)} @table @kbd @item = @@ -1073,23 +1071,22 @@ @item d b If CVS finds a conflict while merging two versions of a file (during a @samp{cvs update}, @pxref{Updating the buffer}) it will save the -original file in a file called @file{.#@var{FILE}.@var{VERSION}} where -@var{FILE} is the name of the file, and @var{VERSION} is the revision -number that your file was based on.@refill +original file in a file called @file{.#@var{file}.@var{version}} where +@var{file} is the name of the file, and @var{version} is the revision +number that @var{file} was based on.@refill -With the @kbd{b} command you can run a @samp{diff} on the files -@file{.#@var{FILE}.@var{VERSION}} and @file{@var{FILE}}.@refill +With the @kbd{d b} command you can run a @samp{diff} on the files +@file{.#@var{file}.@var{version}} and @file{@var{file}}.@refill @item d h Display a @samp{cvs diff} between the selected files and the head revision in the repository (the most recent version on the current -branch). (@code{cvs-mode-diff-head}).@refill +branch) (@code{cvs-mode-diff-head}).@refill @item d v Display a @samp{cvs diff} between the selected files and the head revision of the vendor branch in the repository. (@code{cvs-mode-diff-vendor}).@refill - @end table By default, @samp{diff} commands ignore the marks. This can be changed @@ -1100,37 +1097,38 @@ @cindex Ediff @cindex Invoking ediff @cindex Viewing differences -@cindex Conflicts, resolving +@cindex Conflicts, how to resolve them @cindex Resolving conflicts -@kindex e - invoke @samp{ediff} +@kindex e@r{--invoke @samp{ediff}} @findex cvs-mode-idiff @findex cvs-mode-imerge @table @kbd +@vindex cvs-idiff-imerge-handlers@r{ (variable)} @item d e -This command uses ediff (or emerge depending on +This uses @code{ediff} (or @code{emerge}, depending on @samp{cvs-idiff-imerge-handlers}) to allow you to view diffs. If a prefix argument is given, PCL-CVS will prompt for a revision against which the diff should be made, else the default will be to use the BASE revision. +@cindex Merging with @code{ediff} and @code{emerge} @item d E -This command use ediff (or emerge, see above) to allow you to do an -interactive 3-way merge. +This command use @code{ediff} (or @code{emerge}, see above) to allow you +to do an interactive 3-way merge. @strong{Note:} When the file status is @samp{Conflict}, CVS has already performed a merge. The resulting file is not used in any way if you use this command. If you use the @kbd{q} command inside @samp{ediff} (to successfully terminate a merge) the file that CVS created will be overwritten.@refill - @end table @node Updating files, Tagging files, Invoking Ediff, Commands @section Updating files @findex cvs-mode-update @cindex Updating files -@kindex O - update files +@kindex O@r{--update files} @table @kbd @item O @@ -1145,24 +1143,23 @@ @findex cvs-mode-untag @findex cvs-rtag @cindex Tagging files -@kindex M-t - repository tag files -@kindex t - tag files -@vindex cvs-invert-ignore-marks -@vindex cvs-force-dir-tag +@kindex M-t@r{--repository tag files} +@kindex t@r{--tag files} +@vindex cvs-invert-ignore-marks@r{ (variable)} +@vindex cvs-force-dir-tag@r{ (variable)} @table @kbd @item t Tag all selected files by running @samp{cvs tag} on -them. (@code{cvs-mode-tag}). It's usually preferable to tag directories +them (@code{cvs-mode-tag}). It's usually preferable to tag a directory at a time. Rather than selecting all files (which too often doesn't select all files but only the few that are displayed), clear the selection with @kbd{M-DEL} (@code{cvs-mode-unmark-all-files}), position the cursor on the directory you want to tag and hit @kbd{t}. - @end table By default, @samp{tag} commands ignore the marks. This can be changed -with @code{cvs-invert-ignore-marks}. Also by default @samp{tag} can +with @code{cvs-invert-ignore-marks}. Also, by default @samp{tag} can only be applied to directories, see @code{cvs-force-dir-tag} if you want to change this behavior. @@ -1175,38 +1172,37 @@ @findex cvs-mode-delete-lock @cindex Getting rid of lock files @cindex Lock files -@kindex q - quit PCL-CVS +@kindex q@r{--quit PCL-CVS} @findex cvs-mode-quit @cindex Quitting -@kindex h - help -@kindex ? - help +@kindex h@r{--help} +@kindex ?@r{--help} @findex cvs-help @cindex Help @table @kbd @item M-x cvs-mode-byte-compile-files -Byte compile all selected files that end in .el. +Byte compile all selected files that end in @file{.el}. @item M-x cvs-mode-delete-lock This command deletes the lock files that -the *cvs* buffer informs you about. You should normally never have to -use this command since CVS tries very carefully to always remove the +the @samp{*cvs*} buffer informs you about. You should normally never have to +use this command, since CVS tries very carefully to always remove the lock files itself. -You can only use this command when a message in the *cvs* buffer tells +You can only use this command when a message in the @samp{*cvs*} buffer tells you so. You should wait a while before using this command in case -someone else is running a cvs command. +someone else is running a @code{cvs} command. Also note that this only works if the repository is local. @item ? @itemx h Show a summary of common command key bindings in the echo -area. (@code{cvs-help}). +area (@code{cvs-help}). @item q -Quit PCL-CVS, killing the @samp{*cvs*} buffer. (@code{cvs-mode-quit}). - +Quit PCL-CVS, killing the @samp{*cvs*} buffer (@code{cvs-mode-quit}). @end table @node Log Edit Mode, Log View Mode, Commands, Top @@ -1220,38 +1216,39 @@ @node Customization, Bugs, CVS Status Mode, Top @chapter Customization -@vindex log-edit-changelog-full-paragraphs (variable) -@vindex cvs-auto-remove-handled (variable) -@vindex cvs-auto-remove-directories (variable) -@vindex cvs-update-prog-output-skip-regexp (variable) -@vindex cvs-cvsroot (variable) -@vindex cvs-auto-revert (variable) -@vindex log-edit-require-final-newline (variable) -@vindex cvs-sort-ignore-file (variable) +@vindex log-edit-changelog-full-paragraphs@r{ (variable)} +@vindex cvs-auto-remove-handled@r{ (variable)} +@vindex cvs-auto-remove-directories@r{ (variable)} +@vindex cvs-update-prog-output-skip-regexp@r{ (variable)} +@vindex cvs-cvsroot@r{ (variable)} +@vindex cvs-auto-revert@r{ (variable)} +@vindex log-edit-require-final-newline@r{ (variable)} +@vindex cvs-sort-ignore-file@r{ (variable)} @cindex Customization @cindex Variables, list of all -@cindex Erasing the input buffer +@cindex Erasing input buffer @cindex Context diff, how to get @cindex Unidiff, how to get @cindex Automatically remove handled files -@cindex -u option in modules file -@cindex Modules file (-u option) -@cindex Update program (-u option in modules file) +@cindex @samp{-u} option in modules file +@cindex Modules file (@samp{-u} option) +@cindex Update program (@samp{-u} option in modules file) @cindex Reverting buffers after commit @cindex Require final newline @cindex Automatically inserting newline @cindex Commit message, inserting newline -@cindex Sorting the .cvsignore file -@cindex .cvsignore file, sorting -@cindex Automatically sorting .cvsignore +@cindex Sorting @file{.cvsignore} file +@cindex @file{.cvsignore} file, sorting +@cindex Automatically sorting @file{.cvsignore} +@cindex @samp{CVSROOT}, overriding If you have an idea about any customization that would be handy but isn't present in this list, please tell me! -For info on how to reach me, see @xref{Bugs}.@refill +For info on how to reach me, see @ref{Bugs}.@refill @table @samp @item cvs-auto-remove-handled -If this variable is set to any non-@code{nil} value +If this variable is set to any non-@code{nil} value, @samp{cvs-mode-remove-handled} will be called every time you check in files, after the check-in is ready. @xref{Removing handled entries}.@refill @@ -1268,56 +1265,59 @@ @item cvs-update-prog-output-skip-regexp The @samp{-u} flag in the @file{modules} file can be used to run a command -whenever a @samp{cvs update} is performed (see cvs(5)). This regexp +whenever a @samp{cvs update} is performed (see @code{cvs(5)}). This regexp is used to search for the last line in that output. It is normally set -to @samp{"$"}. That setting is only correct if the command outputs +to @samp{$}. That setting is only correct if the command outputs nothing. Note that PCL-CVS will get very confused if the command -outputs @emph{anything} to @samp{stderr}. +outputs @emph{anything} to @code{stderr}. @item cvs-cvsroot This variable can be set to override @samp{CVSROOT}. It should be a -string. If it is set then every time a cvs command is run it will be -called as @samp{cvs -d @var{cvs-cvsroot}@dots{}} This can be useful if -your site has several repositories. +string. If it is set, then every time a @code{cvs} command is run, it +will be called as @samp{cvs -d @var{cvs-cvsroot}@dots{}}. This can be +useful if your site has several repositories. @item log-edit-require-final-newline -When you enter a log message in the @samp{*cvs-commit-message*} buffer -PCL-CVS will normally automatically insert a trailing newline, unless -there already is one. This behavior can be controlled via -@samp{cvs-commit-buffer-require-final-newline}. If it is @samp{t} (the -default behavior), a newline will always be appended. If it is -@samp{nil}, newlines will never be appended. Any other value causes -PCL-CVS to ask the user whenever there is no trailing newline in the -commit message buffer. +@c wordy to avoid unhderfull 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 +can be controlled via @samp{cvs-commit-buffer-require-final-newline}. +If it is @samp{t} (the default behavior), a newline will always be +appended. If it is @samp{nil}, newlines will never be appended. Any +other value causes PCL-CVS to ask the user whenever there is no trailing +newline in the commit message buffer. +@findex cvs-mode-changelog-commit @item log-edit-changelog-full-paragraphs -If this variable is non-@code{nil}, include full ChangeLog paragraphs in -the CVS log created by @samp{cvs-mode-changelog-commit}. -This may be set in the local variables section of a ChangeLog, to -indicate the policy for that ChangeLog. +If this variable is non-@code{nil}, include full @file{ChangeLog} +paragraphs in the CVS log created by @samp{cvs-mode-changelog-commit}. +This may be set in the local variables section of a @file{ChangeLog} +file, to indicate the policy for that @file{ChangeLog}. -A ChangeLog paragraph is a bunch of log text containing no blank lines; -a paragraph usually describes a set of changes with a single purpose, -but perhaps spanning several functions in several files. Changes in -different paragraphs are unrelated. +@cindex @file{ChangeLog} paragraphs +A @dfn{@file{ChangeLog} paragraph} is a bunch of log text containing no +blank lines; a paragraph usually describes a set of changes with a +single purpose, but perhaps spanning several functions in several files. +Changes in different paragraphs are unrelated. You could argue that the CVS log entry for a file should contain the -full ChangeLog paragraph mentioning the change to the file, even though +full @file{ChangeLog} paragraph mentioning the change to the file, even though it may mention other files, because that gives you the full context you need to understand the change. This is the behavior you get when this -variable is set to t, the default. +variable is set to @code{t}, the default. On the other hand, you could argue that the CVS log entry for a change should contain only the text for the changes which occurred in that file, because the CVS log is per-file. This is the behavior you get -when this variable is set to nil. +when this variable is set to @code{nil}. +@findex cvs-mode-ignore@r{, and @file{.cvsignore} sorting} @item cvs-sort-ignore-file -If this variable is set to any non-@samp{nil} value the -@file{.cvsignore} will always be sorted whenever you use +If this variable is set to any non-@samp{nil} value, the +@file{.cvsignore} file will always be sorted whenever you use @samp{cvs-mode-ignore} to add a file to it. This option is on by default. - @end table @@ -1334,32 +1334,29 @@ @vindex cvs-need-action-face (face) @vindex cvs-marked-face (face) -The Emacs lisp file @file{pcl-cvs-xemacs.el} included with PCL-CVS adds -a few extra features for XEmacs, including menus, mouse bindings, and +PCL-CVS adds a few extra features, including menus, mouse bindings, and fontification the the @samp{*cvs*} buffer. The faces defined for fontification are listed below: @table @samp - @item cvs-header-face -This face is used to highlight directory changes. +used to highlight directory changes. @item cvs-filename-face -This face is used to highlight file names. +used to highlight file names. @item cvs-unknown-face -This face is used to highlight the status of files which are UNKNOWN. +used to highlight the status of files which are @samp{Unknown}. @item cvs-handled-face -This face is used to highlight the status of files which are handled and +used to highlight the status of files which are handled and need no further action. @item cvs-need-action-face -This face is used to highlight the status of files which still need action. +used to highlight the status of files which still need action. @item cvs-marked-face -This face is used to highlight the marked file indicator (@samp{*}). - +used to highlight the marked file indicator (@samp{*}). @end table @@ -1375,17 +1372,17 @@ @cindex Problems, list of common If you find a bug or misfeature, don't hesitate to tell us! Send email -to @samp{bugs-gnu-emacs@@gnu.org} which gatewayed to the newsgroup +to @email{bug-gnu-emacs@@gnu.org} which is gatewayed to the newsgroup @samp{gnu.emacs.bugs}. Feature requests should also be sent there. We prefer discussing one thing at a time. If you find several unrelated bugs, please report them separately. If you are running PCL-CVS under XEmacs, you should also send a copy of bug reports to -@samp{xemacs-beta@@xemacs.org}. +@email{xemacs-beta@@xemacs.org}. -If you have problems using PCL-CVS or other questions, -@samp{help-gnu-emacs@@gnu.org} also gatewayed to @samp{gnu.emacs.help} -is a good place to get help as well as @samp{cvs-info@@gnu.org} -yet again gatewayed to @samp{gnu.cvs.help}. +If you have problems using PCL-CVS or other questions, send them to +@email{help-gnu-emacs@@gnu.org}, which is gatewayed to the +@samp{gnu.emacs.help} newsgroup. This is a good place to get help, as +is @email{cvs-info@@gnu.org}, gatewayed to @samp{gnu.cvs.help}. If you have ideas for improvements, or if you have written some extensions to this package, we would like to hear from you. We hope that @@ -1397,27 +1394,34 @@ @table @asis @item Unexpected output from CVS Unexpected output from CVS may confuse PCL-CVS. It will create -warning messages in the *cvs* buffer alerting you to any parse errors. +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 *cvs* buffer, the -output of the CVS process (which should be found in the *cvs-tmp* Emacs +addresses listed above. Include the contents of the @samp{*cvs*} buffer, the +output of the CVS process (which should be found in the @samp{*cvs-tmp*} buffer), and the versions of Emacs, PCL-CVS and CVS you are using. - @end table @node Function and Variable Index, Concept Index, Bugs, Top @unnumbered Function and Variable Index +This is an index of all the functions and variables documented in this +manual. + @printindex fn @node Concept Index, Key Index, Function and Variable Index, Top @unnumbered Concept Index +This is an index of concepts discussed in this manual. + @printindex cp @node Key Index, , Concept Index, Top @unnumbered Key Index +This index includes an entry for each PCL-CVS key sequence documented in +this manual. + @printindex ky @setchapternewpage odd