Skip to content
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.

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

Add file/folder illustration of the repo format #71

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

mlell
Copy link
Contributor

@mlell mlell commented Dec 21, 2022

This is a minor change in the DESIGN document, but it would have helped me a lot to understand the functionality of bup.
From reading "git for computer scientists" alone, I did not realize that git trees and blobs are 1-to-1 mapped to directories and files on git checkout. I searched for ways in how git alone can merge several blobs to one file, which it cant. The reason is this sentence:

... so you can use git to manipulate the bup repository if you want, and you
probably won't break anything. It's also a comfort to know you can squeeze
data out using git, just in case bup fails you, and as a developer, git offers
some nice tools ...

where I interpreted "squeeze out" as a simple "git checkout", which is not true, as bup splits files. The added text makes this more concrete and prepares the reader for the parts about hashsplitting and fanout

Signed-off-by: Moritz Lell mlell08@gmail.com

DESIGN Outdated

Now, bup does use these tools a little bit differently than plain git. We
So, bup uses the git builing blocks a little bit different than plain git. We
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this introduces a typo and doesn't help global readability.

@mlell mlell force-pushed the mlell-design-repo-format branch 2 times, most recently from 9ecc7c4 to e76d38e Compare April 18, 2024 10:05
The DESIGN document did help me a lot to understand the functionality of bup quite a lot, however from reading "git for computer scientists" alone, I did not realize that git trees and blobs are 1-to-1 mapped to directories and files on `git checkout`. I searched for ways in how git alone can merge several blobs to one file, which it cant. The reason is this sentence:

> ... so you can use git to manipulate the bup repository if you want, and you
> probably won't break anything.  It's also a comfort to know you can squeeze
> data out using git, just in case bup fails you, and as a developer, git offers
> some nice tools ...

where I interpreted "squeeze out" as a simple "git checkout", which is not true, as bup
splits files. The added text makes this more concrete and prepares the reader for the
parts about hashsplitting and fanout

Signed-off-by: Moritz Lell <mlell08@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants