This is an archive of the discontinued LLVM Phabricator instance.

Added a faster method to clone llvm project [DOCS]
ClosedPublic

Authored by sushmaunnibhavi on Apr 28 2021, 2:25 AM.

Diff Detail

Event Timeline

sushmaunnibhavi requested review of this revision.Apr 28 2021, 2:25 AM
sushmaunnibhavi created this revision.
amccarth added inline comments.Apr 28 2021, 9:37 AM
clang/www/get_started.html
54

Can you explain what the trade-off is? If this is always faster and most of us only ever build the latest version (unless doing a bisect), why should anyone ever choose the slow way?

I don't know enough about git to know whether there are ramifications to truncating the history. If someone starts with --depth=1 and then later becomes a contributor, will having truncated history impact the code review and patch submission workflow?

+nit: no space before the :

clang/www/get_started.html
54

For normal users looking to just compile, this command works fine. But if someone later becomes a contributor, since they can't push code from a shallow clone, it needs to be converted into a full clone using

git fetch –unshallow
amccarth added inline comments.Apr 29 2021, 8:40 AM
clang/www/get_started.html
54

Sorry, the intent of my questions was to get the trade-off explained in the document itself.

sushmaunnibhavi marked an inline comment as not done.May 5 2021, 2:46 AM
sushmaunnibhavi added inline comments.
clang/www/get_started.html
54

To save storage and speed up the checkout time, we may want to do a shallow clone.

xgupta added a comment.May 5 2021, 3:24 AM

@sushmaunnibhavi Actually, what you wrote in the last two comments, you should write them in clang/www/get_started.html instead of comments. Please update the file.

Explained why doing a shallow clone is useful.

xgupta added a comment.May 5 2021, 4:09 AM

Nice suggestion, would you also write your second comment in the doc:

//For normal users looking to just compile, this command works fine. But if someone later becomes a contributor, since they can't push code from a shallow clone, it needs to be converted into a full clone using

git fetch –unshallow//

Because If someone doesn't know about --depth 1, may happen that also don't know about --unshallow. better we suggest here so they don't need to search around on internt.

xgupta added a comment.May 5 2021, 7:53 AM

This seems good to me, But please wait for @amccarth re-review.

xgupta accepted this revision.May 5 2021, 8:00 AM
This revision is now accepted and ready to land.May 5 2021, 8:00 AM
amccarth accepted this revision.May 5 2021, 8:01 AM

LGTM. Thanks!

xgupta added a comment.May 5 2021, 9:06 AM

Thanks @sushmaunnibhavi, I will commit it on your behalf.

This revision was automatically updated to reflect the committed changes.
Herald added a project: Restricted Project. · View Herald TranscriptMay 5 2021, 9:08 AM
Herald added a subscriber: cfe-commits. · View Herald Transcript