From e93c9a6d97c962133f1efe170cbb22a1d327b976 Mon Sep 17 00:00:00 2001 From: Jon Leech Date: Mon, 11 Nov 2024 21:37:08 -0800 Subject: [PATCH] Reinitialize vulkan submodule --- README.adoc | 27 ++++++++++++++++++++++++--- 1 file changed, 24 insertions(+), 3 deletions(-) diff --git a/README.adoc b/README.adoc index 3973bd53..9b40c344 100644 --- a/README.adoc +++ b/README.adoc @@ -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 git@github.com: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