Update flash-sphinx-themes submodule to use https #12
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The use of git protocol in the flash-sphinx-themes submodule makes cloning this repo difficult for people behind strict corporate proxies that only permit outgoing traffic to ports 80 and 443. While these unlucky souls can work around this—as many currently do—by adding the following rewrite rule to their gitconfig:
git config --global url.https://github.com/.insteadOf git://github.com/
it's usually best to avoid prefixing submodule URLs with 'git://' unless there is absolutely no other choice, because doing so can cause cryptic errors—especially in the case of projects including *other* projects that transitively include this one as a submodule. As an example, a colleague recently typed the following command on a machine behind our employer's HTTP proxy:
git clone --recursive https://github.com/ycm-core/YouCompleteMe.git
and was greeted with the following error:
Cloning into '/home/evadeflow/projects/YouCompleteMe/third_party/ycmd/third_party/watchdog_deps/pathtools/docs/source/_themes'...
fatal: unable to look up github.com (port 9418) (Name or service not known)
fatal: clone of 'git://github.com/mitsuhiko/flask-sphinx-themes.git' into submodule path '/home/evadeflow/projects/YouCompleteMe/third_party/ycmd/
third_party/watchdog_deps/pathtools/docs/source/_themes' failed
Failed to clone 'docs/source/_themes'. Retry scheduled
Cloning into '/home/evadeflow/projects/YouCompleteMe/third_party/ycmd/third_party/watchdog_deps/pathtools/docs/source/_themes'...
fatal: unable to look up github.com (port 9418) (Name or service not known)
fatal: clone of 'git://github.com/mitsuhiko/flask-sphinx-themes.git' into submodule path '/home/evadeflow/projects/YouCompleteMe/third_party/ycmd/
third_party/watchdog_deps/pathtools/docs/source/_themes' failed
Failed to clone 'docs/source/_themes' a second time, aborting
While it only took me about 15 minutes to figure out and solve by adding a rewrite rule to my colleague's gitconfig, developer's less familiar with git might not fare so well, so... every time I see a project that includes a submodule via 'git://', I submit a pull request to the owner to make things a bit easier for them.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The use of git protocol in the flash-sphinx-themes submodule makes cloning this repo difficult for people behind strict corporate proxies that only permit outgoing traffic to ports 80 and 443. While these unlucky souls can work around this—as many currently do—by adding the following rewrite rule to their gitconfig:
it's usually best to avoid prefixing submodule URLs with 'git://' unless there is absolutely no other choice, because doing so can cause cryptic errors—especially in the case of projects including other projects that transitively include this one as a submodule. As an example, a colleague recently typed the following command on a machine behind our employer's HTTP proxy:
and was greeted with the following error:
While it only took me about 15 minutes to figure out and solve by adding a rewrite rule to my colleague's gitconfig, developer's less familiar with git might not fare so well, so... every time I see a project that includes a submodule via 'git://', I submit a pull request to the owner to make things a bit easier for them.