X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=Documentation%2Fgit-update-index.txt;h=0a1953803e48947f6eeae385550ac2cd4e838411;hb=27c1dbea3e3a23b3c4b3707dfc9a71c3279ae279;hp=0e0a3af1beca8d39d8e963636d18482f39cab011;hpb=03f99c03f806ca13b5974450409426c04af220f2;p=git.git

diff --git a/Documentation/git-update-index.txt b/Documentation/git-update-index.txt
index 0e0a3af1b..0a1953803 100644
--- a/Documentation/git-update-index.txt
+++ b/Documentation/git-update-index.txt
@@ -3,7 +3,7 @@ git-update-index(1)
 
 NAME
 ----
-git-update-index - Modifies the index or directory cache
+git-update-index - Register file contents in the working tree to the index
 
 
 SYNOPSIS
@@ -27,6 +27,9 @@ Modifies the index or directory cache. Each file mentioned is updated
 into the index and any 'unmerged' or 'needs updating' state is
 cleared.
 
+See also gitlink:git-add[1] for a more user-friendly way to do some of
+the most common operations on the index.
+
 The way "git-update-index" handles files it is told about can be modified
 using the various options:
 
@@ -53,7 +56,7 @@ OPTIONS
 
 --unmerged::
         If --refresh finds unmerged changes in the index, the default
-        behavior is to error out.  This option makes git-update-index 
+        behavior is to error out.  This option makes git-update-index
         continue anyway.
 
 --ignore-missing::
@@ -61,12 +64,12 @@ OPTIONS
 
 --cacheinfo <mode> <object> <path>::
 	Directly insert the specified info into the index.
-	
+
 --index-info::
         Read index information from stdin.
 
 --chmod=(+|-)x::
-        Set the execute permissions on the updated files.        
+        Set the execute permissions on the updated files.
 
 --assume-unchanged, --no-assume-unchanged::
 	When these flags are specified, the object name recorded
@@ -123,7 +126,7 @@ OPTIONS
 <file>::
 	Files to act on.
 	Note that files beginning with '.' are discarded. This includes
-	`./file` and `dir/./file`. If you don't want this, then use	
+	`./file` and `dir/./file`. If you don't want this, then use
 	cleaner names.
 	The same applies to directories ending '/' and paths with '//'
 
@@ -289,19 +292,25 @@ Configuration
 
 The command honors `core.filemode` configuration variable.  If
 your repository is on an filesystem whose executable bits are
-unreliable, this should be set to 'false' (see gitlink:git-repo-config[1]).
+unreliable, this should be set to 'false' (see gitlink:git-config[1]).
 This causes the command to ignore differences in file modes recorded
 in the index and the file mode on the filesystem if they differ only on
 executable bit.   On such an unfortunate filesystem, you may
 need to use `git-update-index --chmod=`.
 
+Quite similarly, if `core.symlinks` configuration variable is set
+to 'false' (see gitlink:git-config[1]), symbolic links are checked out
+as plain files, and this command does not modify a recorded file mode
+from symbolic link to regular file.
+
 The command looks at `core.ignorestat` configuration variable.  See
 'Using "assume unchanged" bit' section above.
 
 
 See Also
 --------
-gitlink:git-repo-config[1]
+gitlink:git-config[1],
+gitlink:git-add[1]
 
 
 Author
@@ -315,4 +324,3 @@ Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel
 GIT
 ---
 Part of the gitlink:git[7] suite
-