-
Notifications
You must be signed in to change notification settings - Fork 281
Add options argument to GTRepository cloneFromURL #252
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
Conversation
// withCheckout - if NO, don't checkout the remote HEAD | ||
// options - A NSDictionary with NSString keys, used for specifying clone options. Possible keys are @"bare" and @"transportFlags" | ||
// error - A pointer to fill in case of trouble. | ||
// transferProgressBlock - This block is called with network transfer updates. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Doc update needed.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also, if you could document the magic options keys, that would be wonderful !
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@tiennou - could you please elaborate on what kind of doc update is needed?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My bad, since you mentioned moving one of the blocks in the options
dict, seeing it here made me think the doc wasn't updated. ATM it just misses a list of the options keys and what they do.
@jspahrsummers @tiennou - I think this PR is ready to merge now. I don't think we need to wait for #254 - we can open a new PR when #254 is ready or integrate the |
I'm fine with that, thanks for your work @isaac ;-). |
// options - A NSDictionary with NSString keys, used for specifying clone options. Possible keys are: | ||
// - @"bare" - BOOL value, if YES, create a bare clone, for example: [NSNumber numberWithBool:YES], defaults to NO | ||
// - @"checkout" - BOOL value, if NO, don't checkout the remote HEAD, for example: [NSNumber numberWithBool:NO], defaults to YES | ||
// - @"transportFlags" - int value, two possible values: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These keys should be file constants, and the documentation for them should appear on those constants.
🍫 |
⚡ |
👍 I'll let @tiennou handle the final review and merge. |
I'm honored ;-). Looks good to me, so I'll just merge. I'll add the Related: It seems libgit2 is adding init options to its clone method, but this can wait until someone has an use for it. |
Add options argument to GTRepository cloneFromURL
Add options argument to GTRepository cloneFromURL
No description provided.