Hello!
This is my draft proposal to implement resumable bundle-uri clone.
I would love to hear your thoughts on this. Also, I think the timeline
section
could be improved amd I need your input on that.
thanks,
-- Khalid Masum
======================================================
GSoC23 Draft Proposal: Resumable cloning with git bundle
======================================================
Overview:
=========
Currently, git clones are not resumable. But there is a workaround using
git bundles, where the user can `wget -c` the bundle, then clone from it.
However this comes with drawbacks that `git clone` does not have. For
example, with git clone we can specify branch, or send authentication
credentials,
which we can not do with `wget` in a simple manner.
However with the new `bundle-uri` we should be able to add this feature.
As suggested by Derrick Stolee <derrickstolee@xxxxxxxxxx> here:
https://lore.kernel.org/git/7097d1d6-00a1-2a82-1923-610d41f4053f@xxxxxxxxxx/
Where it is suggested that, the randomized temporary download files
could be
renamed with hashed url, enabling the ability to have resumable clone.
Deliverables:
=============
- Ability to resume a cloning process with bundle-uri.
- Testcases for the newly added feature.
- Update on documentation for the newer changes.
Timeline:
=========
Before April 25:
- Familiarize myself with git's codebase and architecture.
- Making small contributions to git.
Before May 25:
- Research and familiarize with git bundle and git object download
process.
- Understanding the core implementation of git bundle.
- Communicate with mentors for further understanding and finding
ways of
implementation.
May 26 - June 20:
- Starting to implement the git bundle-uri resumable feature.
- Refactor the codebase for necessary integration.
- Write some of the test-cases for the created modules.
June 21- July 20:
- Finish implementing the feature.
- Necessary test cases are implemented and reviewed.
- Document the changes.
July 21 - Aug 10:
- Finishing touches, making sure everything is stable.
Aug 11- 27:
- Buffer period for any unexpected events.
- Final report writing.
- Project submission
Contributions
==============
Microproject:
-------------
Modernized test script: t3501
Link:
https://lore.kernel.org/git/20220405150657.19801-1-khalid.masum.92@xxxxxxxxx/
Status: Accepted
Other contributions:
--------------------
Patch review:
https://lore.kernel.org/git/pull.1474.git.git.1679233875803.gitgitgadget@xxxxxxxxx/
Motivation:
===========
I am captivated by the engineering behind Git and aspire to contribute
regularly to the project, impacting its features. I view GSoC as an
excellent opportunity to jumpstart my contributions and deepen my
understanding of software engineering.
Conclusion:
===========
Implementation of resumable clone is a long wanted feature in git
since 2011. With this contribution I believe we will be able to be
closer to this goal, or at least get a very good workaround on this
feature.
