Skip to content

Commit

Permalink
Add explanation of using ssh to clone submodules.
Browse files Browse the repository at this point in the history
As another workaround for connection problems.
  • Loading branch information
oddhack committed Nov 4, 2024
1 parent bc61227 commit 9a16e19
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 4 deletions.
27 changes: 24 additions & 3 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -98,11 +98,32 @@ the tens of kB/s, or fatal timeout errors occurring, these may be due to
network routing issues to github within your ISP's internal network, rather
than anything wrong in your own networking setup.
It can be very difficult to get ISPs to acknowledge such problems exist much
less to fix them. In this case, consider trying the clone while running a
VPN service.
It can be very difficult to get ISPs to acknowledge such problems exist, much
less to fix them.
One workaround is to switch the repository to use ssh protocol prior to the
submodule download, which can be done via e.g.
[source,sh]
----
git clone [email protected]:KhronosGroup/Vulkan-Samples.git
cd Vulkan-Samples
perl -i -p -e 's|https://(.*?)/|git@\1:|g' .gitmodules
git submodule sync
git submodule update
----
While this can be a good alternative if you are running into this connection
issue, you must have GitHub ssh key authentication setup to use ssh
protocol - see
link:https://docs.github.com/en/authentication/connecting-to-github-with-ssh[Connecting
to GitHub with SSH] for details.
So it is a not a solution we can implement as the repository default.
Another option which may help is to run github through a VPN service.
====


== Build

=== Supported Platforms
Expand Down

0 comments on commit 9a16e19

Please sign in to comment.