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