]> code.delx.au - gnu-emacs/blobdiff - doc/emacs/vc1-xtra.texi
Document the user-level features of the Xref package
[gnu-emacs] / doc / emacs / vc1-xtra.texi
index 4e701a580a858c2d6d588050b1f2234cb8b1cf83..9cbe4b544f70ee12fabbffa7c8f94f17de8f5a03 100644 (file)
@@ -1,5 +1,5 @@
 @c This is part of the Emacs manual.
-@c Copyright (C) 2004-2013 Free Software Foundation, Inc.
+@c Copyright (C) 2004-2016 Free Software Foundation, Inc.
 @c See file emacs.texi for copying conditions.
 @c
 @c This file is included either in vc-xtra.texi (when producing the
@@ -59,7 +59,7 @@ As above, but only find entries for the current buffer's file.
   For example, suppose the first line of @file{ChangeLog} is dated
 1999-04-10, and that the only check-in since then was by Nathaniel
 Bowditch to @file{rcs2log} on 1999-05-22 with log entry @samp{Ignore
-log messages that start with `#'.}.  Then @kbd{C-x v a} inserts this
+log messages that start with '#'.}.  Then @kbd{C-x v a} inserts this
 @file{ChangeLog} entry:
 
 @iftex
@@ -69,7 +69,7 @@ log messages that start with `#'.}.  Then @kbd{C-x v a} inserts this
 @group
 1999-05-22  Nathaniel Bowditch  <nat@@apn.org>
 
-        * rcs2log: Ignore log messages that start with `#'.
+        * rcs2log: Ignore log messages that start with '#'.
 @end group
 @end smallexample
 @iftex
@@ -113,7 +113,7 @@ Prompt for a file name, delete the file from the working tree, and
 schedule the deletion for committing.
 
 @item M-x vc-rename-file
-Prompt for two file names, @var{VAR} and @var{OLD}, rename them in the
+Prompt for two file names, @var{var} and @var{old}, rename them in the
 working tree, and schedule the renaming for committing.
 @end table
 
@@ -199,21 +199,28 @@ through VC@.  Most later systems (including CVS, Subversion, bzr, git,
 and hg) have a native tag facility, and VC uses it where available;
 those tags will be visible even when you bypass VC.
 
-  In a file-oriented VCS, when you rename a registered file you need
-to rename its master along with it; the command @code{vc-rename-file}
-will do this automatically.  If you are using SCCS, you must also
-update the records of the tag, to mention the file by its new name
-(@code{vc-rename-file} does this, too).  An old tag that refers to a
-master file that no longer exists under the recorded name is invalid;
-VC can no longer retrieve it.  It would be beyond the scope of this
-manual to explain enough about RCS and SCCS to explain how to update
-the tags by hand.  Using @code{vc-rename-file} makes the tag remain
-valid for retrieval, but it does not solve all problems.  For example,
-some of the files in your program probably refer to others by name.
-At the very least, the makefile probably mentions the file that you
-renamed.  If you retrieve an old tag, the renamed file is retrieved
-under its new name, which is not the name that the makefile expects.
-So the program won't really work as retrieved.
+  In file-based version control systems, when you rename a registered
+file you need to rename its master along with it; the command
+@code{vc-rename-file} will do this automatically
+@iftex
+(@pxref{VC Delete/Rename,,,emacs, the Emacs Manual}).
+@end iftex
+@ifnottex
+(@pxref{VC Delete/Rename}).
+@end ifnottex
+If you are using SCCS, you must also update the records of the tag, to
+mention the file by its new name (@code{vc-rename-file} does this,
+too).  An old tag that refers to a master file that no longer exists
+under the recorded name is invalid; VC can no longer retrieve it.  It
+would be beyond the scope of this manual to explain enough about RCS
+and SCCS to explain how to update the tags by hand.  Using
+@code{vc-rename-file} makes the tag remain valid for retrieval, but it
+does not solve all problems.  For example, some of the files in your
+program probably refer to others by name.  At the very least, the
+makefile probably mentions the file that you renamed.  If you retrieve
+an old tag, the renamed file is retrieved under its new name, which is
+not the name that the makefile expects.  So the program won't really
+work as retrieved.
 
 @node Version Headers
 @subsubsection Inserting Version Control Headers
@@ -377,12 +384,12 @@ ends that support it, including CVS@.  In the following, we will talk
 only about @code{vc-cvs-stay-local}, but everything applies to
 @code{vc-stay-local} as well.
 
-  If @code{vc-cvs-stay-local} is @code{t} (the default), VC determines
-the version control status of each file using only the entry in the
-local CVS subdirectory and the information returned by previous CVS
-commands.  As a consequence, if you have modified a file and somebody
-else has checked in other changes, you will not be notified of the
-conflict until you try to commit.
+  If @code{vc-cvs-stay-local} is @code{only-file} (the default), VC
+determines the version control status of each file using only the
+entry in the local CVS subdirectory and the information returned by
+previous CVS commands.  As a consequence, if you have modified a file
+and somebody else has checked in other changes, you will not be
+notified of the conflict until you try to commit.
 
   If you change @code{vc-cvs-stay-local} to @code{nil}, VC queries the
 remote repository @emph{before} it decides what to do in
@@ -423,7 +430,7 @@ that @kbd{C-x v ~} saves old versions to
 @end ifnottex
 except for the additional dot (@samp{.}) after the version.  The
 relevant VC commands can use both kinds of version backups.  The main
-difference is that the ``manual'' version backups made by @kbd{C-x v
+difference is that the manual version backups made by @kbd{C-x v
 ~} are not deleted automatically when you commit.
 
 @cindex locking (CVS)