]> code.delx.au - gnu-emacs/blobdiff - man/pcl-cvs.texi
*** empty log message ***
[gnu-emacs] / man / pcl-cvs.texi
index 7c8f022371f658b5b283c4dac162aa5b1366a12d..c6457237842e32af8e8cfd99dc80a06d158e941a 100644 (file)
@@ -1,40 +1,16 @@
 \input texinfo  @c -*-texinfo-*-
-
-@c "@(#)$Name:  $:$Id: pcl-cvs.texi,v 1.8 2000/12/04 16:17:49 eliz Exp $"
-
-@c Documentation for the GNU Emacs CVS mode.
-@c Copyright (C) 1991,92,93,94,95,96,97,98,99,2000  Free Software Foundation, Inc.
-
-@c This file is part of GNU Emacs
-
-@c GNU Emacs is free software; you can redistribute it and/or modify
-@c it under the terms of the GNU General Public License as published by
-@c the Free Software Foundation; either version 2 of the License,
-@c or (at your option) any later version.
-
-@c GNU Emacs is distributed in the hope that it will be useful,
-@c but WITHOUT ANY WARRANTY; without even the implied warranty of
-@c MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-@c GNU General Public License for more details.
-
-@c You should have received a copy of the GNU General Public License
-@c along with pcl-cvs; see the file COPYING.  If not, write to
-@c the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
-
+@c "@(#)$Name:  $:$Id: pcl-cvs.texi,v 1.17 2002/10/02 23:24:31 karl Exp $"
 @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
 
-@dircategory Emacs
-@direntry
-* PCL-CVS: (pcl-cvs).  Emacs front-end to CVS.
-@end direntry
-@setchapternewpage on
-     
-@ifinfo
-Copyright @copyright{} 1991,92,93,94,95,96,97,98,99,2000  Free Software Foundation, Inc.
+@copying
+Copyright @copyright{} 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
+1999, 2000, 2002 Free Software Foundation, Inc.
 
+@quotation
 Permission is granted to copy, distribute and/or modify this document
 under the terms of the GNU Free Documentation License, Version 1.1 or
 any later version published by the Free Software Foundation; with the
@@ -52,9 +28,14 @@ license to the document, as described in section 6 of the license.
 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
 this GNU Manual, like GNU software.  Copies published by the Free
 Software Foundation raise funds for GNU development.''
-@end ifinfo
+@end quotation
+@end copying
+
+@dircategory Emacs
+@direntry
+* PCL-CVS: (pcl-cvs).  Emacs front-end to CVS.
+@end direntry
 
-@syncodeindex vr fn
 @c The titlepage section does not appear in the Info file.
 @titlepage
 @sp 4
@@ -78,25 +59,7 @@ Software Foundation raise funds for GNU development.''
 @c  for the printed manual.  This will not appear in the Info file.
 @page
 @vskip 0pt plus 1filll
-Copyright @copyright{} 1991,92,93,94,95,96,97,98,99,2000  Free Software Foundation, Inc.
-
-Permission is granted to copy, distribute and/or modify this document
-under the terms of the GNU Free Documentation License, Version 1.1 or
-any later version published by the Free Software Foundation; with the
-Invariant Sections being ``The GNU Manifesto'', ``Distribution'' and
-``GNU GENERAL PUBLIC LICENSE'', with the Front-Cover texts being ``A GNU
-Manual'', and with the Back-Cover Texts as in (a) below.  A copy of the
-license is included in the section entitled ``GNU Free Documentation
-License'' in the Emacs manual.
-
-This document is part of a collection distributed under the GNU Free
-Documentation License.  If you want to distribute this document
-separately from the collection, you can do so by adding a copy of the
-license to the document, as described in section 6 of the license.
-
-(a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
-this GNU Manual, like GNU software.  Copies published by the Free
-Software Foundation raise funds for GNU development.''
+@insertcopying
 @end titlepage
 
 @c ================================================================
@@ -104,7 +67,7 @@ Software Foundation raise funds for GNU development.''
 @c ================================================================
 
 @node Top, About PCL-CVS, (dir), (dir)
-@ifinfo
+@ifnottex
 @top PCL-CVS
 
 This manual describes PCL-CVS, the GNU Emacs front-end to CVS.  It
@@ -112,7 +75,7 @@ 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.
-@end ifinfo
+@end ifnottex
 
 @menu
 * About PCL-CVS::               Installation, credits, history, @dots{}
@@ -124,7 +87,7 @@ of the various commands and major modes for further information.
 
 * Log Edit Mode::               Major mode to edit log messages.
 * Log View Mode::               Major mode to browse log changes.
-* CVS Status Mode::             Major mode to view CVS' status output.
+@c * CVS Status Mode::             Major mode to view CVS' status output.
 * Customization::               How you can tailor PCL-CVS to suit your needs.
 * Bugs::                        Bugs (known and unknown).
 
@@ -233,7 +196,7 @@ on both the functionality and the documentation.@refill
 @file{pcl-cvs-xemacs.el}.@refill
 
 @item
-Leif Lonnblad contributed RCVS support (since superceded by the new
+Leif Lonnblad contributed RCVS support (since superseded by the new
 remote CVS support).
 
 @item
@@ -655,8 +618,8 @@ unless temporary flags are set which override them.
 
 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 @key{RET}}, enter the
-description, and the file will be added.  Subsequent @samp{cvs add}
+to @samp{cvs add}.  You can type @kbd{C-u a -kb @key{RET}},
+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
@@ -777,6 +740,7 @@ This key moves one file backward, towards the beginning of the buffer
 @kindex ESC DEL@r{--unmark all files}
 @kindex DEL@r{--unmark previous file}
 @kindex %@r{--mark files matching regexp}
+@kindex S@r{--mark files in a particular state}
 @kindex T@r{--toggle marks}
 @findex cvs-mode-mark
 @findex cvs-mode-unmark
@@ -784,6 +748,7 @@ This key moves one file backward, towards the beginning of the buffer
 @findex cvs-mode-unmark-all-files
 @findex cvs-mode-unmark-up
 @findex cvs-mode-mark-matching-files
+@findex cvs-mode-mark-on-state
 @findex cvs-mode-toggle-marks
 
 PCL-CVS works on a set of @dfn{selected files} (@pxref{Selected files}).
@@ -810,11 +775,15 @@ Unmark @emph{all} files (@code{cvs-mode-unmark-all-files}).
 Unmark the file on the previous line, and move point to that line
 (@code{cvs-mode-unmark-up}).
 
-@item @key{%}
+@item %
 Mark all files matching a regular expression
 (@code{cvs-mode-mark-matching-files}).
 
-@item @key{T}
+@item S
+Mark all files in a particular state, such as ``Modified'' or
+``Removed''.  (@code{cvs-mode-mark-on-state}).
+
+@item T
 Toggle use of marks for the next command (@code{cvs-mode-toggle-marks}).
 @end table
 
@@ -842,7 +811,7 @@ After having selected the files you want to commit, you type either
 
 @item
 You type in the log message describing the changes you're about to
-commit (@pxref{Log Edit Mode}).@refill
+commit (@pxref{Log Edit Mode}).
 
 @item
 When you're happy with it, you type @kbd{C-c C-c} to do the actual
@@ -934,7 +903,9 @@ selected files, and show the result in a temporary buffer
 @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 buffer
-@samp{*cvs-info*} (@pxref{CVS Status Mode}).
+@samp{*cvs-info*}.
+@c Fixme: reinstate when node is written:
+@c (@pxref{CVS Status Mode}).
 @end table
 
 
@@ -950,7 +921,7 @@ all selected files, and show the result in a temporary buffer
 @findex cvs-mode-add
 @findex cvs-mode-remove-file
 
-The following commands are available to make it easy to add fuiles to
+The following commands are available to make it easy to add files to
 and remove them from the CVS repository.
 
 @table @kbd
@@ -1208,13 +1179,58 @@ Quit PCL-CVS, killing the @samp{*cvs*} buffer (@code{cvs-mode-quit}).
 @node Log Edit Mode, Log View Mode, Commands, Top
 @chapter Editing a Log Message
 
-@node Log View Mode, CVS Status Mode, Log Edit Mode, Top
+@cindex Log Edit mode
+@cindex mode, Log Edit
+Buffers for entering/editing log messages for changes which are about
+to be committed are put into Log Edit mode.
+
+Sometimes the log buffer contains default text when you enter it,
+typically the last log message entered.  If it does, mark and point
+are set around the entire contents of the buffer so that it is easy to
+kill the contents of the buffer with @kbd{C-w}.
+
+@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
+control, you can generate the Log Edit text from the ChangeLog using
+@kbd{C-a 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
+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})
+shows the list of files to be committed in case you need to check
+that.
+
+When you have finished editing the log message, type @kbd{C-c C-c} to
+exit the buffer and commit the change.
+
+@c Fixme: customization variables
+
+@node Log View Mode, Customization, Log Edit Mode, Top
 @chapter Browsing a Log of Changes
 
-@node CVS Status Mode, Customization, Log View Mode, Top
-@chapter Viewing CVS' Status output
+@cindex Log View mode
+@cindex mode, Log View
+@cindex output, logs
+
+@findex cvs-mode-log
+@findex vc-print-log
+Log View mode provides a few useful commands for navigating revision
+control log output.  It is used for the output buffers of both
+@code{cvs-mode-log} and @code{vc-print-log}.
+
+In this mode, @kbd{n} goes to the next message and @kbd{p} goes to the
+previous message and @kbd{N} and @kbd{P} go to the next and previous
+files, respectively, in multi-file output.  With a numeric prefix
+argument, these commands move that many messages of files.
+
+@c @node CVS Status Mode
+@c @chapter Viewing CVS' Status output
 
-@node Customization, Bugs, CVS Status Mode, Top
+@node Customization, Bugs, Log View Mode, Top
 @chapter Customization
 @vindex log-edit-changelog-full-paragraphs@r{ (variable)}
 @vindex cvs-auto-remove-handled@r{ (variable)}
@@ -1335,7 +1351,7 @@ default.
 @vindex cvs-marked-face (face)
 
 PCL-CVS adds a few extra features, including menus, mouse bindings, and
-fontification the the @samp{*cvs*} buffer.  The faces defined for
+fontification the @samp{*cvs*} buffer.  The faces defined for
 fontification are listed below:
 
 @table @samp
@@ -1388,8 +1404,7 @@ 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
 you find this package useful!
 
-Below is a partial list of currently known problems with PCL-CVS version
-2.0.
+Below is a partial list of currently known problems with PCL-CVS.
 
 @table @asis
 @item Unexpected output from CVS
@@ -1397,7 +1412,7 @@ 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
-output of the CVS process (which should be found in the @samp{*cvs-tmp*}
+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