Skip to content

Minor doc improvements#5320

Merged
pks-t merged 2 commits intolibgit2:masterfrom
josharian:minor-docs
Dec 13, 2019
Merged

Minor doc improvements#5320
pks-t merged 2 commits intolibgit2:masterfrom
josharian:minor-docs

Conversation

@josharian
Copy link
Contributor

No description provided.

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.
Copy link
Member

@pks-t pks-t left a 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).
Copy link
Member

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.

Copy link
Contributor Author

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.

Copy link
Member

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.

unsigned int version;

/** See `git_stash_apply_flags_t`, above. */
/** See `git_stash_apply_flags`, above. */
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Indeed 👍

Copy link
Member

@pks-t pks-t left a 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).
Copy link
Member

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants