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