diff options
author | Junio C Hamano <gitster@pobox.com> | 2014-12-22 12:27:38 -0800 |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2014-12-22 12:27:38 -0800 |
commit | 14d4aab3bbd4cb25a4ccd16dc778c4c6c0a77c73 (patch) | |
tree | eb0ff38881be06b30425a9a8f490ede7bfd53e10 | |
parent | 15a171f6eb436f9a31986f78bbb115ed4540ad5b (diff) | |
parent | 936d2c9301e41a84a374b98f92777e00d321a2ea (diff) | |
download | git-14d4aab3bbd4cb25a4ccd16dc778c4c6c0a77c73.tar.gz |
Merge branch 'po/doc-assume-unchanged'
Fixes long-standing misunderstanding of what assume-unchanged is
about. Some text near what is removed by the bottom patch may also
have to be removed.
* po/doc-assume-unchanged:
gitignore.txt: do not suggest assume-unchanged
doc: make clear --assume-unchanged's user contract
-rw-r--r-- | Documentation/git-update-index.txt | 18 | ||||
-rw-r--r-- | Documentation/gitignore.txt | 4 |
2 files changed, 8 insertions, 14 deletions
diff --git a/Documentation/git-update-index.txt b/Documentation/git-update-index.txt index 929869b0a0..aff01798cd 100644 --- a/Documentation/git-update-index.txt +++ b/Documentation/git-update-index.txt @@ -82,20 +82,18 @@ OPTIONS Set the execute permissions on the updated files. --[no-]assume-unchanged:: - When these flags are specified, the object names recorded - for the paths are not updated. Instead, these options - set and unset the "assume unchanged" bit for the - paths. When the "assume unchanged" bit is on, Git stops - checking the working tree files for possible - modifications, so you need to manually unset the bit to - tell Git when you change the working tree file. This is + When this flag is specified, the object names recorded + for the paths are not updated. Instead, this option + sets/unsets the "assume unchanged" bit for the + paths. When the "assume unchanged" bit is on, the user + promises not to change the file and allows Git to assume + that the working tree file matches what is recorded in + the index. If you want to change the working tree file, + you need to unset the bit to tell Git. This is sometimes helpful when working with a big project on a filesystem that has very slow lstat(2) system call (e.g. cifs). + -This option can be also used as a coarse file-level mechanism -to ignore uncommitted changes in tracked files (akin to what -`.gitignore` does for untracked files). Git will fail (gracefully) in case it needs to modify this file in the index e.g. when merging in a commit; thus, in case the assumed-untracked file is changed upstream, diff --git a/Documentation/gitignore.txt b/Documentation/gitignore.txt index 09e82c31bd..4fd04423e9 100644 --- a/Documentation/gitignore.txt +++ b/Documentation/gitignore.txt @@ -138,9 +138,6 @@ NOTES The purpose of gitignore files is to ensure that certain files not tracked by Git remain untracked. -To ignore uncommitted changes in a file that is already tracked, -use 'git update-index {litdd}assume-unchanged'. - To stop tracking a file that is currently tracked, use 'git rm --cached'. @@ -203,7 +200,6 @@ everything within `foo/bar`): SEE ALSO -------- linkgit:git-rm[1], -linkgit:git-update-index[1], linkgit:gitrepository-layout[5], linkgit:git-check-ignore[1] |