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

What is with the lonely reference to "binary-blobs/" in the README.md file? #1

Closed
rpjday opened this issue Apr 25, 2019 · 5 comments
Closed
Labels
docs Documentation related issues

Comments

@rpjday
Copy link

rpjday commented Apr 25, 2019

Reading the README.md file, and partway down, there is:

"We also want to know how much smaller this extracted repo is without the binary-blobs/ directory in it."

Except there is no further reference to that binary-blobs directory. Is there supposed to be?

@newren
Copy link
Owner

newren commented Apr 26, 2019

I think I initially wrote up the example removing a single directory ('binary-blobs/') rather than retaining only a single directory ('src/') and missed updating one of the references. I've got a few other README changes waiting queued up for after I finish the python3 switchover. Thanks for taking a look and pointing this out, I'll fix it up soon-ish (by early May).

@rpjday
Copy link
Author

rpjday commented Apr 30, 2019

I'm more than happy to check over the end result after the Python 3 switch, as I want to add this utility to one of the Git classes I teach as a replacement for git-filter-branch.

@newren
Copy link
Owner

newren commented Apr 30, 2019

That'd be great. I'll give you a heads up, though it may end up getting delayed as I am a bit under the weather.

@newren
Copy link
Owner

newren commented May 16, 2019

Well, that took a lot longer than expected; sorry for the delay. I finally updated the README with background notes, lots of examples, and information on internals and limitations. I need to double check that the examples I put in the README actually work (I just wrote them off the top of my head and although I'm pretty sure they work I might have typos or syntax errors), but thought I'd give you a heads up. Also, this finally fixes this issue. :-)

Let me know if you have questions, if anything is unclear, if you have improvements suggestions, etc.

@newren newren closed this as completed May 16, 2019
@newren
Copy link
Owner

newren commented May 17, 2019

Oh, also the new documentation mentions two options I haven't quite implemented yet: --use-base-name and --paths-from-file. I'll implement them soon.

@newren newren added the docs Documentation related issues label Oct 21, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related issues
Projects
None yet
Development

No branches or pull requests

2 participants