diff options
| author | Eli Zaretskii | 2000-12-04 16:17:49 +0000 |
|---|---|---|
| committer | Eli Zaretskii | 2000-12-04 16:17:49 +0000 |
| commit | 11dac025431b2e87d070ecb79e4226016eabb898 (patch) | |
| tree | 9ec190f5767c544d2a7142b4317153842c0fa91b | |
| parent | 00c804d5e6f5abdfa2d8d024d923e5263554717d (diff) | |
| download | emacs-11dac025431b2e87d070ecb79e4226016eabb898.tar.gz emacs-11dac025431b2e87d070ecb79e4226016eabb898.zip | |
Fix markup, add index entries, make the DVI output prettier.
| -rw-r--r-- | man/pcl-cvs.texi | 530 |
1 files changed, 267 insertions, 263 deletions
diff --git a/man/pcl-cvs.texi b/man/pcl-cvs.texi index afb0e171f9d..51a4a2a3b61 100644 --- a/man/pcl-cvs.texi +++ b/man/pcl-cvs.texi | |||
| @@ -1,6 +1,6 @@ | |||
| 1 | \input texinfo @c -*-texinfo-*- | 1 | \input texinfo @c -*-texinfo-*- |
| 2 | 2 | ||
| 3 | @c "@(#)$Name: $:$Id: pcl-cvs.texi,v 1.6 2000/10/07 19:15:54 eliz Exp $" | 3 | @c "@(#)$Name: $:$Id: pcl-cvs.texi,v 1.7 2000/11/21 11:39:43 fx Exp $" |
| 4 | 4 | ||
| 5 | @c Documentation for the GNU Emacs CVS mode. | 5 | @c Documentation for the GNU Emacs CVS mode. |
| 6 | @c Copyright (C) 1991-2000 Free Software Foundation, Inc. | 6 | @c Copyright (C) 1991-2000 Free Software Foundation, Inc. |
| @@ -23,7 +23,7 @@ | |||
| 23 | 23 | ||
| 24 | @c %**start of header | 24 | @c %**start of header |
| 25 | @setfilename ../info/pcl-cvs | 25 | @setfilename ../info/pcl-cvs |
| 26 | @settitle PCL-CVS - Emacs Front-End to CVS | 26 | @settitle PCL-CVS--Emacs Front-End to CVS |
| 27 | @c %**end of header | 27 | @c %**end of header |
| 28 | 28 | ||
| 29 | @dircategory Emacs | 29 | @dircategory Emacs |
| @@ -54,7 +54,7 @@ this GNU Manual, like GNU software. Copies published by the Free | |||
| 54 | Software Foundation raise funds for GNU development.'' | 54 | Software Foundation raise funds for GNU development.'' |
| 55 | @end ifinfo | 55 | @end ifinfo |
| 56 | 56 | ||
| 57 | @synindex vr fn | 57 | @syncodeindex vr fn |
| 58 | @c The titlepage section does not appear in the Info file. | 58 | @c The titlepage section does not appear in the Info file. |
| 59 | @titlepage | 59 | @titlepage |
| 60 | @sp 4 | 60 | @sp 4 |
| @@ -107,15 +107,15 @@ Software Foundation raise funds for GNU development.'' | |||
| 107 | @ifinfo | 107 | @ifinfo |
| 108 | @top PCL-CVS | 108 | @top PCL-CVS |
| 109 | 109 | ||
| 110 | This info manual describes PCL-CVS, the GNU Emacs front-end to CVS. It | 110 | This manual describes PCL-CVS, the GNU Emacs front-end to CVS. It |
| 111 | is nowhere near complete, so you are advised to use @kbd{M-x | 111 | is nowhere near complete, so you are advised to use @kbd{M-x |
| 112 | customize-group RET pcl-cvs RET} and to look at the documentation strings | 112 | customize-group RET pcl-cvs @key{RET}} and to look at the documentation strings |
| 113 | of the various commands and major modes for further information. | 113 | of the various commands and major modes for further information. |
| 114 | @c This manual is updated to release 2.5 of PCL-CVS. | 114 | @c This manual is updated to release 2.5 of PCL-CVS. |
| 115 | @end ifinfo | 115 | @end ifinfo |
| 116 | 116 | ||
| 117 | @menu | 117 | @menu |
| 118 | * About PCL-CVS:: Installation, credits, history, ... | 118 | * About PCL-CVS:: Installation, credits, history, @dots{} |
| 119 | 119 | ||
| 120 | * Getting started:: An introduction with a walk-through example. | 120 | * Getting started:: An introduction with a walk-through example. |
| 121 | * Buffer contents:: An explanation of the buffer contents. | 121 | * Buffer contents:: An explanation of the buffer contents. |
| @@ -178,18 +178,19 @@ 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 | 178 | Emacs buffer and provides single-key access to the most frequently used CVS |
| 179 | commands. | 179 | commands. |
| 180 | For Emacs users accustomed to VC, PCL-CVS can be thought of as a replacement | 180 | For Emacs users accustomed to VC, PCL-CVS can be thought of as a replacement |
| 181 | for VC-dired (@pxref{(emacs)VC Dired Mode}) specifically designed for CVS. | 181 | for VC-dired (@pxref{VC Dired Mode, , Dired under VC, emacs, The GNU |
| 182 | Emacs Manual}) specifically designed for CVS. | ||
| 182 | 183 | ||
| 183 | PCL-CVS was originally written many years ago by Per Cederqvist who | 184 | PCL-CVS was originally written many years ago by Per Cederqvist who |
| 184 | proudly maintained it until January 1996, at which point he released the | 185 | proudly maintained it until January 1996, at which point he released the |
| 185 | beta version 2.0b2 and passed on the maintainership to Greg A Woods. | 186 | beta version 2.0b2 and passed on the maintainership to Greg A Woods. |
| 186 | Development stayed mostly dormant for a few years during which the | 187 | Development stayed mostly dormant for a few years during which |
| 187 | version 2.0 never seemed to be able to leave the ``beta'' stage while a | 188 | version 2.0 never seemed to be able to leave the ``beta'' stage while a |
| 188 | separate XEmacs version was slowly splitting away. In late 1998, | 189 | separate XEmacs version was slowly splitting away. In late 1998, |
| 189 | Stefan Monnier picked up development again, adding some major new | 190 | Stefan Monnier picked up development again, adding some major new |
| 190 | functionality and taking over maintenance. | 191 | functionality and taking over the maintenance. |
| 191 | 192 | ||
| 192 | As of Emacs-21, PCL-CVS is part of the standard Emacs distribution. | 193 | As of Emacs 21, PCL-CVS is part of the standard Emacs distribution. |
| 193 | 194 | ||
| 194 | @menu | 195 | @menu |
| 195 | * Contributors:: Contributors to PCL-CVS. | 196 | * Contributors:: Contributors to PCL-CVS. |
| @@ -214,58 +215,58 @@ Without his work on CVS this package would be useless@dots{} | |||
| 214 | 215 | ||
| 215 | @item | 216 | @item |
| 216 | Per Cederqvist wrote most of the otherwise unattributed functions in | 217 | Per Cederqvist wrote most of the otherwise unattributed functions in |
| 217 | PCL-CVS as well as all documentation. | 218 | PCL-CVS as well as all the documentation. |
| 218 | 219 | ||
| 219 | @item | 220 | @item |
| 220 | Inge Wallin (@samp{inge@@lysator.liu.se}) wrote the skeleton to | 221 | @email{inge@@lysator.liu.se, Inge Wallin} wrote the skeleton of |
| 221 | @file{pcl-cvs.texi}, and gave useful comments on it. He also wrote | 222 | @file{pcl-cvs.texi}, and gave useful comments on it. He also wrote |
| 222 | the files @file{elib-node.el} and @file{compile-all.el}. The file | 223 | the files @file{elib-node.el} and @file{compile-all.el}. The file |
| 223 | @file{cookie.el} was inspired by Inge.@refill | 224 | @file{cookie.el} was inspired by Inge.@refill |
| 224 | 225 | ||
| 225 | @item | 226 | @item |
| 226 | Linus Tolke (@samp{linus@@lysator.liu.se}) contributed useful comments | 227 | @email{linus@@lysator.liu.se, Linus Tolke} contributed useful comments |
| 227 | on both the functionality and the documentation.@refill | 228 | on both the functionality and the documentation.@refill |
| 228 | 229 | ||
| 229 | @item | 230 | @item |
| 230 | Jamie Zawinski (@samp{jwz@@jwz.com}) contributed | 231 | @email{jwz@@jwz.com, Jamie Zawinski} contributed |
| 231 | @file{pcl-cvs-lucid.el}, which was later renamed to | 232 | @file{pcl-cvs-lucid.el}, which was later renamed to |
| 232 | @file{pcl-cvs-xemacs.el}.@refill | 233 | @file{pcl-cvs-xemacs.el}.@refill |
| 233 | 234 | ||
| 234 | @item | 235 | @item |
| 235 | Leif Lonnblad contributed RCVS support. (Since superceded by the new | 236 | Leif Lonnblad contributed RCVS support (since superceded by the new |
| 236 | remote CVS support.) | 237 | remote CVS support). |
| 237 | 238 | ||
| 238 | @item | 239 | @item |
| 239 | Jim Blandy (@samp{jimb@@cyclic.com}) contributed hooks to automatically | 240 | @email{jimb@@cyclic.com, Jim Blandy} contributed hooks to automatically |
| 240 | guess CVS log entries from ChangeLog contents; and initial support of | 241 | guess CVS log entries from @file{ChangeLog} contents, and initial support of |
| 241 | the new Cygnus / Cyclic remote CVS; as well as various sundry bug fixes | 242 | the new Cygnus / Cyclic remote CVS, as well as various sundry bug fixes |
| 242 | and cleanups. | 243 | and cleanups. |
| 243 | 244 | ||
| 244 | @item | 245 | @item |
| 245 | Jim Kingdon (@samp{kingdon@@cyclic.com}) contributed lots of fixes to | 246 | @email{kingdon@@cyclic.com, Jim Kingdon} contributed lots of fixes to |
| 246 | the build and install procedure. | 247 | the build and installation procedure. |
| 247 | 248 | ||
| 248 | @item | 249 | @item |
| 249 | Greg A. Woods (@samp{woods@@weird.com}) contributed code to implement | 250 | @email{woods@@weird.com, Greg A.@: Woods} contributed code to implement |
| 250 | the use of per-file diff buffers; and vendor join diffs with emerge and | 251 | the use of per-file diff buffers, and vendor join diffs with emerge and |
| 251 | ediff; as well as various and sundry bug fixes and cleanups. | 252 | ediff, as well as various and sundry bug fixes and cleanups. |
| 252 | 253 | ||
| 253 | @item | 254 | @item |
| 254 | Greg Klanderman (@samp{greg.klanderman@@alum.mit.edu}) implemented | 255 | @email{greg.klanderman@@alum.mit.edu, Greg Klanderman} implemented |
| 255 | toggling of marked files; setting of CVS command flags via prefix | 256 | toggling of marked files, setting of CVS command flags via prefix |
| 256 | arguments; updated the XEmacs support; updated the manual; and fixed | 257 | arguments, updated the XEmacs support, updated the manual, and fixed |
| 257 | numerous bugs. | 258 | numerous bugs. |
| 258 | 259 | ||
| 259 | @item | 260 | @item |
| 260 | Stefan Monnier (@samp{monnier@@cs.yale.edu}) added a slew of other | 261 | @email{monnier@@cs.yale.edu, Stefan Monnier} added a slew of other |
| 261 | features and introduced even more new bugs. If there's any bug left, | 262 | features and introduced even more new bugs. If there's any bug left, |
| 262 | you can be sure it's his. | 263 | you can be sure it's his. |
| 263 | 264 | ||
| 264 | @item | 265 | @item |
| 265 | Masatake YAMATO (@samp{masata-y@@is.aist-nara.ac.jp}) graciously | 266 | @c wordy to avoid an underfull hbox |
| 266 | contributed the cvstree code to display a tree of tags which was later | 267 | @email{masata-y@@is.aist-nara.ac.jp, Masatake YAMATO} made a gracious |
| 267 | superseded by the new cvs-status-mode. | 268 | contribution of his cvstree code to display a tree of tags which was later |
| 268 | 269 | superseded by the new @code{cvs-status-mode}. | |
| 269 | @end itemize | 270 | @end itemize |
| 270 | 271 | ||
| 271 | Apart from these, a lot of people have sent us suggestions, ideas, | 272 | Apart from these, a lot of people have sent us suggestions, ideas, |
| @@ -277,27 +278,30 @@ there would be no new releases of PCL-CVS. | |||
| 277 | @section Installation | 278 | @section Installation |
| 278 | @cindex Installation | 279 | @cindex Installation |
| 279 | 280 | ||
| 280 | As mentioned above, PCL-CVS comes preinstalled since Emacs-21. | 281 | As mentioned above, PCL-CVS comes bundled with Emacs version 21.1 and |
| 281 | If you're using Emacs 20, you can download an older version of PCL-CVS | 282 | later. If you're using Emacs 20, you can download an older version of |
| 282 | from @url{ftp://flint.cs.yale.edu/pub/monnier/pcl-cvs}. That version | 283 | PCL-CVS from @uref{ftp://flint.cs.yale.edu/pub/monnier/pcl-cvs}. That |
| 283 | also works on XEmacs. | 284 | version also works on XEmacs. |
| 284 | 285 | ||
| 285 | If you are running XEmacs 21.0 or later, PCL-CVS is available in | 286 | If you are running XEmacs 21.0 or later, PCL-CVS is available in |
| 286 | pre-compiled package form. Please refer to the XEmacs manual for | 287 | pre-compiled package form. Please refer to the XEmacs manual for |
| 287 | instructions regarding package selection and installation. Currently, | 288 | instructions regarding package selection and installation. Currently, |
| 288 | that PCL-CVS package also requires you to have installed the xemacs-base, | 289 | that PCL-CVS package also requires you to have installed the |
| 289 | elib, and dired packages. | 290 | @file{xemacs-base}, @file{elib}, and @file{dired} packages. |
| 290 | 291 | ||
| 291 | If you have @TeX{} installed at your site, you can make a typeset manual | 292 | If you have @TeX{} installed at your site, you can make a typeset manual |
| 292 | from @file{pcl-cvs.texi}. | 293 | from @file{pcl-cvs.texi}. |
| 293 | 294 | ||
| 294 | @enumerate | 295 | @enumerate |
| 295 | @item | 296 | @item |
| 296 | Run @TeX{} by typing @samp{texi2dvi pcl-cvs.texi}. | 297 | If PCL-CVS came with the Emacs distribution, type @kbd{make pcl-cvs.dvi} |
| 298 | in the @file{man} subdirectory of the Emacs source tree. | ||
| 299 | @item | ||
| 300 | Alternatively, run @TeX{} by typing @kbd{texi2dvi pcl-cvs.texi}. | ||
| 297 | @item | 301 | @item |
| 298 | Convert the resulting device independent file @file{pcl-cvs.dvi} to a | 302 | Convert the resulting device independent file @file{pcl-cvs.dvi} to a |
| 299 | form which your printer can output and print it. If you have a | 303 | form which your printer can output and print it. If you have a |
| 300 | postscript printer there is a program, @code{dvi2ps}, which does. There | 304 | PostScript printer, there is a program, @code{dvi2ps}, which does. There |
| 301 | is also a program which comes together with @TeX{}, @code{dvips}, which | 305 | is also a program which comes together with @TeX{}, @code{dvips}, which |
| 302 | you can use. | 306 | you can use. |
| 303 | @end enumerate | 307 | @end enumerate |
| @@ -307,20 +311,23 @@ you can use. | |||
| 307 | @chapter Getting started | 311 | @chapter Getting started |
| 308 | @cindex Introduction | 312 | @cindex Introduction |
| 309 | @cindex Example run | 313 | @cindex Example run |
| 314 | @cindex Sample session | ||
| 310 | 315 | ||
| 311 | This document assumes that you know what CVS is, and that you at least | 316 | This document assumes that you know what CVS is, and that you at least |
| 312 | know the fundamental concepts of CVS. If that is not the case you | 317 | know the fundamental concepts of CVS. If that is not the case, you |
| 313 | should read the man page for CVS. | 318 | should read the CVS documentation. Type @kbd{info -f cvs} or @kbd{man |
| 319 | cvs}. | ||
| 314 | 320 | ||
| 315 | PCL-CVS is only useful once you have checked out a module. So before | 321 | PCL-CVS is only useful once you have checked out a module. So before |
| 316 | you invoke it you must have a copy of a module somewhere in the file | 322 | you invoke it, you must have a copy of a module somewhere in the file |
| 317 | system. | 323 | system. |
| 318 | 324 | ||
| 319 | You can invoke PCL-CVS by typing @kbd{M-x cvs-examine RET}. | 325 | You can invoke PCL-CVS by typing @kbd{M-x cvs-examine @key{RET}}. |
| 320 | You can also invoke it via the menubar, under Tools. | 326 | You can also invoke it via the menu bar, under @samp{Tools}. |
| 321 | Or if you prefer, you can also invoke PCL-CVS by simply visiting the | 327 | Or, if you prefer, you can also invoke PCL-CVS by simply visiting the |
| 322 | CVS administrative subdirectory of your module, with a prefix argument. | 328 | CVS administrative subdirectory of your module, with a prefix argument. |
| 323 | F.ex. @kbd{C-u C-x 5 f ~/my/project/CVS RET}. | 329 | For example, to invoke PCL-CVS in a separate frame, type @kbd{C-u C-x 5 |
| 330 | f ~/my/project/CVS @key{RET}}. | ||
| 324 | 331 | ||
| 325 | The function @code{cvs-examine} will ask for a directory. The command | 332 | The function @code{cvs-examine} will ask for a directory. The command |
| 326 | @samp{cvs -n update} will be run in that directory. (It should contain | 333 | @samp{cvs -n update} will be run in that directory. (It should contain |
| @@ -356,14 +363,14 @@ checked in. | |||
| 356 | 363 | ||
| 357 | You can move the cursor up and down in the buffer with @kbd{C-n} and | 364 | You can move the cursor up and down in the buffer with @kbd{C-n} and |
| 358 | @kbd{C-p} or @kbd{n} and @kbd{p}. If you press @kbd{c} on one of the | 365 | @kbd{C-p} or @kbd{n} and @kbd{p}. If you press @kbd{c} on one of the |
| 359 | @samp{Modified} files that file will be checked in to the CVS | 366 | @samp{Modified} files, that file will be checked in to the CVS |
| 360 | repository. @xref{Committing changes}. You can also press @kbd{O} to | 367 | repository. @xref{Committing changes}. You can also press @kbd{O} to |
| 361 | update any of the files that are marked @samp{Need-Update}. You can | 368 | update any of the files that are marked @samp{Need-Update}. You can |
| 362 | also run @kbd{M-x cvs-update RET} (bound to @kbd{M-u} in the | 369 | also run @kbd{M-x cvs-update @key{RET}} (bound to @kbd{M-u} in the |
| 363 | @samp{*cvs*} buffer) to update all the files.@refill | 370 | @samp{*cvs*} buffer) to update all the files.@refill |
| 364 | 371 | ||
| 365 | You can then press @kbd{=} to easily get a @samp{diff} between your | 372 | You can then press @kbd{=} to easily get a @samp{diff} between your |
| 366 | modified file and the base version that you started from or you can | 373 | modified file and the base version that you started from, or you can |
| 367 | press @kbd{l} to get the output from @samp{cvs log}. Many more such | 374 | press @kbd{l} to get the output from @samp{cvs log}. Many more such |
| 368 | commands are available simply by pressing a key (@pxref{Getting info | 375 | commands are available simply by pressing a key (@pxref{Getting info |
| 369 | about files}). | 376 | about files}). |
| @@ -371,9 +378,10 @@ about files}). | |||
| 371 | @node Buffer contents, Selected files, Getting started, Top | 378 | @node Buffer contents, Selected files, Getting started, Top |
| 372 | @chapter Buffer contents | 379 | @chapter Buffer contents |
| 373 | @cindex Buffer contents | 380 | @cindex Buffer contents |
| 381 | @cindex @code{*cvs*} buffer contents | ||
| 374 | 382 | ||
| 375 | The display contains several columns, some of which are optional. | 383 | The display contains several columns, some of which are optional. |
| 376 | They contain, from left to right: | 384 | These columns are, from left to right: |
| 377 | 385 | ||
| 378 | @itemize @bullet | 386 | @itemize @bullet |
| 379 | 387 | ||
| @@ -382,15 +390,14 @@ Optionally, the head revision of the file. This is the latest version | |||
| 382 | found in the repository. It might also contain (instead of the head | 390 | found in the repository. It might also contain (instead of the head |
| 383 | revision) a sub status which typically gives further information about | 391 | revision) a sub status which typically gives further information about |
| 384 | how we got to the current state, for example @samp{patched}, | 392 | how we got to the current state, for example @samp{patched}, |
| 385 | @samp{merged}, ... | 393 | @samp{merged}, @dots{} |
| 386 | 394 | ||
| 387 | @item | 395 | @item |
| 388 | An asterisk when the file is @dfn{marked} (@pxref{Selected | 396 | An asterisk when the file is @dfn{marked} (@pxref{Selected |
| 389 | files}).@refill | 397 | files}).@refill |
| 390 | 398 | ||
| 391 | @item | 399 | @item |
| 392 | The actual status of the file wrt to the repository. @xref{Buffer | 400 | The actual status of the file wrt the repository. See below. |
| 393 | contents}, for more information.@refill | ||
| 394 | 401 | ||
| 395 | @item | 402 | @item |
| 396 | Optionally, the base revision of the file. This is the version | 403 | Optionally, the base revision of the file. This is the version |
| @@ -404,25 +411,22 @@ The file name. | |||
| 404 | The @samp{file status} field can have the following values: | 411 | The @samp{file status} field can have the following values: |
| 405 | 412 | ||
| 406 | @table @samp | 413 | @table @samp |
| 407 | |||
| 408 | @item Modified | 414 | @item Modified |
| 409 | The file is modified in your working directory, and there was no | 415 | The file is modified in your working directory, and there was no |
| 410 | modification to the same file in the repository. This status can have | 416 | modification to the same file in the repository. This status can have |
| 411 | the following substatus: | 417 | the following substatus: |
| 412 | 418 | ||
| 413 | @table @samp | 419 | @table @samp |
| 414 | |||
| 415 | @item merged | 420 | @item merged |
| 416 | The file was modified in your working directory, and there were | 421 | The file was modified in your working directory, and there were |
| 417 | modifications in the repository as well, but they were merged | 422 | modifications in the repository as well, but they were merged |
| 418 | successfully, without conflict, in your working directory.@refill | 423 | successfully, without conflict, in your working directory.@refill |
| 419 | |||
| 420 | @end table | 424 | @end table |
| 421 | 425 | ||
| 422 | @item Conflict | 426 | @item Conflict |
| 423 | A conflict was detected while trying to merge your changes to @var{file} | 427 | A conflict was detected while trying to merge your changes to @var{file} |
| 424 | with changes from the repository. @var{file} (the copy in your | 428 | with changes from the repository. @var{file} (the copy in your |
| 425 | working directory) is now the output of the @samp{rcsmerge} command on | 429 | working directory) is now the output of the @code{rcsmerge} command on |
| 426 | the two versions; an unmodified copy of your file is also in your | 430 | the two versions; an unmodified copy of your file is also in your |
| 427 | working directory, with the name @file{.#@var{file}.@var{version}}, | 431 | working directory, with the name @file{.#@var{file}.@var{version}}, |
| 428 | where @var{version} is the RCS revision that your modified file started | 432 | where @var{version} is the RCS revision that your modified file started |
| @@ -433,7 +437,6 @@ rather than on its content. This case is indicated by the following | |||
| 433 | possible substatus: | 437 | possible substatus: |
| 434 | 438 | ||
| 435 | @table @samp | 439 | @table @samp |
| 436 | |||
| 437 | @item removed | 440 | @item removed |
| 438 | The file is locally removed but a new revision has been committed to | 441 | The file is locally removed but a new revision has been committed to |
| 439 | the repository by someone else. | 442 | the repository by someone else. |
| @@ -445,7 +448,6 @@ by someone else. | |||
| 445 | @item modified | 448 | @item modified |
| 446 | The file is locally modified but someone else has removed it from the | 449 | The file is locally modified but someone else has removed it from the |
| 447 | repository. | 450 | repository. |
| 448 | |||
| 449 | @end table | 451 | @end table |
| 450 | 452 | ||
| 451 | @item Added | 453 | @item Added |
| @@ -467,7 +469,6 @@ The file is up to date with respect to the version in the repository. | |||
| 467 | This status can have a substatus of: | 469 | This status can have a substatus of: |
| 468 | 470 | ||
| 469 | @table @samp | 471 | @table @samp |
| 470 | |||
| 471 | @item added | 472 | @item added |
| 472 | You have just added the file to the repository.@refill | 473 | You have just added the file to the repository.@refill |
| 473 | 474 | ||
| @@ -485,7 +486,6 @@ more efficient method.@refill | |||
| 485 | 486 | ||
| 486 | @item committed | 487 | @item committed |
| 487 | You just committed the file.@refill | 488 | You just committed the file.@refill |
| 488 | |||
| 489 | @end table | 489 | @end table |
| 490 | 490 | ||
| 491 | @item Need-Update | 491 | @item Need-Update |
| @@ -502,7 +502,6 @@ you run a @samp{cvs-update}. | |||
| 502 | @item Missing | 502 | @item Missing |
| 503 | The file has been unexpectedly removed from your working directory | 503 | The file has been unexpectedly removed from your working directory |
| 504 | although it has not been @samp{cvs remove}d. | 504 | although it has not been @samp{cvs remove}d. |
| 505 | |||
| 506 | @end table | 505 | @end table |
| 507 | 506 | ||
| 508 | @node Selected files, Commands, Buffer contents, Top | 507 | @node Selected files, Commands, Buffer contents, Top |
| @@ -521,6 +520,8 @@ If a directory is selected but the command cannot be applied to a | |||
| 521 | directory, then it will be applied to the set of files under this | 520 | directory, then it will be applied to the set of files under this |
| 522 | directory which are in the @samp{*cvs*} buffer. | 521 | directory which are in the @samp{*cvs*} buffer. |
| 523 | 522 | ||
| 523 | @findex cvs-mode-force-command | ||
| 524 | @findex cvs-allow-dir-commit | ||
| 524 | Furthermore, each command only operates on a subset of the selected | 525 | Furthermore, each command only operates on a subset of the selected |
| 525 | files, depending on whether or not the command is @dfn{applicable} to | 526 | files, depending on whether or not the command is @dfn{applicable} to |
| 526 | each file (based on the file's status). For example, | 527 | each file (based on the file's status). For example, |
| @@ -543,7 +544,7 @@ command. | |||
| 543 | This scheme might seem a little complicated, but once one gets used to | 544 | This scheme might seem a little complicated, but once one gets used to |
| 544 | it, it is quite powerful. | 545 | it, it is quite powerful. |
| 545 | 546 | ||
| 546 | For commands to mark and unmark files, see @xref{Marking files}. | 547 | For commands to mark and unmark files, see @ref{Marking files}. |
| 547 | 548 | ||
| 548 | @node Commands, Log Edit Mode, Selected files, Top | 549 | @node Commands, Log Edit Mode, Selected files, Top |
| 549 | @chapter Commands | 550 | @chapter Commands |
| @@ -551,10 +552,10 @@ For commands to mark and unmark files, see @xref{Marking files}. | |||
| 551 | @iftex | 552 | @iftex |
| 552 | This chapter describes all the commands that you can use in PCL-CVS. | 553 | This chapter describes all the commands that you can use in PCL-CVS. |
| 553 | @end iftex | 554 | @end iftex |
| 554 | @ifinfo | 555 | @ifnottex |
| 555 | The nodes in this menu contains explanations about all the commands that | 556 | The nodes in this menu contains explanations about all the commands that |
| 556 | you can use in PCL-CVS. They are grouped together by type. | 557 | you can use in PCL-CVS. They are grouped together by type. |
| 557 | @end ifinfo | 558 | @end ifnottex |
| 558 | 559 | ||
| 559 | @menu | 560 | @menu |
| 560 | * Entering PCL-CVS:: Commands to invoke PCL-CVS | 561 | * Entering PCL-CVS:: Commands to invoke PCL-CVS |
| @@ -592,10 +593,9 @@ Most commands in PCL-CVS require that you have a @samp{*cvs*} | |||
| 592 | buffer. The commands that you use to get one are listed below. | 593 | buffer. The commands that you use to get one are listed below. |
| 593 | For each, a @samp{cvs} process will be run, the output will be parsed by | 594 | For each, a @samp{cvs} process will be run, the output will be parsed by |
| 594 | PCL-CVS, and the result will be printed in the @samp{*cvs*} buffer (see | 595 | PCL-CVS, and the result will be printed in the @samp{*cvs*} buffer (see |
| 595 | @pxref{Buffer contents} for a description of the contents). | 596 | @ref{Buffer contents}, for a description of the buffer's contents). |
| 596 | 597 | ||
| 597 | @table @kbd | 598 | @table @kbd |
| 598 | |||
| 599 | @item M-x cvs-update | 599 | @item M-x cvs-update |
| 600 | Run a @samp{cvs update} command. You will be asked for the directory | 600 | Run a @samp{cvs update} command. You will be asked for the directory |
| 601 | in which the @samp{cvs update} will be run. | 601 | in which the @samp{cvs update} will be run. |
| @@ -618,30 +618,32 @@ out. | |||
| 618 | @item M-x cvs-quickdir | 618 | @item M-x cvs-quickdir |
| 619 | Populate the @samp{*cvs*} buffer by just looking at the @file{CVS/Entries} | 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 | 620 | files. This is very much like @code{cvs-examine} except that it does |
| 621 | not access the CVS repository which is a major advantage when the | 621 | not access the CVS repository, which is a major advantage when the |
| 622 | repository is far away. But of course, it will not be able to detect | 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. | 623 | when a file needs to be updated or merged. |
| 624 | |||
| 625 | @end table | 624 | @end table |
| 626 | 625 | ||
| 626 | @findex cvs-dired-action | ||
| 627 | @findex cvs-dired-use-hook | ||
| 627 | The first four of | 628 | The first four of |
| 628 | those commands are also reachable from the menubar | 629 | those commands are also reachable from the menu bar |
| 629 | under @samp{Tools->PCL-CVS}. Finally an alternative way is to visit | 630 | under @samp{Tools->PCL-CVS}. Finally, an alternative way is to visit |
| 630 | the CVS administrative subdirectory in your work area with a simple | 631 | the CVS administrative subdirectory in your work area with a simple |
| 631 | prefix argument. For example @kbd{C-u C-x C-f ~/my/work/CVS RET}. This | 632 | prefix argument. For example @kbd{C-u C-x C-f ~/my/work/CVS @key{RET}}. This |
| 632 | will by default run @code{cvs-quickdir} but the specific behavior can be | 633 | by default runs @code{cvs-quickdir} but the specific behavior can be |
| 633 | changed with @code{cvs-dired-action} and @code{cvs-dired-use-hook}. | 634 | changed with @code{cvs-dired-action} and @code{cvs-dired-use-hook}. |
| 634 | 635 | ||
| 635 | By default, the commands above will descend recursively into | 636 | By default, the commands above will descend recursively into |
| 636 | subdirectories. You can avoid that behavior by including @samp{-l} in | 637 | subdirectories. You can avoid that behavior by including @samp{-l} in |
| 637 | the flags for the command. These flags can be set by giving a prefix | 638 | the flags for the command. These flags can be set by giving a prefix |
| 638 | argument to the command (e.g., by typing | 639 | argument to the command (e.g., by typing |
| 639 | @kbd{C-u M-x cvs-update RET -l RET}). | 640 | @kbd{C-u M-x cvs-update @key{RET} -l @key{RET}}). |
| 640 | 641 | ||
| 641 | 642 | ||
| 642 | @node Setting flags, Updating the buffer, Entering PCL-CVS, Commands | 643 | @node Setting flags, Updating the buffer, Entering PCL-CVS, Commands |
| 643 | @section Setting flags for CVS commands | 644 | @section Setting flags for CVS commands |
| 644 | @cindex Special prefix | 645 | @cindex Optional switches to CVS |
| 646 | @cindex Command-line options to CVS | ||
| 645 | 647 | ||
| 646 | This section describes the convention used by nearly all PCL-CVS | 648 | This section describes the convention used by nearly all PCL-CVS |
| 647 | commands for setting optional flags sent to CVS. A single @kbd{C-u} | 649 | commands for setting optional flags sent to CVS. A single @kbd{C-u} |
| @@ -653,20 +655,21 @@ unless temporary flags are set which override them. | |||
| 653 | 655 | ||
| 654 | Perhaps an example or two is in order. Say you are about to add a | 656 | Perhaps an example or two is in order. Say you are about to add a |
| 655 | binary file to the repository, and want to specify the flags @samp{-kb} | 657 | binary file to the repository, and want to specify the flags @samp{-kb} |
| 656 | to @samp{cvs add}. You can type @kbd{C-u a -kb RET}, enter the | 658 | to @samp{cvs add}. You can type @kbd{C-u a -kb @key{RET}}, enter the |
| 657 | description, and the file will be added. Subsequent adds will use the | 659 | description, and the file will be added. Subsequent @samp{cvs add} |
| 658 | previously prevailing flags. | 660 | commands will use the previously prevailing flags. |
| 659 | 661 | ||
| 660 | As a second example, say you are about to perform a diff and want to see | 662 | As a second example, say you are about to perform a diff and want to see |
| 661 | the result in unified diff format, i.e. you'd like to pass the flag | 663 | the result in unified diff format, i.e. you'd like to pass the flag |
| 662 | @samp{-u} to both @samp{cvs diff} and @samp{diff}. You'd also like all | 664 | @samp{-u} to both @samp{cvs diff} and @samp{diff}. You'd also like all |
| 663 | subsequent diffs to use this flag. You can type @kbd{C-u C-u = -u RET} | 665 | subsequent diffs to use this flag. You can type @kbd{C-u C-u = -u @key{RET}} |
| 664 | and the diff will be performed, and the default flags will be set to | 666 | and the diff will be performed, and the default flags will be set to |
| 665 | @code{("-u")}. You can of course override this flag for a single diff | 667 | @code{("-u")}. You can of course override this flag for a single diff |
| 666 | by using a single @kbd{C-u} prefix argument. | 668 | by using a single @kbd{C-u} prefix argument. |
| 667 | 669 | ||
| 668 | Additionally to this, some commands can take @dfn{special prefix} arguments. | 670 | @cindex Special prefix |
| 669 | These work as follows: when called with a @kbd{C-u} prefix, the user is | 671 | In addition to this, some commands can take @dfn{special prefix} arguments. |
| 672 | These work as follows: When called with a @kbd{C-u} prefix, the user is | ||
| 670 | prompted for a new value of the special prefix and the special prefix is | 673 | prompted for a new value of the special prefix and the special prefix is |
| 671 | activated for the next command. When called without the @kbd{C-u} | 674 | activated for the next command. When called without the @kbd{C-u} |
| 672 | prefix, the special prefix is re-activated (with the same value as last | 675 | prefix, the special prefix is re-activated (with the same value as last |
| @@ -676,7 +679,6 @@ prefix activates it for all subsequent commands until you deactivate it | |||
| 676 | explicitly. The special prefixes are: | 679 | explicitly. The special prefixes are: |
| 677 | 680 | ||
| 678 | @table @kbd | 681 | @table @kbd |
| 679 | |||
| 680 | @item T | 682 | @item T |
| 681 | Toggles whether or not marks will be active in the next command.@refill | 683 | Toggles whether or not marks will be active in the next command.@refill |
| 682 | 684 | ||
| @@ -685,14 +687,13 @@ Provide the next command with a branch (can be any version | |||
| 685 | specifier) to work on.@refill | 687 | specifier) to work on.@refill |
| 686 | 688 | ||
| 687 | @item B | 689 | @item B |
| 688 | Secondary branch argument. Only meaningful if `b' is also used. | 690 | Secondary branch argument. Only meaningful if @kbd{b} is also used. |
| 689 | It can be used to provide a second branch argument to | 691 | It can be used to provide a second branch argument to |
| 690 | @code{cvs-mode-diff} or to @code{cvs-mode-update}. | 692 | @code{cvs-mode-diff} or to @code{cvs-mode-update}. |
| 691 | 693 | ||
| 692 | @item M-f | 694 | @item M-f |
| 693 | Forces the next command to apply to every selected file rather than only | 695 | Forces the next command to apply to every selected file rather than only |
| 694 | to the ones PCL-CVS thinks are relevant. | 696 | to the ones PCL-CVS thinks are relevant. |
| 695 | |||
| 696 | @end table | 697 | @end table |
| 697 | 698 | ||
| 698 | @node Updating the buffer, Movement commands, Setting flags, Commands | 699 | @node Updating the buffer, Movement commands, Setting flags, Commands |
| @@ -708,38 +709,35 @@ The following commands can be used from within the @samp{*cvs*} buffer | |||
| 708 | to update the display: | 709 | to update the display: |
| 709 | 710 | ||
| 710 | @table @kbd | 711 | @table @kbd |
| 711 | |||
| 712 | @item M-u | 712 | @item M-u |
| 713 | This runs the command @samp{cvs-update}.@refill | 713 | Runs the command @samp{cvs-update}.@refill |
| 714 | 714 | ||
| 715 | @item M-e | 715 | @item M-e |
| 716 | This runs the command @samp{cvs-examine}.@refill | 716 | Runs the command @samp{cvs-examine}.@refill |
| 717 | 717 | ||
| 718 | @item M-s | 718 | @item M-s |
| 719 | This runs the command @samp{cvs-status}.@refill | 719 | Runs the command @samp{cvs-status}.@refill |
| 720 | |||
| 721 | @end table | 720 | @end table |
| 722 | 721 | ||
| 723 | Additionally to the above commands which operate on the whole module, | 722 | In addition to the above commands which operate on the whole module, |
| 724 | you can run the equivalent CVS command on just a subset of the | 723 | you can run the equivalent CVS command on just a subset of the |
| 725 | files/directories with | 724 | files/directories with these keys: |
| 726 | 725 | ||
| 727 | @table @kbd | 726 | @table @kbd |
| 728 | |||
| 729 | @item O | 727 | @item O |
| 730 | Runs @code{cvs-mode-update} on the selected files. When run on the | 728 | Runs @code{cvs-mode-update} on the selected files. When run on the |
| 731 | top level directory, this is equivalent to @kbd{M-u}.@refill | 729 | top-level directory, this is equivalent to @kbd{M-u}.@refill |
| 732 | 730 | ||
| 733 | @item e | 731 | @item e |
| 734 | Runs @code{cvs-mode-examine} on the selected files. When run on the | 732 | Runs @code{cvs-mode-examine} on the selected files. When run on the |
| 735 | top level directory, this is equivalent to @kbd{M-e}.@refill | 733 | top-level directory, this is equivalent to @kbd{M-e}.@refill |
| 736 | 734 | ||
| 735 | @findex cvs-status-mode | ||
| 737 | @item s | 736 | @item s |
| 738 | Runs @code{cvs-mode-status} on the selected files. When run on the | 737 | Runs @code{cvs-mode-status} on the selected files. When run on the |
| 739 | top level directory, this is equivalent to @kbd{M-s} except that | 738 | top-level directory, this is equivalent to @kbd{M-s}, except that |
| 740 | CVS output will be shown in a @samp{*cvs-info*} buffer that will be | 739 | CVS output will be shown in a @samp{*cvs-info*} buffer that will be |
| 741 | put in @samp{cvs-status-mode}.@refill | 740 | put in @samp{cvs-status-mode}.@refill |
| 742 | |||
| 743 | @end table | 741 | @end table |
| 744 | 742 | ||
| 745 | 743 | ||
| @@ -748,9 +746,9 @@ put in @samp{cvs-status-mode}.@refill | |||
| 748 | @cindex Movement Commands | 746 | @cindex Movement Commands |
| 749 | @findex cvs-mode-next-line | 747 | @findex cvs-mode-next-line |
| 750 | @findex cvs-mode-previous-line | 748 | @findex cvs-mode-previous-line |
| 751 | @kindex SPC - Move down one file | 749 | @kindex SPC@r{--Move down one file} |
| 752 | @kindex n - Move down one file | 750 | @kindex n@r{--Move down one file} |
| 753 | @kindex p - Move up one file | 751 | @kindex p@r{--Move up one file} |
| 754 | 752 | ||
| 755 | You can use most normal Emacs commands to move forward and backward in | 753 | You can use most normal Emacs commands to move forward and backward in |
| 756 | the buffer. Some keys are rebound to functions that take advantage of | 754 | the buffer. Some keys are rebound to functions that take advantage of |
| @@ -758,13 +756,13 @@ the fact that the buffer is a PCL-CVS buffer: | |||
| 758 | 756 | ||
| 759 | 757 | ||
| 760 | @table @kbd | 758 | @table @kbd |
| 761 | @item SPC | 759 | @item @key{SPC} |
| 762 | @itemx n | 760 | @itemx n |
| 763 | These keys move the cursor one file forward, towards the end of the | 761 | These keys move the cursor one file forward, towards the end of the |
| 764 | buffer (@code{cvs-mode-next-line}).@refill | 762 | buffer (@code{cvs-mode-next-line}).@refill |
| 765 | 763 | ||
| 766 | @itemx p | 764 | @itemx p |
| 767 | This key move one file backward, towards the beginning of the buffer | 765 | This key moves one file backward, towards the beginning of the buffer |
| 768 | (@code{cvs-mode-previous-line}). | 766 | (@code{cvs-mode-previous-line}). |
| 769 | @end table | 767 | @end table |
| 770 | 768 | ||
| @@ -773,13 +771,13 @@ This key move one file backward, towards the beginning of the buffer | |||
| 773 | @section Marking files | 771 | @section Marking files |
| 774 | @cindex Selecting files (commands to mark files) | 772 | @cindex Selecting files (commands to mark files) |
| 775 | @cindex Marking files | 773 | @cindex Marking files |
| 776 | @kindex m - marking a file | 774 | @kindex m@r{--marking a file} |
| 777 | @kindex M - marking all files | 775 | @kindex M@r{--marking all files} |
| 778 | @kindex u - unmark a file | 776 | @kindex u@r{--unmark a file} |
| 779 | @kindex ESC DEL - unmark all files | 777 | @kindex ESC DEL@r{--unmark all files} |
| 780 | @kindex DEL - unmark previous file | 778 | @kindex DEL@r{--unmark previous file} |
| 781 | @kindex % - mark files matching regexp | 779 | @kindex %@r{--mark files matching regexp} |
| 782 | @kindex T - toggle marks | 780 | @kindex T@r{--toggle marks} |
| 783 | @findex cvs-mode-mark | 781 | @findex cvs-mode-mark |
| 784 | @findex cvs-mode-unmark | 782 | @findex cvs-mode-unmark |
| 785 | @findex cvs-mode-mark-all-files | 783 | @findex cvs-mode-mark-all-files |
| @@ -794,12 +792,12 @@ You can mark and unmark files with these commands: | |||
| 794 | @table @kbd | 792 | @table @kbd |
| 795 | @item m | 793 | @item m |
| 796 | This marks the file that the cursor is positioned on. If the cursor is | 794 | This marks the file that the cursor is positioned on. If the cursor is |
| 797 | positioned on a directory all files in that directory will be marked. | 795 | positioned on a directory all files in that directory are marked. |
| 798 | (@code{cvs-mode-mark}).@refill | 796 | (@code{cvs-mode-mark}).@refill |
| 799 | 797 | ||
| 800 | @item u | 798 | @item u |
| 801 | Unmark the file that the cursor is positioned on. If the cursor is on a | 799 | Unmark the file that the cursor is positioned on. If the cursor is on a |
| 802 | directory, all files in that directory will be unmarked. | 800 | directory, all files in that directory are unmarked. |
| 803 | (@code{cvs-mode-unmark}).@refill | 801 | (@code{cvs-mode-unmark}).@refill |
| 804 | 802 | ||
| 805 | @item M | 803 | @item M |
| @@ -824,12 +822,11 @@ Toggle use of marks for the next command (@code{cvs-mode-toggle-marks}). | |||
| 824 | @node Committing changes, Editing files, Marking files, Commands | 822 | @node Committing changes, Editing files, Marking files, Commands |
| 825 | @section Committing changes | 823 | @section Committing changes |
| 826 | @cindex Committing changes | 824 | @cindex Committing changes |
| 827 | @cindex Ci | ||
| 828 | @findex cvs-mode-commit | 825 | @findex cvs-mode-commit |
| 829 | @findex cvs-mode-commit-setup | 826 | @findex cvs-mode-commit-setup |
| 830 | @kindex c - commit files | 827 | @kindex c@r{--commit files} |
| 831 | @kindex C - commit files with ChangeLog message | 828 | @kindex C@r{--commit files with @file{ChangeLog} message} |
| 832 | @vindex cvs-auto-revert (variable) | 829 | @vindex cvs-auto-revert@r{ (variable)} |
| 833 | @cindex Commit buffer | 830 | @cindex Commit buffer |
| 834 | @cindex Edit buffer | 831 | @cindex Edit buffer |
| 835 | @cindex Erasing commit message | 832 | @cindex Erasing commit message |
| @@ -850,14 +847,14 @@ commit (@pxref{Log Edit Mode}).@refill | |||
| 850 | @item | 847 | @item |
| 851 | When you're happy with it, you type @kbd{C-c C-c} to do the actual | 848 | When you're happy with it, you type @kbd{C-c C-c} to do the actual |
| 852 | commit.@refill | 849 | commit.@refill |
| 853 | |||
| 854 | @end enumerate | 850 | @end enumerate |
| 855 | 851 | ||
| 856 | There's no hidden state, so you can abort the process or pick it up | 852 | There's no hidden state, so you can abort the process or pick it up |
| 857 | again at any time. | 853 | again at any time. |
| 858 | 854 | ||
| 855 | @vindex log-edit-confirm@r{ (variable)} | ||
| 859 | The set of files actually committed is really decided only during the | 856 | The set of files actually committed is really decided only during the |
| 860 | very last step, which is mixed blessing. It allows you to go back and | 857 | very last step, which is a mixed blessing. It allows you to go back and |
| 861 | change your mind about which files to commit, but it also means that you | 858 | change your mind about which files to commit, but it also means that you |
| 862 | might inadvertently change the set of selected files. To reduce the | 859 | might inadvertently change the set of selected files. To reduce the |
| 863 | risk of error, @kbd{C-c C-c} will ask for confirmation if the set of | 860 | risk of error, @kbd{C-c C-c} will ask for confirmation if the set of |
| @@ -867,14 +864,14 @@ change this last detail with @code{log-edit-confirm}. | |||
| 867 | As for the difference between @kbd{c} (i.e. @code{cvs-mode-commit}) and | 864 | As for the difference between @kbd{c} (i.e. @code{cvs-mode-commit}) and |
| 868 | @kbd{C} (i.e. @code{cvs-mode-commit-setup}) is that the first gets you | 865 | @kbd{C} (i.e. @code{cvs-mode-commit-setup}) is that the first gets you |
| 869 | straight to @samp{*cvs-commit*} without erasing it or changing anything | 866 | straight to @samp{*cvs-commit*} without erasing it or changing anything |
| 870 | to its content, while the second will first erase @samp{*cvs-commit*} | 867 | to its content, while the second first erases @samp{*cvs-commit*} |
| 871 | and try to initialize it with a sane default (it will do that by either | 868 | and tries to initialize it with a sane default (it does that by either |
| 872 | using a template provided by the CVS administrator or by extracting a | 869 | using a template provided by the CVS administrator or by extracting a |
| 873 | relevant log message from a ChangeLog file). | 870 | relevant log message from a @file{ChangeLog} file). |
| 874 | 871 | ||
| 875 | If you are editing the files in your Emacs an automatic | 872 | If you are editing the files in your Emacs, an automatic |
| 876 | @samp{revert-buffer} will be performed. (If the file contains | 873 | @samp{revert-buffer} will be performed. (If the file contains |
| 877 | @samp{$@asis{Id}$} keywords @samp{cvs commit} will write a new file with | 874 | @samp{$@asis{Id}$} keywords, @samp{cvs commit} will write a new file with |
| 878 | the new values substituted. The auto-revert makes sure that you get | 875 | the new values substituted. The auto-revert makes sure that you get |
| 879 | them into your buffer). The revert will not occur if you have modified | 876 | them into your buffer). The revert will not occur if you have modified |
| 880 | your buffer, or if @samp{cvs-auto-revert} is set to | 877 | your buffer, or if @samp{cvs-auto-revert} is set to |
| @@ -891,9 +888,9 @@ your buffer, or if @samp{cvs-auto-revert} is set to | |||
| 891 | @findex cvs-mode-find-file | 888 | @findex cvs-mode-find-file |
| 892 | @findex cvs-mode-find-file-other-window | 889 | @findex cvs-mode-find-file-other-window |
| 893 | @findex cvs-mode-add-change-log-entry-other-window | 890 | @findex cvs-mode-add-change-log-entry-other-window |
| 894 | @kindex f - find file or directory | 891 | @kindex f@r{--find file or directory} |
| 895 | @kindex o - find file in other window | 892 | @kindex o@r{--find file in other window} |
| 896 | @kindex A - add ChangeLog entry | 893 | @kindex A@r{--add @file{ChangeLog} entry} |
| 897 | 894 | ||
| 898 | There are currently three commands that can be used to find a file (that | 895 | There are currently three commands that can be used to find a file (that |
| 899 | is, load it into a buffer and start editing it there). These commands | 896 | is, load it into a buffer and start editing it there). These commands |
| @@ -902,11 +899,9 @@ files. | |||
| 902 | 899 | ||
| 903 | @table @kbd | 900 | @table @kbd |
| 904 | @item f | 901 | @item f |
| 905 | Find the file that the cursor points to. Run @samp{dired} | 902 | Find the file that the cursor points to (@code{cvs-mode-find-file}). If |
| 906 | @ifinfo | 903 | the cursor points to a directory, run @code{dired} on that directory; |
| 907 | (@pxref{Dired,,,Emacs}) | 904 | @inforef{Dired, , emacs}. |
| 908 | @end ifinfo | ||
| 909 | if the cursor points to a directory (@code{cvs-mode-find-file}).@refill | ||
| 910 | 905 | ||
| 911 | @item o | 906 | @item o |
| 912 | Like @kbd{f}, but use another window | 907 | Like @kbd{f}, but use another window |
| @@ -914,9 +909,9 @@ Like @kbd{f}, but use another window | |||
| 914 | 909 | ||
| 915 | @item A | 910 | @item A |
| 916 | Invoke @samp{add-change-log-entry-other-window} to edit a | 911 | Invoke @samp{add-change-log-entry-other-window} to edit a |
| 917 | @samp{ChangeLog} file. The @samp{ChangeLog} will be found in the | 912 | @file{ChangeLog} file. The @file{ChangeLog} file will be found in the |
| 918 | directory or a parent of the directory of the file the cursor points to. | 913 | directory of the file the cursor points to, or in a parent of that |
| 919 | (@code{cvs-mode-add-change-log-entry-other-window}).@refill | 914 | directory. (@code{cvs-mode-add-change-log-entry-other-window}).@refill |
| 920 | @end table | 915 | @end table |
| 921 | 916 | ||
| 922 | 917 | ||
| @@ -925,21 +920,21 @@ directory or a parent of the directory of the file the cursor points to. | |||
| 925 | @cindex Status (cvs command) | 920 | @cindex Status (cvs command) |
| 926 | @cindex Log (RCS/cvs command) | 921 | @cindex Log (RCS/cvs command) |
| 927 | @cindex Getting status | 922 | @cindex Getting status |
| 928 | @kindex l - run @samp{cvs log} | 923 | @kindex l@r{--run @samp{cvs log}} |
| 929 | @kindex s - run @samp{cvs status} | 924 | @kindex s@r{--run @samp{cvs status}} |
| 930 | @findex cvs-mode-log | 925 | @findex cvs-mode-log |
| 931 | @findex cvs-mode-status | 926 | @findex cvs-mode-status |
| 932 | 927 | ||
| 933 | @table @kbd | 928 | @table @kbd |
| 934 | @item l | 929 | @item l |
| 935 | Call the command @code{cvs-mode-log} which runs @samp{cvs log} on all | 930 | Call the command @code{cvs-mode-log} which runs @samp{cvs log} on all |
| 936 | selected files, and show the result in a temporary @samp{*cvs-info*} | 931 | selected files, and show the result in a temporary buffer |
| 937 | buffer (@pxref{Log View Mode}). | 932 | @samp{*cvs-info*} (@pxref{Log View Mode}). |
| 938 | 933 | ||
| 939 | @item s | 934 | @item s |
| 940 | Call the command @code{cvs-mode-status} which runs @samp{cvs status} on | 935 | Call the command @code{cvs-mode-status} which runs @samp{cvs status} on |
| 941 | all selected files, and show the result in a temporary @samp{*cvs-info*} | 936 | all selected files, and show the result in a temporary buffer |
| 942 | buffer (@pxref{CVS Status Mode}). | 937 | @samp{*cvs-info*} (@pxref{CVS Status Mode}). |
| 943 | @end table | 938 | @end table |
| 944 | 939 | ||
| 945 | 940 | ||
| @@ -950,20 +945,20 @@ buffer (@pxref{CVS Status Mode}). | |||
| 950 | @cindex Resurrecting files | 945 | @cindex Resurrecting files |
| 951 | @cindex Deleting files | 946 | @cindex Deleting files |
| 952 | @cindex Putting files under CVS control | 947 | @cindex Putting files under CVS control |
| 953 | @kindex a - add a file | 948 | @kindex a@r{--add a file} |
| 954 | @kindex r - remove a file | 949 | @kindex r@r{--remove a file} |
| 955 | @findex cvs-mode-add | 950 | @findex cvs-mode-add |
| 956 | @findex cvs-mode-remove-file | 951 | @findex cvs-mode-remove-file |
| 957 | 952 | ||
| 958 | The following commands are available to make it easy to add and remove | 953 | The following commands are available to make it easy to add fuiles to |
| 959 | files from the CVS repository. | 954 | and remove them from the CVS repository. |
| 960 | 955 | ||
| 961 | @table @kbd | 956 | @table @kbd |
| 962 | @item a | 957 | @item a |
| 963 | Add all selected files. This command can be used on @samp{Unknown} | 958 | Add all selected files. This command can be used on @samp{Unknown} |
| 964 | files (@pxref{Buffer contents}). The status of the file will change to | 959 | files (@pxref{Buffer contents}). The status of the file will change to |
| 965 | @samp{Added}, and you will have to use @kbd{c} (@samp{cvs-mode-commit}, | 960 | @samp{Added}, and you will have to use @kbd{c} (@samp{cvs-mode-commit} |
| 966 | @pxref{Committing changes}) to really add the file to the | 961 | @pxref{Committing changes}), to really add the file to the |
| 967 | repository.@refill | 962 | repository.@refill |
| 968 | 963 | ||
| 969 | This command can also be used on @samp{Removed} files (before you commit | 964 | This command can also be used on @samp{Removed} files (before you commit |
| @@ -973,10 +968,10 @@ The command that is run is @code{cvs-mode-add}. | |||
| 973 | 968 | ||
| 974 | @item r | 969 | @item r |
| 975 | This command removes the selected files (after prompting for | 970 | This command removes the selected files (after prompting for |
| 976 | confirmation). The files are @samp{rm}ed from your directory and | 971 | confirmation). The files are deleted from your directory and |
| 977 | (unless the status was @samp{Unknown}; @pxref{Buffer contents}) they will | 972 | (unless the status was @samp{Unknown}; @pxref{Buffer contents}) they will |
| 978 | also be @samp{cvs remove}d. If the files were @samp{Unknown} they will | 973 | also be @samp{cvs remove}d. If the files' status was @samp{Unknown} |
| 979 | disappear from the buffer. Otherwise their status will change to | 974 | they will disappear from the buffer. Otherwise their status will change to |
| 980 | @samp{Removed}, and you must use @kbd{c} (@samp{cvs-mode-commit}, | 975 | @samp{Removed}, and you must use @kbd{c} (@samp{cvs-mode-commit}, |
| 981 | @pxref{Committing changes}) to commit the removal.@refill | 976 | @pxref{Committing changes}) to commit the removal.@refill |
| 982 | 977 | ||
| @@ -988,7 +983,7 @@ The command that is run is @code{cvs-mode-remove-file}. | |||
| 988 | @section Undoing changes | 983 | @section Undoing changes |
| 989 | @cindex Undo changes | 984 | @cindex Undo changes |
| 990 | @cindex Flush changes | 985 | @cindex Flush changes |
| 991 | @kindex U - undo changes | 986 | @kindex U@r{--undo changes} |
| 992 | @findex cvs-mode-undo-local-changes | 987 | @findex cvs-mode-undo-local-changes |
| 993 | 988 | ||
| 994 | @table @kbd | 989 | @table @kbd |
| @@ -1007,8 +1002,8 @@ version from the repository (@code{cvs-mode-undo-local-changes}. | |||
| 1007 | @cindex Getting rid of uninteresting lines | 1002 | @cindex Getting rid of uninteresting lines |
| 1008 | @cindex Removing uninteresting (processed) lines | 1003 | @cindex Removing uninteresting (processed) lines |
| 1009 | @cindex Handled lines, removing them | 1004 | @cindex Handled lines, removing them |
| 1010 | @kindex x - remove processed entries | 1005 | @kindex x@r{--remove processed entries} |
| 1011 | @kindex C-k - remove selected entries | 1006 | @kindex C-k@r{--remove selected entries} |
| 1012 | @findex cvs-mode-remove-handled | 1007 | @findex cvs-mode-remove-handled |
| 1013 | @findex cvs-mode-acknowledge | 1008 | @findex cvs-mode-acknowledge |
| 1014 | @findex cvs-mode-ignore | 1009 | @findex cvs-mode-ignore |
| @@ -1017,12 +1012,13 @@ version from the repository (@code{cvs-mode-undo-local-changes}. | |||
| 1017 | @item x | 1012 | @item x |
| 1018 | This command allows you to remove all entries that you have processed. | 1013 | This command allows you to remove all entries that you have processed. |
| 1019 | More specifically, the lines for @samp{Up-to-date} files (@pxref{Buffer | 1014 | More specifically, the lines for @samp{Up-to-date} files (@pxref{Buffer |
| 1020 | contents} are removed from the buffer. If a directory becomes empty the heading | 1015 | contents}) are removed from the buffer. If a directory becomes empty |
| 1021 | for that directory is also removed. This makes it easier to get an | 1016 | the heading for that directory is also removed. This makes it easier to |
| 1022 | overview of what needs to be done. | 1017 | get an overview of what needs to be done. |
| 1023 | 1018 | ||
| 1024 | The command is called @code{cvs-mode-remove-handled}. If | 1019 | @vindex cvs-mode-remove-handled@r{ (variable)} |
| 1025 | @samp{cvs-auto-remove-handled} is set to non-@code{nil} this will | 1020 | @kbd{x} invokes @code{cvs-mode-remove-handled}. If |
| 1021 | @samp{cvs-auto-remove-handled} is set to non-@code{nil}, this will | ||
| 1026 | automatically be performed after every commit.@refill | 1022 | automatically be performed after every commit.@refill |
| 1027 | 1023 | ||
| 1028 | @item C-k | 1024 | @item C-k |
| @@ -1033,17 +1029,18 @@ not delete, but that you want to delete (@code{cvs-mode-acknowledge}). | |||
| 1033 | 1029 | ||
| 1034 | @node Ignoring files, Viewing differences, Removing handled entries, Commands | 1030 | @node Ignoring files, Viewing differences, Removing handled entries, Commands |
| 1035 | @section Ignoring files | 1031 | @section Ignoring files |
| 1036 | @kindex i - ignoring files | 1032 | @cindex Ignoring files |
| 1033 | @kindex i@r{--ignoring files} | ||
| 1037 | @findex cvs-mode-ignore | 1034 | @findex cvs-mode-ignore |
| 1038 | 1035 | ||
| 1039 | @table @kbd | 1036 | @table @kbd |
| 1040 | @item i | 1037 | @item i |
| 1041 | Arrange so that CVS will ignore the selected files. The file names are | 1038 | Arrange so that CVS will ignore the selected files. The file names are |
| 1042 | added to the @file{.cvsignore} file in the corresponding directory. If | 1039 | added to the @file{.cvsignore} file in the corresponding directory. If |
| 1043 | the @file{.cvsignore} doesn't exist it will be created. | 1040 | the @file{.cvsignore} file doesn't exist, it will be created. |
| 1044 | 1041 | ||
| 1045 | The @file{.cvsignore} file should normally be added to the repository, | 1042 | The @file{.cvsignore} file should normally be added to the repository, |
| 1046 | but you could ignore it also if you like it better that way. | 1043 | but you could ignore it as well, if you like it better that way. |
| 1047 | 1044 | ||
| 1048 | This runs @code{cvs-mode-ignore}. | 1045 | This runs @code{cvs-mode-ignore}. |
| 1049 | @end table | 1046 | @end table |
| @@ -1051,18 +1048,19 @@ This runs @code{cvs-mode-ignore}. | |||
| 1051 | @node Viewing differences, Invoking Ediff, Ignoring files, Commands | 1048 | @node Viewing differences, Invoking Ediff, Ignoring files, Commands |
| 1052 | @section Viewing differences | 1049 | @section Viewing differences |
| 1053 | @cindex Diff | 1050 | @cindex Diff |
| 1054 | @cindex Invoking ediff | 1051 | @cindex Invoking @code{diff} |
| 1055 | @cindex Conflicts, how to resolve them | 1052 | @cindex Conflicts, how to resolve them |
| 1056 | @cindex Viewing differences | 1053 | @cindex Viewing differences |
| 1057 | @kindex d= - run @samp{cvs diff} | 1054 | @kindex d=@r{--run @samp{cvs diff}} |
| 1058 | @kindex = - run @samp{cvs diff} | 1055 | @kindex =@r{--run @samp{cvs diff}} |
| 1059 | @kindex dh - diff against head of repository | 1056 | @kindex db@r{--diff against base version} |
| 1060 | @kindex dv - diff against vendor branch | 1057 | @kindex dh@r{--diff against head of repository} |
| 1058 | @kindex dv@r{--diff against vendor branch} | ||
| 1061 | @findex cvs-mode-diff | 1059 | @findex cvs-mode-diff |
| 1062 | @findex cvs-mode-diff-backup | 1060 | @findex cvs-mode-diff-backup |
| 1063 | @findex cvs-mode-diff-head | 1061 | @findex cvs-mode-diff-head |
| 1064 | @findex cvs-mode-diff-vendor | 1062 | @findex cvs-mode-diff-vendor |
| 1065 | @vindex cvs-invert-ignore-marks | 1063 | @vindex cvs-invert-ignore-marks@r{ (variable)} |
| 1066 | 1064 | ||
| 1067 | @table @kbd | 1065 | @table @kbd |
| 1068 | @item = | 1066 | @item = |
| @@ -1073,23 +1071,22 @@ that they are based on. (@code{cvs-mode-diff}).@refill | |||
| 1073 | @item d b | 1071 | @item d b |
| 1074 | If CVS finds a conflict while merging two versions of a file (during a | 1072 | 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 | 1073 | @samp{cvs update}, @pxref{Updating the buffer}) it will save the |
| 1076 | original file in a file called @file{.#@var{FILE}.@var{VERSION}} where | 1074 | original file in a file called @file{.#@var{file}.@var{version}} where |
| 1077 | @var{FILE} is the name of the file, and @var{VERSION} is the revision | 1075 | @var{file} is the name of the file, and @var{version} is the revision |
| 1078 | number that your file was based on.@refill | 1076 | number that @var{file} was based on.@refill |
| 1079 | 1077 | ||
| 1080 | With the @kbd{b} command you can run a @samp{diff} on the files | 1078 | With the @kbd{d b} command you can run a @samp{diff} on the files |
| 1081 | @file{.#@var{FILE}.@var{VERSION}} and @file{@var{FILE}}.@refill | 1079 | @file{.#@var{file}.@var{version}} and @file{@var{file}}.@refill |
| 1082 | 1080 | ||
| 1083 | @item d h | 1081 | @item d h |
| 1084 | Display a @samp{cvs diff} between the selected files and the head | 1082 | Display a @samp{cvs diff} between the selected files and the head |
| 1085 | revision in the repository (the most recent version on the current | 1083 | revision in the repository (the most recent version on the current |
| 1086 | branch). (@code{cvs-mode-diff-head}).@refill | 1084 | branch) (@code{cvs-mode-diff-head}).@refill |
| 1087 | 1085 | ||
| 1088 | @item d v | 1086 | @item d v |
| 1089 | Display a @samp{cvs diff} between the selected files and the head | 1087 | Display a @samp{cvs diff} between the selected files and the head |
| 1090 | revision of the vendor branch in the repository. | 1088 | revision of the vendor branch in the repository. |
| 1091 | (@code{cvs-mode-diff-vendor}).@refill | 1089 | (@code{cvs-mode-diff-vendor}).@refill |
| 1092 | |||
| 1093 | @end table | 1090 | @end table |
| 1094 | 1091 | ||
| 1095 | By default, @samp{diff} commands ignore the marks. This can be changed | 1092 | By default, @samp{diff} commands ignore the marks. This can be changed |
| @@ -1100,37 +1097,38 @@ with @code{cvs-invert-ignore-marks}. | |||
| 1100 | @cindex Ediff | 1097 | @cindex Ediff |
| 1101 | @cindex Invoking ediff | 1098 | @cindex Invoking ediff |
| 1102 | @cindex Viewing differences | 1099 | @cindex Viewing differences |
| 1103 | @cindex Conflicts, resolving | 1100 | @cindex Conflicts, how to resolve them |
| 1104 | @cindex Resolving conflicts | 1101 | @cindex Resolving conflicts |
| 1105 | @kindex e - invoke @samp{ediff} | 1102 | @kindex e@r{--invoke @samp{ediff}} |
| 1106 | @findex cvs-mode-idiff | 1103 | @findex cvs-mode-idiff |
| 1107 | @findex cvs-mode-imerge | 1104 | @findex cvs-mode-imerge |
| 1108 | 1105 | ||
| 1109 | @table @kbd | 1106 | @table @kbd |
| 1107 | @vindex cvs-idiff-imerge-handlers@r{ (variable)} | ||
| 1110 | @item d e | 1108 | @item d e |
| 1111 | This command uses ediff (or emerge depending on | 1109 | This uses @code{ediff} (or @code{emerge}, depending on |
| 1112 | @samp{cvs-idiff-imerge-handlers}) to allow you to view diffs. | 1110 | @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 | 1111 | 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 | 1112 | which the diff should be made, else the default will be to use the BASE |
| 1115 | revision. | 1113 | revision. |
| 1116 | 1114 | ||
| 1115 | @cindex Merging with @code{ediff} and @code{emerge} | ||
| 1117 | @item d E | 1116 | @item d E |
| 1118 | This command use ediff (or emerge, see above) to allow you to do an | 1117 | This command use @code{ediff} (or @code{emerge}, see above) to allow you |
| 1119 | interactive 3-way merge. | 1118 | to do an interactive 3-way merge. |
| 1120 | 1119 | ||
| 1121 | @strong{Note:} When the file status is @samp{Conflict}, | 1120 | @strong{Note:} When the file status is @samp{Conflict}, |
| 1122 | CVS has already performed a merge. The resulting file is not used in | 1121 | CVS has already performed a merge. The resulting file is not used in |
| 1123 | any way if you use this command. If you use the @kbd{q} command inside | 1122 | any way if you use this command. If you use the @kbd{q} command inside |
| 1124 | @samp{ediff} (to successfully terminate a merge) the file that CVS | 1123 | @samp{ediff} (to successfully terminate a merge) the file that CVS |
| 1125 | created will be overwritten.@refill | 1124 | created will be overwritten.@refill |
| 1126 | |||
| 1127 | @end table | 1125 | @end table |
| 1128 | 1126 | ||
| 1129 | @node Updating files, Tagging files, Invoking Ediff, Commands | 1127 | @node Updating files, Tagging files, Invoking Ediff, Commands |
| 1130 | @section Updating files | 1128 | @section Updating files |
| 1131 | @findex cvs-mode-update | 1129 | @findex cvs-mode-update |
| 1132 | @cindex Updating files | 1130 | @cindex Updating files |
| 1133 | @kindex O - update files | 1131 | @kindex O@r{--update files} |
| 1134 | 1132 | ||
| 1135 | @table @kbd | 1133 | @table @kbd |
| 1136 | @item O | 1134 | @item O |
| @@ -1145,24 +1143,23 @@ Update all selected files with status @samp{Need-update} by running | |||
| 1145 | @findex cvs-mode-untag | 1143 | @findex cvs-mode-untag |
| 1146 | @findex cvs-rtag | 1144 | @findex cvs-rtag |
| 1147 | @cindex Tagging files | 1145 | @cindex Tagging files |
| 1148 | @kindex M-t - repository tag files | 1146 | @kindex M-t@r{--repository tag files} |
| 1149 | @kindex t - tag files | 1147 | @kindex t@r{--tag files} |
| 1150 | @vindex cvs-invert-ignore-marks | 1148 | @vindex cvs-invert-ignore-marks@r{ (variable)} |
| 1151 | @vindex cvs-force-dir-tag | 1149 | @vindex cvs-force-dir-tag@r{ (variable)} |
| 1152 | 1150 | ||
| 1153 | @table @kbd | 1151 | @table @kbd |
| 1154 | @item t | 1152 | @item t |
| 1155 | Tag all selected files by running @samp{cvs tag} on | 1153 | Tag all selected files by running @samp{cvs tag} on |
| 1156 | them. (@code{cvs-mode-tag}). It's usually preferable to tag directories | 1154 | them (@code{cvs-mode-tag}). It's usually preferable to tag a directory |
| 1157 | at a time. Rather than selecting all files (which too often doesn't | 1155 | 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 | 1156 | 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 | 1157 | 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}. | 1158 | the cursor on the directory you want to tag and hit @kbd{t}. |
| 1161 | |||
| 1162 | @end table | 1159 | @end table |
| 1163 | 1160 | ||
| 1164 | By default, @samp{tag} commands ignore the marks. This can be changed | 1161 | By default, @samp{tag} commands ignore the marks. This can be changed |
| 1165 | with @code{cvs-invert-ignore-marks}. Also by default @samp{tag} can | 1162 | with @code{cvs-invert-ignore-marks}. Also, by default @samp{tag} can |
| 1166 | only be applied to directories, see @code{cvs-force-dir-tag} if you want | 1163 | only be applied to directories, see @code{cvs-force-dir-tag} if you want |
| 1167 | to change this behavior. | 1164 | to change this behavior. |
| 1168 | 1165 | ||
| @@ -1175,38 +1172,37 @@ to change this behavior. | |||
| 1175 | @findex cvs-mode-delete-lock | 1172 | @findex cvs-mode-delete-lock |
| 1176 | @cindex Getting rid of lock files | 1173 | @cindex Getting rid of lock files |
| 1177 | @cindex Lock files | 1174 | @cindex Lock files |
| 1178 | @kindex q - quit PCL-CVS | 1175 | @kindex q@r{--quit PCL-CVS} |
| 1179 | @findex cvs-mode-quit | 1176 | @findex cvs-mode-quit |
| 1180 | @cindex Quitting | 1177 | @cindex Quitting |
| 1181 | @kindex h - help | 1178 | @kindex h@r{--help} |
| 1182 | @kindex ? - help | 1179 | @kindex ?@r{--help} |
| 1183 | @findex cvs-help | 1180 | @findex cvs-help |
| 1184 | @cindex Help | 1181 | @cindex Help |
| 1185 | 1182 | ||
| 1186 | @table @kbd | 1183 | @table @kbd |
| 1187 | @item M-x cvs-mode-byte-compile-files | 1184 | @item M-x cvs-mode-byte-compile-files |
| 1188 | Byte compile all selected files that end in .el. | 1185 | Byte compile all selected files that end in @file{.el}. |
| 1189 | 1186 | ||
| 1190 | @item M-x cvs-mode-delete-lock | 1187 | @item M-x cvs-mode-delete-lock |
| 1191 | This command deletes the lock files that | 1188 | This command deletes the lock files that |
| 1192 | the *cvs* buffer informs you about. You should normally never have to | 1189 | the @samp{*cvs*} buffer informs you about. You should normally never have to |
| 1193 | use this command since CVS tries very carefully to always remove the | 1190 | use this command, since CVS tries very carefully to always remove the |
| 1194 | lock files itself. | 1191 | lock files itself. |
| 1195 | 1192 | ||
| 1196 | You can only use this command when a message in the *cvs* buffer tells | 1193 | You can only use this command when a message in the @samp{*cvs*} buffer tells |
| 1197 | you so. You should wait a while before using this command in case | 1194 | you so. You should wait a while before using this command in case |
| 1198 | someone else is running a cvs command. | 1195 | someone else is running a @code{cvs} command. |
| 1199 | 1196 | ||
| 1200 | Also note that this only works if the repository is local. | 1197 | Also note that this only works if the repository is local. |
| 1201 | 1198 | ||
| 1202 | @item ? | 1199 | @item ? |
| 1203 | @itemx h | 1200 | @itemx h |
| 1204 | Show a summary of common command key bindings in the echo | 1201 | Show a summary of common command key bindings in the echo |
| 1205 | area. (@code{cvs-help}). | 1202 | area (@code{cvs-help}). |
| 1206 | 1203 | ||
| 1207 | @item q | 1204 | @item q |
| 1208 | Quit PCL-CVS, killing the @samp{*cvs*} buffer. (@code{cvs-mode-quit}). | 1205 | Quit PCL-CVS, killing the @samp{*cvs*} buffer (@code{cvs-mode-quit}). |
| 1209 | |||
| 1210 | @end table | 1206 | @end table |
| 1211 | 1207 | ||
| 1212 | @node Log Edit Mode, Log View Mode, Commands, Top | 1208 | @node Log Edit Mode, Log View Mode, Commands, Top |
| @@ -1220,38 +1216,39 @@ Quit PCL-CVS, killing the @samp{*cvs*} buffer. (@code{cvs-mode-quit}). | |||
| 1220 | 1216 | ||
| 1221 | @node Customization, Bugs, CVS Status Mode, Top | 1217 | @node Customization, Bugs, CVS Status Mode, Top |
| 1222 | @chapter Customization | 1218 | @chapter Customization |
| 1223 | @vindex log-edit-changelog-full-paragraphs (variable) | 1219 | @vindex log-edit-changelog-full-paragraphs@r{ (variable)} |
| 1224 | @vindex cvs-auto-remove-handled (variable) | 1220 | @vindex cvs-auto-remove-handled@r{ (variable)} |
| 1225 | @vindex cvs-auto-remove-directories (variable) | 1221 | @vindex cvs-auto-remove-directories@r{ (variable)} |
| 1226 | @vindex cvs-update-prog-output-skip-regexp (variable) | 1222 | @vindex cvs-update-prog-output-skip-regexp@r{ (variable)} |
| 1227 | @vindex cvs-cvsroot (variable) | 1223 | @vindex cvs-cvsroot@r{ (variable)} |
| 1228 | @vindex cvs-auto-revert (variable) | 1224 | @vindex cvs-auto-revert@r{ (variable)} |
| 1229 | @vindex log-edit-require-final-newline (variable) | 1225 | @vindex log-edit-require-final-newline@r{ (variable)} |
| 1230 | @vindex cvs-sort-ignore-file (variable) | 1226 | @vindex cvs-sort-ignore-file@r{ (variable)} |
| 1231 | @cindex Customization | 1227 | @cindex Customization |
| 1232 | @cindex Variables, list of all | 1228 | @cindex Variables, list of all |
| 1233 | @cindex Erasing the input buffer | 1229 | @cindex Erasing input buffer |
| 1234 | @cindex Context diff, how to get | 1230 | @cindex Context diff, how to get |
| 1235 | @cindex Unidiff, how to get | 1231 | @cindex Unidiff, how to get |
| 1236 | @cindex Automatically remove handled files | 1232 | @cindex Automatically remove handled files |
| 1237 | @cindex -u option in modules file | 1233 | @cindex @samp{-u} option in modules file |
| 1238 | @cindex Modules file (-u option) | 1234 | @cindex Modules file (@samp{-u} option) |
| 1239 | @cindex Update program (-u option in modules file) | 1235 | @cindex Update program (@samp{-u} option in modules file) |
| 1240 | @cindex Reverting buffers after commit | 1236 | @cindex Reverting buffers after commit |
| 1241 | @cindex Require final newline | 1237 | @cindex Require final newline |
| 1242 | @cindex Automatically inserting newline | 1238 | @cindex Automatically inserting newline |
| 1243 | @cindex Commit message, inserting newline | 1239 | @cindex Commit message, inserting newline |
| 1244 | @cindex Sorting the .cvsignore file | 1240 | @cindex Sorting @file{.cvsignore} file |
| 1245 | @cindex .cvsignore file, sorting | 1241 | @cindex @file{.cvsignore} file, sorting |
| 1246 | @cindex Automatically sorting .cvsignore | 1242 | @cindex Automatically sorting @file{.cvsignore} |
| 1243 | @cindex @samp{CVSROOT}, overriding | ||
| 1247 | 1244 | ||
| 1248 | If you have an idea about any customization that would be handy but | 1245 | If you have an idea about any customization that would be handy but |
| 1249 | isn't present in this list, please tell me! | 1246 | isn't present in this list, please tell me! |
| 1250 | For info on how to reach me, see @xref{Bugs}.@refill | 1247 | For info on how to reach me, see @ref{Bugs}.@refill |
| 1251 | 1248 | ||
| 1252 | @table @samp | 1249 | @table @samp |
| 1253 | @item cvs-auto-remove-handled | 1250 | @item cvs-auto-remove-handled |
| 1254 | If this variable is set to any non-@code{nil} value | 1251 | If this variable is set to any non-@code{nil} value, |
| 1255 | @samp{cvs-mode-remove-handled} will be called every time you check in | 1252 | @samp{cvs-mode-remove-handled} will be called every time you check in |
| 1256 | files, after the check-in is ready. @xref{Removing handled | 1253 | files, after the check-in is ready. @xref{Removing handled |
| 1257 | entries}.@refill | 1254 | entries}.@refill |
| @@ -1268,56 +1265,59 @@ This variable defaults to @samp{t}. @xref{Committing changes}.@refill | |||
| 1268 | 1265 | ||
| 1269 | @item cvs-update-prog-output-skip-regexp | 1266 | @item cvs-update-prog-output-skip-regexp |
| 1270 | The @samp{-u} flag in the @file{modules} file can be used to run a command | 1267 | The @samp{-u} flag in the @file{modules} file can be used to run a command |
| 1271 | whenever a @samp{cvs update} is performed (see cvs(5)). This regexp | 1268 | whenever a @samp{cvs update} is performed (see @code{cvs(5)}). This regexp |
| 1272 | is used to search for the last line in that output. It is normally set | 1269 | is used to search for the last line in that output. It is normally set |
| 1273 | to @samp{"$"}. That setting is only correct if the command outputs | 1270 | to @samp{$}. That setting is only correct if the command outputs |
| 1274 | nothing. Note that PCL-CVS will get very confused if the command | 1271 | nothing. Note that PCL-CVS will get very confused if the command |
| 1275 | outputs @emph{anything} to @samp{stderr}. | 1272 | outputs @emph{anything} to @code{stderr}. |
| 1276 | 1273 | ||
| 1277 | @item cvs-cvsroot | 1274 | @item cvs-cvsroot |
| 1278 | This variable can be set to override @samp{CVSROOT}. It should be a | 1275 | This variable can be set to override @samp{CVSROOT}. It should be a |
| 1279 | string. If it is set then every time a cvs command is run it will be | 1276 | string. If it is set, then every time a @code{cvs} command is run, it |
| 1280 | called as @samp{cvs -d @var{cvs-cvsroot}@dots{}} This can be useful if | 1277 | will be called as @samp{cvs -d @var{cvs-cvsroot}@dots{}}. This can be |
| 1281 | your site has several repositories. | 1278 | useful if your site has several repositories. |
| 1282 | 1279 | ||
| 1283 | @item log-edit-require-final-newline | 1280 | @item log-edit-require-final-newline |
| 1284 | When you enter a log message in the @samp{*cvs-commit-message*} buffer | 1281 | @c wordy to avoid unhderfull hbox |
| 1285 | PCL-CVS will normally automatically insert a trailing newline, unless | 1282 | When you enter a log message by typing into the |
| 1286 | there already is one. This behavior can be controlled via | 1283 | @samp{*cvs-commit-message*} buffer, PCL-CVS normally automatically |
| 1287 | @samp{cvs-commit-buffer-require-final-newline}. If it is @samp{t} (the | 1284 | inserts a trailing newline, unless there already is one. This behavior |
| 1288 | default behavior), a newline will always be appended. If it is | 1285 | can be controlled via @samp{cvs-commit-buffer-require-final-newline}. |
| 1289 | @samp{nil}, newlines will never be appended. Any other value causes | 1286 | If it is @samp{t} (the default behavior), a newline will always be |
| 1290 | PCL-CVS to ask the user whenever there is no trailing newline in the | 1287 | appended. If it is @samp{nil}, newlines will never be appended. Any |
| 1291 | commit message buffer. | 1288 | other value causes PCL-CVS to ask the user whenever there is no trailing |
| 1292 | 1289 | newline in the commit message buffer. | |
| 1290 | |||
| 1291 | @findex cvs-mode-changelog-commit | ||
| 1293 | @item log-edit-changelog-full-paragraphs | 1292 | @item log-edit-changelog-full-paragraphs |
| 1294 | If this variable is non-@code{nil}, include full ChangeLog paragraphs in | 1293 | If this variable is non-@code{nil}, include full @file{ChangeLog} |
| 1295 | the CVS log created by @samp{cvs-mode-changelog-commit}. | 1294 | paragraphs in the CVS log created by @samp{cvs-mode-changelog-commit}. |
| 1296 | This may be set in the local variables section of a ChangeLog, to | 1295 | This may be set in the local variables section of a @file{ChangeLog} |
| 1297 | indicate the policy for that ChangeLog. | 1296 | file, to indicate the policy for that @file{ChangeLog}. |
| 1298 | 1297 | ||
| 1299 | A ChangeLog paragraph is a bunch of log text containing no blank lines; | 1298 | @cindex @file{ChangeLog} paragraphs |
| 1300 | a paragraph usually describes a set of changes with a single purpose, | 1299 | A @dfn{@file{ChangeLog} paragraph} is a bunch of log text containing no |
| 1301 | but perhaps spanning several functions in several files. Changes in | 1300 | blank lines; a paragraph usually describes a set of changes with a |
| 1302 | different paragraphs are unrelated. | 1301 | single purpose, but perhaps spanning several functions in several files. |
| 1302 | Changes in different paragraphs are unrelated. | ||
| 1303 | 1303 | ||
| 1304 | You could argue that the CVS log entry for a file should contain the | 1304 | You could argue that the CVS log entry for a file should contain the |
| 1305 | full ChangeLog paragraph mentioning the change to the file, even though | 1305 | full @file{ChangeLog} paragraph mentioning the change to the file, even though |
| 1306 | it may mention other files, because that gives you the full context you | 1306 | it may mention other files, because that gives you the full context you |
| 1307 | need to understand the change. This is the behavior you get when this | 1307 | need to understand the change. This is the behavior you get when this |
| 1308 | variable is set to t, the default. | 1308 | variable is set to @code{t}, the default. |
| 1309 | 1309 | ||
| 1310 | On the other hand, you could argue that the CVS log entry for a change | 1310 | On the other hand, you could argue that the CVS log entry for a change |
| 1311 | should contain only the text for the changes which occurred in that | 1311 | should contain only the text for the changes which occurred in that |
| 1312 | file, because the CVS log is per-file. This is the behavior you get | 1312 | file, because the CVS log is per-file. This is the behavior you get |
| 1313 | when this variable is set to nil. | 1313 | when this variable is set to @code{nil}. |
| 1314 | 1314 | ||
| 1315 | @findex cvs-mode-ignore@r{, and @file{.cvsignore} sorting} | ||
| 1315 | @item cvs-sort-ignore-file | 1316 | @item cvs-sort-ignore-file |
| 1316 | If this variable is set to any non-@samp{nil} value the | 1317 | If this variable is set to any non-@samp{nil} value, the |
| 1317 | @file{.cvsignore} will always be sorted whenever you use | 1318 | @file{.cvsignore} file will always be sorted whenever you use |
| 1318 | @samp{cvs-mode-ignore} to add a file to it. This option is on by | 1319 | @samp{cvs-mode-ignore} to add a file to it. This option is on by |
| 1319 | default. | 1320 | default. |
| 1320 | |||
| 1321 | @end table | 1321 | @end table |
| 1322 | 1322 | ||
| 1323 | 1323 | ||
| @@ -1334,32 +1334,29 @@ default. | |||
| 1334 | @vindex cvs-need-action-face (face) | 1334 | @vindex cvs-need-action-face (face) |
| 1335 | @vindex cvs-marked-face (face) | 1335 | @vindex cvs-marked-face (face) |
| 1336 | 1336 | ||
| 1337 | The Emacs lisp file @file{pcl-cvs-xemacs.el} included with PCL-CVS adds | 1337 | PCL-CVS adds a few extra features, including menus, mouse bindings, and |
| 1338 | a few extra features for XEmacs, including menus, mouse bindings, and | ||
| 1339 | fontification the the @samp{*cvs*} buffer. The faces defined for | 1338 | fontification the the @samp{*cvs*} buffer. The faces defined for |
| 1340 | fontification are listed below: | 1339 | fontification are listed below: |
| 1341 | 1340 | ||
| 1342 | @table @samp | 1341 | @table @samp |
| 1343 | |||
| 1344 | @item cvs-header-face | 1342 | @item cvs-header-face |
| 1345 | This face is used to highlight directory changes. | 1343 | used to highlight directory changes. |
| 1346 | 1344 | ||
| 1347 | @item cvs-filename-face | 1345 | @item cvs-filename-face |
| 1348 | This face is used to highlight file names. | 1346 | used to highlight file names. |
| 1349 | 1347 | ||
| 1350 | @item cvs-unknown-face | 1348 | @item cvs-unknown-face |
| 1351 | This face is used to highlight the status of files which are UNKNOWN. | 1349 | used to highlight the status of files which are @samp{Unknown}. |
| 1352 | 1350 | ||
| 1353 | @item cvs-handled-face | 1351 | @item cvs-handled-face |
| 1354 | This face is used to highlight the status of files which are handled and | 1352 | used to highlight the status of files which are handled and |
| 1355 | need no further action. | 1353 | need no further action. |
| 1356 | 1354 | ||
| 1357 | @item cvs-need-action-face | 1355 | @item cvs-need-action-face |
| 1358 | This face is used to highlight the status of files which still need action. | 1356 | used to highlight the status of files which still need action. |
| 1359 | 1357 | ||
| 1360 | @item cvs-marked-face | 1358 | @item cvs-marked-face |
| 1361 | This face is used to highlight the marked file indicator (@samp{*}). | 1359 | used to highlight the marked file indicator (@samp{*}). |
| 1362 | |||
| 1363 | @end table | 1360 | @end table |
| 1364 | 1361 | ||
| 1365 | 1362 | ||
| @@ -1375,17 +1372,17 @@ This face is used to highlight the marked file indicator (@samp{*}). | |||
| 1375 | @cindex Problems, list of common | 1372 | @cindex Problems, list of common |
| 1376 | 1373 | ||
| 1377 | If you find a bug or misfeature, don't hesitate to tell us! Send email | 1374 | If you find a bug or misfeature, don't hesitate to tell us! Send email |
| 1378 | to @samp{bugs-gnu-emacs@@gnu.org} which gatewayed to the newsgroup | 1375 | to @email{bug-gnu-emacs@@gnu.org} which is gatewayed to the newsgroup |
| 1379 | @samp{gnu.emacs.bugs}. Feature requests should also be sent there. We | 1376 | @samp{gnu.emacs.bugs}. Feature requests should also be sent there. We |
| 1380 | prefer discussing one thing at a time. If you find several unrelated | 1377 | prefer discussing one thing at a time. If you find several unrelated |
| 1381 | bugs, please report them separately. If you are running PCL-CVS under | 1378 | bugs, please report them separately. If you are running PCL-CVS under |
| 1382 | XEmacs, you should also send a copy of bug reports to | 1379 | XEmacs, you should also send a copy of bug reports to |
| 1383 | @samp{xemacs-beta@@xemacs.org}. | 1380 | @email{xemacs-beta@@xemacs.org}. |
| 1384 | 1381 | ||
| 1385 | If you have problems using PCL-CVS or other questions, | 1382 | If you have problems using PCL-CVS or other questions, send them to |
| 1386 | @samp{help-gnu-emacs@@gnu.org} also gatewayed to @samp{gnu.emacs.help} | 1383 | @email{help-gnu-emacs@@gnu.org}, which is gatewayed to the |
| 1387 | is a good place to get help as well as @samp{cvs-info@@gnu.org} | 1384 | @samp{gnu.emacs.help} newsgroup. This is a good place to get help, as |
| 1388 | yet again gatewayed to @samp{gnu.cvs.help}. | 1385 | is @email{cvs-info@@gnu.org}, gatewayed to @samp{gnu.cvs.help}. |
| 1389 | 1386 | ||
| 1390 | If you have ideas for improvements, or if you have written some | 1387 | If you have ideas for improvements, or if you have written some |
| 1391 | extensions to this package, we would like to hear from you. We hope that | 1388 | extensions to this package, we would like to hear from you. We hope that |
| @@ -1397,27 +1394,34 @@ Below is a partial list of currently known problems with PCL-CVS version | |||
| 1397 | @table @asis | 1394 | @table @asis |
| 1398 | @item Unexpected output from CVS | 1395 | @item Unexpected output from CVS |
| 1399 | Unexpected output from CVS may confuse PCL-CVS. It will create | 1396 | Unexpected output from CVS may confuse PCL-CVS. It will create |
| 1400 | warning messages in the *cvs* buffer alerting you to any parse errors. | 1397 | warning messages in the @samp{*cvs*} buffer alerting you to any parse errors. |
| 1401 | If you get these messages, please send a bug report to the email | 1398 | If you get these messages, please send a bug report to the email |
| 1402 | addresses listed above. Include the contents of the *cvs* buffer, the | 1399 | addresses listed above. Include the contents of the @samp{*cvs*} buffer, the |
| 1403 | output of the CVS process (which should be found in the *cvs-tmp* Emacs | 1400 | output of the CVS process (which should be found in the @samp{*cvs-tmp*} |
| 1404 | buffer), and the versions of Emacs, PCL-CVS and CVS you are using. | 1401 | buffer), and the versions of Emacs, PCL-CVS and CVS you are using. |
| 1405 | |||
| 1406 | @end table | 1402 | @end table |
| 1407 | 1403 | ||
| 1408 | @node Function and Variable Index, Concept Index, Bugs, Top | 1404 | @node Function and Variable Index, Concept Index, Bugs, Top |
| 1409 | @unnumbered Function and Variable Index | 1405 | @unnumbered Function and Variable Index |
| 1410 | 1406 | ||
| 1407 | This is an index of all the functions and variables documented in this | ||
| 1408 | manual. | ||
| 1409 | |||
| 1411 | @printindex fn | 1410 | @printindex fn |
| 1412 | 1411 | ||
| 1413 | @node Concept Index, Key Index, Function and Variable Index, Top | 1412 | @node Concept Index, Key Index, Function and Variable Index, Top |
| 1414 | @unnumbered Concept Index | 1413 | @unnumbered Concept Index |
| 1415 | 1414 | ||
| 1415 | This is an index of concepts discussed in this manual. | ||
| 1416 | |||
| 1416 | @printindex cp | 1417 | @printindex cp |
| 1417 | 1418 | ||
| 1418 | @node Key Index, , Concept Index, Top | 1419 | @node Key Index, , Concept Index, Top |
| 1419 | @unnumbered Key Index | 1420 | @unnumbered Key Index |
| 1420 | 1421 | ||
| 1422 | This index includes an entry for each PCL-CVS key sequence documented in | ||
| 1423 | this manual. | ||
| 1424 | |||
| 1421 | @printindex ky | 1425 | @printindex ky |
| 1422 | 1426 | ||
| 1423 | @setchapternewpage odd | 1427 | @setchapternewpage odd |