@matheusbsbs / matheus-bagliano / commits / 1f1f575ebe

git-read-tree.txt: correct sparse-checkout and skip-worktree description

The description of .git/info/sparse-checkout and skip-worktree is exactly the opposite of what is true, which is: If a file matches a pattern in sparse-checkout, then (it is to be checked out and therefore) skip-worktree is unset for that file; otherwise, it is set (so that it is not checked out). Currently, the opposite is documented, and (consistently) read-tree's behavior with respect to bit flips is descibed incorrectly. Fix it. In hindsight, it would have been much better to have a "sparse-ignore" or "sparse-skip" file so that an empty file would mean a full checkout, and the file logic would be analogous to that of .gitignore, excludes and skip-worktree. Signed-off-by: Michael J Gruber <git@drmicha.warpmail.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Michael J Gruber committed Sep 21, 2011 at 09:48 UTC 1f1f575ebe194d2711f70bf7fc4e1ad9ae136112
1 file changed +4 -4
Documentation/git-read-tree.txt
+4 -4
@@ -388,12 +388,12 @@ directory update. `$GIT_DIR/info/sparse-checkout` is used to
388 define the skip-worktree reference bitmap. When 'git read-tree' needs
389 to update the working directory, it resets the skip-worktree bit in the index
390 based on this file, which uses the same syntax as .gitignore files.
391 -If an entry matches a pattern in this file, skip-worktree will be
392 -set on that entry. Otherwise, skip-worktree will be unset.
391 +If an entry matches a pattern in this file, skip-worktree will not be
392 +set on that entry. Otherwise, skip-worktree will be set.
393
394 Then it compares the new skip-worktree value with the previous one. If
395 -skip-worktree turns from unset to set, it will add the corresponding
396 -file back. If it turns from set to unset, that file will be removed.
395 +skip-worktree turns from set to unset, it will add the corresponding
396 +file back. If it turns from unset to set, that file will be removed.
397
398 While `$GIT_DIR/info/sparse-checkout` is usually used to specify what
399 files are in, you can also specify what files are _not_ in, using