undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

git-update-index.txt: reword possibly confusing example

Browse Source 
The following phrase could be interpreted multiple ways:
  "To pretend you have a file with mode and sha1 at path"

In particular, I can think of two:
  1. Pretend we have some new file, which happens to have a given mode
     and sha1
  2. Pretend one of the files we are already tracking has a different
     mode and sha1 than what it really does

I think people could easily assume either case while reading, but the
example command provided doesn't actually handle the first case, which
caused some minor frustration to at least one user.  Modify the example
command so that it correctly handles both cases, and re-order the
wording in a way that makes it more likely folks will assume the first
interpretation.  I believe the new example shouldn't pose any obstacles
to those wanting the second interpretation (at worst, they pass an
unnecessary extra flag).

Signed-off-by: Elijah Newren <newren@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Elijah Newren 2018-08-08 13:28:07 -07:00 committed by Junio C Hamano
parent 53f9a3e157
commit 388d0ff6e5
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Documentation/git-update-index.txt
View File

@ -245,10 +245,10 @@ USING --CACHEINFO OR --INFO-ONLY
current working directory. This is useful for minimum-checkout
merging.
To pretend you have a file with mode and sha1 at path, say:
To pretend you have a file at path with mode and sha1, say:
----------------
$ git update-index --cacheinfo <mode>,<sha1>,<path>
$ git update-index --add --cacheinfo <mode>,<sha1>,<path>
----------------
`--info-only` is used to register files without placing them in the object