New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Sparse Checkout #6394

Open

YuKitsune wants to merge 56 commits into libgit2:main from YuKitsune:features/sparse-checkout

+3,299 −177

YuKitsune commented Aug 30, 2022

This PR aims to implement basic sparse checkout functionality into LibGit2 building on @jochenhz's original PR.

What does it do?

Status / Diff takes GIT_INDEX_ENTRY_SKIP_WORKTREE into account
sparse-checkout file is treated as an attr_file, hence following gitignore rules
Skips sparse files on checkout
Sparse checkout can be enabled with core.sparseCheckout
support init, set, add, reapply and disable commands all supported
Expose an interface function git_sparse_check_path to query whether or not a file is excluded from checkout
Set GIT_INDEX_ENTRY_SKIP_WORKTREE flag on git_index_read_tree based on the sparse checkout ruleset.

What does it not do?

Smart trickery to determine whether or not a full tree is sparse (would be a very welcome optimization)
Support core.sparseCheckoutCone
No sparse checkout option on clone (but this can be achieved with GIT_CHECKOUT_NONE and git_index_read_tree)

Note

I've got some tests around worktrees, they seem to work
Given how complex sparse checkout can be, I'm almost certain I haven't gotten this implementation 100% correct, though feel free to prove me wrong 👍

YuKitsune mentioned this pull request

Sparse Checkout #6169

Closed

YuKitsune marked this pull request as ready for review

August 30, 2022 23:09

mathomp4 mentioned this pull request

Sparse checkout support #2263

Open

jochenhz and others added 27 commits

January 25, 2023 14:22


          take skip worktree flag into account when handling unmatched items wh…

c3edf79

…ile diffing

Signed-off-by: Jochen Hunz <j.hunz@anchorpoint.app>


          move does_negate_rule from ignore.c to attr_file.h so that it can be …

…used by sparse checkout code as well

Signed-off-by: Jochen Hunz <j.hunz@anchorpoint.app>


          add core.sparseCheckout to configmap cache

1cea229

Signed-off-by: Jochen Hunz <j.hunz@anchorpoint.app>


          implement very basic handling of .git/info/spare-checkout file.

9b4aa91

The sparse-checkout file is treated as a git_attr_file. A public API git_sparse_check_path reads the sparse-checkout file from the attribute file cache and checks the path against this attribute file using the gitignore ruleset

Signed-off-by: Jochen Hunz <j.hunz@anchorpoint.app>


          implement git_sparse__lookup function that can be called on initialis…

c9ed3f7

…ed git_sparse object

Signed-off-by: Jochen Hunz <j.hunz@anchorpoint.app>


          when doing git_index_read_tree set skip-worktree flag for index entri…

…es that are excluded by the sparse checkout ruleset - if sparse checkout is enabled

Signed-off-by: Jochen Hunz <j.hunz@anchorpoint.app>


          fix cleanup of git_sparse structure when core.sparseCheckout is disabled

7aa7710

Signed-off-by: Jochen Hunz <j.hunz@anchorpoint.app>


          set skip-worktree flag when index entry is initialized and path is sp…

8b5b0de

…arse

Signed-off-by: Jochen Hunz <j.hunz@anchorpoint.app>


          cache sparse-checkout values when iterating a tree so that it can be …

73e22bb

…accessed by checkout and diff functionalities quickly.

Signed-off-by: Jochen Hunz <j.hunz@anchorpoint.app>


          skip sparse files for unmatched new and old items if requested

9c06643

Signed-off-by: Jochen Hunz <j.hunz@anchorpoint.app>


          skip sparse files on checkout, add option to remove sparse files on c…

5206f4a

…heckout

Signed-off-by: Jochen Hunz <j.hunz@anchorpoint.app>


          add test repository for sparse unit tests

176a732

Signed-off-by: Jochen Hunz <j.hunz@anchorpoint.app>


          add tests for git_sparse_check_path and git status on sparse reposito…

1eb6826

…ries

Signed-off-by: Jochen Hunz <j.hunz@anchorpoint.app>


          test that index operations set skip-worktree flag if needed

d99630e

Signed-off-by: Jochen Hunz <j.hunz@anchorpoint.app>


          implement git sparse checkout tests

059d260

Signed-off-by: Jochen Hunz <j.hunz@anchorpoint.app>


          fix: parsing sparse file does not require context for subdirs


          Fix build errors form rebase

73991ab


          Fix build errors form rebase

d32dea5


          Implement init and set

27563d1


          Fix git_sparse_checkout_set not enabling sparse checkout

1aa7434


          WIP: Implementing other sparse-checkout commands

bee148a

- Temporarily remove cone references, will need to revisit
- Updating references in tests


          fix sparse_checkout_list impl

a4b16c9


          update tests

47d86b7


          re-sync git_attr__does_negate_rule

3a5fe90


          update test coverage

3a386a4


          make git_sparse_checkout_init with default patterns

63b0921


          fix init overwriting sparse-checkout file

f9dd9d6

YuKitsune added 24 commits

January 25, 2023 14:22


          hack: restore working directory on disable

284a62a


          Updating tests

91e45f1


          Tidy up

15d2855


          Fix missing methods from rebase

6f9b342


          move sparse diff flag to separate field

3a5a408

seems we've run out of space on that enum...


          add version to sparse checkout init opts


          fix more missing methods from rebase

25c2972


          Move diff ignore sparse flag

136d415


          fix sparse checkout file being written to the root

c0d60ac


          Fix up assertions

477147a


          add worktree tests

e7cb246


          tidy up args and internals

6c0d403


          Further tidy up


          fix sparse-checkout file not writing to worktree gitdir

e934309


          remove todo

e5fc108


          add git sparse status typedef

3256b32


          remove git__strtok_

a74bf88


          tidy parse_sparse_file

998d6de


          consolidate ignore parsing

054c147


          add comment addressing skip_worktree and sparse checkout

cdd9224


          update gitignore

7f53fe2


          Fix build errors from rebase

9db5b51


          Move sparse tests

ef4cc44


          Address build error from rebase

YuKitsune force-pushed the features/sparse-checkout branch from 6958e3f to 4224906 Compare

January 25, 2023 04:23

VinnyOG pushed a commit to 8thwall/libgit2 that referenced this pull request


          patch in sprase-checkout from libgit2#6394

cf441ce

VinnyOG pushed a commit to 8thwall/libgit2 that referenced this pull request


          patch in sprase-checkout from libgit2#6394

855ed0c

melMass mentioned this pull request

gitui does not work inside a sparse checkout gitui-org/gitui#1226

Closed

MikeTheSnowman commented Sep 14, 2023 •

edited

Loading

This PR seems really promising with lots of people wanting sparse-checkout support. Not just directly from the libgit2 community (#2263), but also from all of the other projects that are built with libgit2. Are there any particular blockers for merging this? The last update seems to be from 8 months ago.

abadran commented Jul 23, 2024

@YuKitsune @jochenhz Can you comment on the status of the sparse-checkout branch? It seems like work was done on it 1 or 2 years ago and it's not been pulled back into the main libgit2 repo. I tried using it to read a sparse repo and it failed during reading the index. Is it known to work? Are there known issues/limitations?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet