Comments (2)
Additional suggestion for documentation:
When a git repo. is created via 'git clone --depth=1 ...' the '--depth=1' creates a shallow clone.
git-sizer seems report: 'full clone required' on such a repo.
from git-sizer.
@mrT55: thanks for your feedback.
Now considering that git is often used both locally and remotely I think some users would find it helpful if some brief mention that git-sizer is for collecting statistics about a local git repository only.
When a git repo. is created via 'git clone --depth=1 ...' the '--depth=1' creates a shallow clone.
git-sizer seems report: 'full clone required' on such a repo.
Step 3 of the "Getting started" instructions says
3. Change to the directory containing a full, non-shallow clone of the Git repository that you'd like to analyze.
which covers both of those points (though somewhat obliquely). So apparently we should make that information more prominent. If you have an idea for how to change the README file so that this information would be harder to overlook, feel free to submit a pull request.
A future enhancement suggestion may be to have git-sizer optionally interrogate a remote git
repository for the purpose of determining ahead of time if the user is about to clone
a very large repository.
That would be handy if there were an easy way to implement it. But I don't think that the Git protocol allows you to inquire about the size of a repository, short of actually cloning it. So I think that the only way to implement this feature would be to recognize which hosting site the repository is on (if it's even a known one) and use site-specific APIs or other tricks to inquire about the size. This would be tricky to implement and would only cover the sites that we teach git-sizer
to recognize and that have the required API. And even then, we could only tell the user how big the repo is; they'd still have to clone the repo if they want to actually run git-sizer
against it. So I don't think that this feature would be worth the implementation and maintenance effort.
from git-sizer.
Related Issues (20)
- Question: How is logical file size calculated (Total size of files) HOT 1
- Obtain a list of biggest files in the repository. HOT 1
- Question: is there anyway I can get the count of files in particular language for example cuda statistics HOT 1
- Can it work on a bare repo? HOT 1
- MASTER Test HOT 1
- Get a top 10 of biggest checkouts in repository
- Approximating size shown at https://github.com/settings/repositories HOT 4
- Please update to Go 1.16 and also release for macOS ARM64 HOT 4
- Add suggestion on how to resolve spotted issues HOT 1
- "git-sizer --version" should show a version number. HOT 5
- `git-sizer --help` should exit with 0 HOT 1
- Add new convenience options like `--no-branches`, `--stash`, etc.
- Release 1.4.0 Windows builds flagged as malicious by multiple vendors HOT 3
- error: couldn't open Git repository: git rev-parse failed: Unknown option: -C HOT 4
- Detect & report tmp_pack files HOT 1
- Idea: have `git-sizer` read some defaults from the gitconfig
- Impove NewObjectIter method HOT 2
- [Doc] Record Golang dependency in readme.
- git-sizer error: "running 'git config': exit status 129" HOT 7
- go get: installing executables with 'go get' in module mode is deprecated HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from git-sizer.