[PATCH 09/10] git-checkout.txt: mention of sparse checkout
- From
Nguyễn Thái Ngọc Duy <pclouds@gmail.com>
- Date
- Nov 15, 2010, 10:36 UTC
- Message-ID
- <1289817410-32470-10-git-send-email-pclouds@gmail.com>
- In-Reply-To
- <1289817410-32470-1-git-send-email-pclouds@gmail.com>
All the boring technical stuff still resides in git-read-tree.txt. The introduction here targets end users.
Signed-off-by: Nguyễn Thái Ngọc Duy <pclouds@gmail.com> --- Documentation/git-checkout.txt | 29 +++++++++++++++++++++++++++++ Documentation/git-read-tree.txt | 11 +---------- 2 files changed, 30 insertions(+), 10 deletions(-)
diff --git a/Documentation/git-checkout.txt b/Documentation/git-checkout.txt index 1d82063..b9a97c9 100644 --- a/Documentation/git-checkout.txt +++ b/Documentation/git-checkout.txt @@ -253,6 +253,35 @@ $ git log -g -2 HEAD ------------ +Sparse checkout +--------------- + +"Sparse checkout" allows to sparsely populate working directory +according to patterns defined in `$GIT_DIR/info/sparse-checkout`. The +syntax of this file is similar to linkgit:gitignore[5]. This feature +requires core.sparseCheckout to be turned on. `git checkout -S` should +be used when editing this file. It will update working directory +properly after editing. See linkgit:git-read-tree[1] for more +information. + +Normally sparse-checkout file contains only one rule, which indicates +that all files are checked out: + +---------------- +* +---------------- + +You can update the file to only contain files you want to be checked +out, or files _not_ to be checked out, using negate patterns. For +example, to remove file "unwanted": + +---------------- +* +!unwanted +---------------- + +To fully populate working directory again, use "git checkout --full". + EXAMPLES -------- diff --git a/Documentation/git-read-tree.txt b/Documentation/git-read-tree.txt index 634423a..4b72c96 100644 --- a/Documentation/git-read-tree.txt +++ b/Documentation/git-read-tree.txt @@ -390,16 +390,7 @@ Then it compares the new skip-worktree value with the previous one. If skip-worktree turns from unset to set, it will add the corresponding file back. If it turns from set to unset, that file will be removed. -While `$GIT_DIR/info/sparse-checkout` is usually used to specify what -files are in. You can also specify what files are _not_ in, using -negate patterns. For example, to remove file "unwanted": - ----------------- -* -!unwanted ----------------- - -Another tricky thing is fully repopulating working directory when you +A tricky thing is fully repopulating working directory when you no longer want sparse checkout. You cannot just disable "sparse checkout" because skip-worktree are still in the index and you working directory is still sparsely populated. You should re-populate working
-- 1.7.3.2.210.g045198