-
Notifications
You must be signed in to change notification settings - Fork 2.5k
Minor doc improvements #5320
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
Minor doc improvements #5320
Conversation
I encountered some problematic URLs, and was delighted to see that they were already fixed. I figured I may as well add them to the changelog. For the record, URLs with no path used to be rejected. That is arguably correct, but command line git accepts them. URLs with a path of / and a non-standard port used to have their port completely ignored!
There is no git_stash_apply_flags_t above.
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.
Thanks for your changes! The flags change is definitely good, but I'm not too sure about the other change. Didn't we handle the URLs you have provided as examples before already?
* libgit2 now correctly handles more URLs, such as | ||
`http://example.com:/repo.git` (colon but no port), | ||
`http://example.com` (no path), | ||
and `http://example.com:8080/` (path is /, nonstandard port). |
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.
Didn't we handle both URLs with no path and / path with nonstandard port just fine before? I'm not too sure about this, but I thought the only change we introduced was that we are now able to parse empty ports with that release.
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.
Parsing empty ports may have been the motivating case, but neither of those other cases worked for me. Please see the commit message, where I documented what the previous behavior was. Should I provide reproduction instructions as well?
For the record, I bisected the change in behavior to c6ab183. It turns out they still aren't actually fully working yet: #5321. But I hope that that will get fixed before the next release.
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.
Ah, perfect! I didn't expect nice commit messages, but here they are. So no, this is perfectly fine in that case and makes sense to me.
@@ -126,7 +126,7 @@ typedef int GIT_CALLBACK(git_stash_apply_progress_cb)( | |||
typedef struct git_stash_apply_options { | |||
unsigned int version; | |||
|
|||
/** See `git_stash_apply_flags_t`, above. */ | |||
/** See `git_stash_apply_flags`, above. */ |
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.
Indeed 👍
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.
Thanks a lot for this!
* libgit2 now correctly handles more URLs, such as | ||
`http://example.com:/repo.git` (colon but no port), | ||
`http://example.com` (no path), | ||
and `http://example.com:8080/` (path is /, nonstandard port). |
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.
Ah, perfect! I didn't expect nice commit messages, but here they are. So no, this is perfectly fine in that case and makes sense to me.
No description provided.